datacatalog.oracle.com/v1beta1 &para;

AttributeCustomPropertyMember defines nested fields for Attribute.CustomPropertyMember.

Field	Description	Type	Required	Default	Enum
`displayName`	Name of the custom property	`string`	No	-	-
`key`	Unique Identifier of the attribute which is ID	`string`	No	-	-
`namespaceName`	Namespace name of the custom property	`string`	No	-	-
`value`	The custom property value	`string`	No	-	-

Status.objectRelationships[]¶

AttributeObjectRelationship defines nested fields for Attribute.ObjectRelationship.

Field	Description	Type	Required	Default	Enum
`key`	Unique id of the object.	`string`	No	-	-
`name`	Name of the object.	`string`	No	-	-
`parentKey`	Key of the parent object for the resource.	`string`	No	-	-
`parentPath`	Full path of the parent object.	`string`	No	-	-
`path`	Full path of the object.	`string`	No	-	-
`relationshipType`	Type of relationship with the referencing object.	`string`	No	-	-
`timeCreated`	The date and time the relationship was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: `2019-03-25T21:10:29.600Z`	`string`	No	-	-
`timeUpdated`	The last time a change was made to this reference. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.	`string`	No	-	-
`typeKey`	Type key of the object. Type keys can be found via the '/types' endpoint.	`string`	No	-	-
`typeName`	Type name of the object. Type names can be found via the '/types' endpoint.	`string`	No	-	-

Status.status¶

Field	Description	Type	Required	Default	Enum
`async`	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	`object`	No	-	-
`conditions`	-	`list[object]`	No	-	-
`createdAt`	-	`string (date-time)`	No	-	-
`deletedAt`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`ocid`	-	`string`	No	-	-
`opcRequestId`	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	`string`	No	-	-
`reason`	-	`string`	No	-	-
`requestedAt`	-	`string (date-time)`	No	-	-
`updatedAt`	-	`string (date-time)`	No	-	-

Status.status.async¶

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field	Description	Type	Required	Default	Enum
`current`	-	`object`	No	-	-

Status.status.async.current¶

Field	Description	Type	Required	Default	Enum
`message`	-	`string`	No	-	-
`normalizedClass`	-	`string`	Yes	-	`attention`, `canceled`, `failed`, `pending`, `succeeded`, `unknown`
`percentComplete`	-	`number`	No	-	-
`phase`	-	`string`	Yes	-	`create`, `delete`, `update`
`rawOperationType`	-	`string`	No	-	-
`rawStatus`	-	`string`	No	-	-
`source`	-	`string`	Yes	-	`lifecycle`, `none`, `workrequest`
`updatedAt`	-	`string (date-time)`	Yes	-	-
`workRequestId`	-	`string`	No	-	-

Status.status.conditions[]¶

Field	Description	Type	Required	Default	Enum
`lastTransitionTime`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`reason`	-	`string`	No	-	-
`status`	-	`string`	Yes	-	-
`type`	-	`string`	Yes	-	-

AttributeTag¶

AttributeTag is the Schema for the attributetags API.

Plural: attributetags
Scope: Namespaced
APIVersion: datacatalog.oracle.com/v1beta1
Sample: Sample (config/samples/datacatalog_v1beta1_attributetag.yaml)
Packages: Not currently exposed by a customer-visible package.

Spec¶

AttributeTagSpec defines the desired state of AttributeTag.

Field	Description	Type	Required	Default	Enum
`name`	The name of the tag in the case of a free form tag. When linking to a glossary term, this field is not specified.	`string`	No	-	-
`termKey`	Unique key of the related term or null in the case of a free form tag.	`string`	No	-	-

Status¶

AttributeTagStatus defines the observed state of AttributeTag.

Field	Description	Type	Required	Default	Enum
`attributeKey`	The unique key of the parent attribute.	`string`	No	-	-
`createdById`	OCID of the user who created the tag.	`string`	No	-	-
`glossaryKey`	Unique id of the parent glossary of the term.	`string`	No	-	-
`key`	Unique tag key that is immutable.	`string`	No	-	-
`lifecycleState`	The current state of the tag.	`string`	No	-	-
`name`	Name of the tag which matches the term name.	`string`	No	-	-
`status`	-	`object`	Yes	-	-
`termDescription`	Description of the related term.	`string`	No	-	-
`termKey`	Unique key of the related term.	`string`	No	-	-
`termPath`	Path of the related term.	`string`	No	-	-
`timeCreated`	The date and time the tag was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: `2019-03-25T21:10:29.600Z`	`string`	No	-	-
`uri`	URI to the tag instance in the API.	`string`	No	-	-

Status.status¶

Field	Description	Type	Required	Default	Enum
`async`	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	`object`	No	-	-
`conditions`	-	`list[object]`	No	-	-
`createdAt`	-	`string (date-time)`	No	-	-
`deletedAt`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`ocid`	-	`string`	No	-	-
`opcRequestId`	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	`string`	No	-	-
`reason`	-	`string`	No	-	-
`requestedAt`	-	`string (date-time)`	No	-	-
`updatedAt`	-	`string (date-time)`	No	-	-

Status.status.async¶

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field	Description	Type	Required	Default	Enum
`current`	-	`object`	No	-	-

Status.status.async.current¶

Field	Description	Type	Required	Default	Enum
`message`	-	`string`	No	-	-
`normalizedClass`	-	`string`	Yes	-	`attention`, `canceled`, `failed`, `pending`, `succeeded`, `unknown`
`percentComplete`	-	`number`	No	-	-
`phase`	-	`string`	Yes	-	`create`, `delete`, `update`
`rawOperationType`	-	`string`	No	-	-
`rawStatus`	-	`string`	No	-	-
`source`	-	`string`	Yes	-	`lifecycle`, `none`, `workrequest`
`updatedAt`	-	`string (date-time)`	Yes	-	-
`workRequestId`	-	`string`	No	-	-

Status.status.conditions[]¶

Field	Description	Type	Required	Default	Enum
`lastTransitionTime`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`reason`	-	`string`	No	-	-
`status`	-	`string`	Yes	-	-
`type`	-	`string`	Yes	-	-

Catalog¶

Catalog is the Schema for the catalogs API.

Plural: catalogs
Scope: Namespaced
APIVersion: datacatalog.oracle.com/v1beta1
Sample: Sample (config/samples/datacatalog_v1beta1_catalog.yaml)
Packages: Not currently exposed by a customer-visible package.

Spec¶

CatalogSpec defines the desired state of Catalog.

Field	Description	Type	Required	Default	Enum
`compartmentId`	Compartment identifier.	`string`	Yes	-	-
`definedTags`	Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}`	`map[string, map[string, string]]`	No	-	-
`displayName`	Data catalog identifier.	`string`	No	-	-
`freeformTags`	Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`	`map[string, string]`	No	-	-

Status¶

CatalogStatus defines the observed state of Catalog.

Field	Description	Type	Required	Default	Enum
`attachedCatalogPrivateEndpoints`	The list of private reverse connection endpoints attached to the catalog	`list[string]`	No	-	-
`compartmentId`	Compartment identifier.	`string`	No	-	-
`definedTags`	Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}`	`map[string, map[string, string]]`	No	-	-
`displayName`	Data catalog identifier, which can be renamed.	`string`	No	-	-
`freeformTags`	Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`	`map[string, string]`	No	-	-
`id`	OCID of the data catalog instance.	`string`	No	-	-
`lifecycleDetails`	An message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'Failed' state.	`string`	No	-	-
`lifecycleState`	The current state of the data catalog resource.	`string`	No	-	-
`locks`	Locks associated with this resource.	`list[object]`	No	-	-
`numberOfObjects`	The number of data objects added to the data catalog. Please see the data catalog documentation for further information on how this is calculated.	`integer`	No	-	-
`serviceApiUrl`	The REST front endpoint URL to the data catalog instance.	`string`	No	-	-
`serviceConsoleUrl`	The console front endpoint URL to the data catalog instance.	`string`	No	-	-
`status`	-	`object`	Yes	-	-
`systemTags`	System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`	`map[string, map[string, string]]`	No	-	-
`timeCreated`	The time the data catalog was created. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.	`string`	No	-	-
`timeUpdated`	The time the data catalog was updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.	`string`	No	-	-

Status.locks[]¶

CatalogLock defines nested fields for Catalog.Lock.

Field	Description	Type	Required	Default	Enum
`message`	A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.	`string`	No	-	-
`relatedResourceId`	The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.	`string`	No	-	-
`timeCreated`	When the lock was created.	`string`	No	-	-
`type`	Type of the lock.	`string`	No	-	-

Status.status¶

Field	Description	Type	Required	Default	Enum
`async`	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	`object`	No	-	-
`conditions`	-	`list[object]`	No	-	-
`createdAt`	-	`string (date-time)`	No	-	-
`deletedAt`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`ocid`	-	`string`	No	-	-
`opcRequestId`	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	`string`	No	-	-
`reason`	-	`string`	No	-	-
`requestedAt`	-	`string (date-time)`	No	-	-
`updatedAt`	-	`string (date-time)`	No	-	-

Status.status.async¶

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field	Description	Type	Required	Default	Enum
`current`	-	`object`	No	-	-

Status.status.async.current¶

Field	Description	Type	Required	Default	Enum
`message`	-	`string`	No	-	-
`normalizedClass`	-	`string`	Yes	-	`attention`, `canceled`, `failed`, `pending`, `succeeded`, `unknown`
`percentComplete`	-	`number`	No	-	-
`phase`	-	`string`	Yes	-	`create`, `delete`, `update`
`rawOperationType`	-	`string`	No	-	-
`rawStatus`	-	`string`	No	-	-
`source`	-	`string`	Yes	-	`lifecycle`, `none`, `workrequest`
`updatedAt`	-	`string (date-time)`	Yes	-	-
`workRequestId`	-	`string`	No	-	-

Status.status.conditions[]¶

Field	Description	Type	Required	Default	Enum
`lastTransitionTime`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`reason`	-	`string`	No	-	-
`status`	-	`string`	Yes	-	-
`type`	-	`string`	Yes	-	-

CatalogPrivateEndpoint¶

CatalogPrivateEndpoint is the Schema for the catalogprivateendpoints API.

Plural: catalogprivateendpoints
Scope: Namespaced
APIVersion: datacatalog.oracle.com/v1beta1
Sample: Sample (config/samples/datacatalog_v1beta1_catalogprivateendpoint.yaml)
Packages: Not currently exposed by a customer-visible package.

Spec¶

CatalogPrivateEndpointSpec defines the desired state of CatalogPrivateEndpoint.

Field	Description	Type	Required	Default	Enum
`compartmentId`	Compartment identifier.	`string`	Yes	-	-
`definedTags`	Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}`	`map[string, map[string, string]]`	No	-	-
`displayName`	Display name of the private endpoint resource being created.	`string`	No	-	-
`dnsZones`	List of DNS zones to be used by the data assets to be harvested. Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com	`list[string]`	Yes	-	-
`freeformTags`	Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`	`map[string, string]`	No	-	-
`securityAttributes`	Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`	`map[string, map[string, string]]`	No	-	-
`subnetId`	The OCID of subnet to which the reverse connection is to be created	`string`	Yes	-	-

Status¶

CatalogPrivateEndpointStatus defines the observed state of CatalogPrivateEndpoint.

Field	Description	Type	Required	Default	Enum
`attachedCatalogs`	The list of catalogs using the private reverse connection endpoint	`list[string]`	No	-	-
`compartmentId`	Compartment Identifier.	`string`	No	-	-
`definedTags`	Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}`	`map[string, map[string, string]]`	No	-	-
`displayName`	Private Reverse Connection Endpoint display name	`string`	No	-	-
`dnsZones`	List of DNS zones to be used by the data assets to be harvested. Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com	`list[string]`	No	-	-
`freeformTags`	Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`	`map[string, string]`	No	-	-
`id`	Unique identifier that is immutable	`string`	No	-	-
`lifecycleDetails`	A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state.	`string`	No	-	-
`lifecycleState`	The current state of the private endpoint resource.	`string`	No	-	-
`locks`	Locks associated with this resource.	`list[object]`	No	-	-
`securityAttributes`	Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`	`map[string, map[string, string]]`	No	-	-
`status`	-	`object`	Yes	-	-
`subnetId`	Subnet Identifier	`string`	No	-	-
`systemTags`	System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`	`map[string, map[string, string]]`	No	-	-
`timeCreated`	The time the private endpoint was created. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.	`string`	No	-	-
`timeUpdated`	The time the private endpoint was updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.	`string`	No	-	-

Status.locks[]¶

CatalogPrivateEndpointLock defines nested fields for CatalogPrivateEndpoint.Lock.

Field	Description	Type	Required	Default	Enum
`message`	A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.	`string`	No	-	-
`relatedResourceId`	The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.	`string`	No	-	-
`timeCreated`	When the lock was created.	`string`	No	-	-
`type`	Type of the lock.	`string`	No	-	-

Status.status¶

Field	Description	Type	Required	Default	Enum
`async`	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	`object`	No	-	-
`conditions`	-	`list[object]`	No	-	-
`createdAt`	-	`string (date-time)`	No	-	-
`deletedAt`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`ocid`	-	`string`	No	-	-
`opcRequestId`	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	`string`	No	-	-
`reason`	-	`string`	No	-	-
`requestedAt`	-	`string (date-time)`	No	-	-
`updatedAt`	-	`string (date-time)`	No	-	-

Status.status.async¶

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field	Description	Type	Required	Default	Enum
`current`	-	`object`	No	-	-

Status.status.async.current¶

Field	Description	Type	Required	Default	Enum
`message`	-	`string`	No	-	-
`normalizedClass`	-	`string`	Yes	-	`attention`, `canceled`, `failed`, `pending`, `succeeded`, `unknown`
`percentComplete`	-	`number`	No	-	-
`phase`	-	`string`	Yes	-	`create`, `delete`, `update`
`rawOperationType`	-	`string`	No	-	-
`rawStatus`	-	`string`	No	-	-
`source`	-	`string`	Yes	-	`lifecycle`, `none`, `workrequest`
`updatedAt`	-	`string (date-time)`	Yes	-	-
`workRequestId`	-	`string`	No	-	-

Status.status.conditions[]¶

Field	Description	Type	Required	Default	Enum
`lastTransitionTime`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`reason`	-	`string`	No	-	-
`status`	-	`string`	Yes	-	-
`type`	-	`string`	Yes	-	-

Connection¶

Connection is the Schema for the connections API.

Plural: connections
Scope: Namespaced
APIVersion: datacatalog.oracle.com/v1beta1
Sample: Sample (config/samples/datacatalog_v1beta1_connection.yaml)
Packages: Not currently exposed by a customer-visible package.

Spec¶

ConnectionSpec defines the desired state of Connection.

Field	Description	Type	Required	Default	Enum
`customPropertyMembers`	The list of customized properties along with the values for this object	`list[object]`	No	-	-
`description`	A description of the connection.	`string`	No	-	-
`displayName`	A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.	`string`	Yes	-	-
`encProperties`	A map of maps that contains the encrypted values for sensitive properties which are specific to the connection type. Each connection type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most connections have required properties within the "default" category. To determine the set of optional and required properties for a connection type, a query can be done on '/types?type=connection' that returns a collection of all connection types. The appropriate connection type, which will include definitions of all of it's properties, can be identified from this collection. Example: `{"encProperties": { "default": { "password": "example-password"}}}`	`map[string, map[string, string]]`	No	-	-
`isDefault`	Indicates whether this connection is the default connection. The first connection of a data asset defaults to being the default, subsequent connections default to not being the default. If a default connection already exists, then trying to create a connection as the default will fail. In this case the default connection would need to be updated not to be the default and then the new connection can then be created as the default.	`boolean`	No	-	-
`properties`	A map of maps that contains the properties which are specific to the connection type. Each connection type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most connections have required properties within the "default" category. To determine the set of optional and required properties for a connection type, a query can be done on '/types?type=connection' that returns a collection of all connection types. The appropriate connection type, which will include definitions of all of it's properties, can be identified from this collection. Example: `{"properties": { "default": { "username": "user1"}}}`	`map[string, map[string, string]]`	Yes	-	-
`typeKey`	The key of the object type. Type key's can be found via the '/types' endpoint.	`string`	Yes	-	-

Spec.customPropertyMembers[]¶

Back to Connection spec

ConnectionCustomPropertyMember defines nested fields for Connection.CustomPropertyMember.

Field	Description	Type	Required	Default	Enum
`displayName`	Name of the custom property	`string`	No	-	-
`key`	Unique Identifier of the attribute which is ID	`string`	No	-	-
`namespaceName`	Namespace name of the custom property	`string`	No	-	-
`value`	The custom property value	`string`	No	-	-

Status¶

ConnectionStatus defines the observed state of Connection.

Field	Description	Type	Required	Default	Enum
`createdById`	OCID of the user who created the connection.	`string`	No	-	-
`customPropertyMembers`	The list of customized properties along with the values for this object	`list[object]`	No	-	-
`dataAssetKey`	Unique key of the parent data asset.	`string`	No	-	-
`description`	A description of the connection.	`string`	No	-	-
`displayName`	A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.	`string`	No	-	-
`externalKey`	Unique external key of this object from the source system.	`string`	No	-	-
`isDefault`	Indicates whether this connection is the default connection.	`boolean`	No	-	-
`key`	Unique connection key that is immutable.	`string`	No	-	-
`lifecycleState`	The current state of the connection.	`string`	No	-	-
`properties`	A map of maps that contains the properties which are specific to the connection type. Each connection type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most connections have required properties within the "default" category. Example: `{"properties": { "default": { "username": "user1"}}}`	`map[string, map[string, string]]`	No	-	-
`status`	-	`object`	Yes	-	-
`timeCreated`	The date and time the connection was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: `2019-03-25T21:10:29.600Z`	`string`	No	-	-
`timeStatusUpdated`	Time that the connections status was last updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.	`string`	No	-	-
`timeUpdated`	The last time that any change was made to the connection. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.	`string`	No	-	-
`typeKey`	The key of the object type. Type key's can be found via the '/types' endpoint.	`string`	No	-	-
`updatedById`	OCID of the user who modified the connection.	`string`	No	-	-
`uri`	URI to the connection instance in the API.	`string`	No	-	-

Status.customPropertyMembers[]¶

ConnectionCustomPropertyMember defines nested fields for Connection.CustomPropertyMember.

Field	Description	Type	Required	Default	Enum
`displayName`	Name of the custom property	`string`	No	-	-
`key`	Unique Identifier of the attribute which is ID	`string`	No	-	-
`namespaceName`	Namespace name of the custom property	`string`	No	-	-
`value`	The custom property value	`string`	No	-	-

Status.status¶

Field	Description	Type	Required	Default	Enum
`async`	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	`object`	No	-	-
`conditions`	-	`list[object]`	No	-	-
`createdAt`	-	`string (date-time)`	No	-	-
`deletedAt`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`ocid`	-	`string`	No	-	-
`opcRequestId`	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	`string`	No	-	-
`reason`	-	`string`	No	-	-
`requestedAt`	-	`string (date-time)`	No	-	-
`updatedAt`	-	`string (date-time)`	No	-	-

Status.status.async¶

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field	Description	Type	Required	Default	Enum
`current`	-	`object`	No	-	-

Status.status.async.current¶

Field	Description	Type	Required	Default	Enum
`message`	-	`string`	No	-	-
`normalizedClass`	-	`string`	Yes	-	`attention`, `canceled`, `failed`, `pending`, `succeeded`, `unknown`
`percentComplete`	-	`number`	No	-	-
`phase`	-	`string`	Yes	-	`create`, `delete`, `update`
`rawOperationType`	-	`string`	No	-	-
`rawStatus`	-	`string`	No	-	-
`source`	-	`string`	Yes	-	`lifecycle`, `none`, `workrequest`
`updatedAt`	-	`string (date-time)`	Yes	-	-
`workRequestId`	-	`string`	No	-	-

Status.status.conditions[]¶

Field	Description	Type	Required	Default	Enum
`lastTransitionTime`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`reason`	-	`string`	No	-	-
`status`	-	`string`	Yes	-	-
`type`	-	`string`	Yes	-	-

CustomProperty¶

CustomProperty is the Schema for the customproperties API.

Plural: customproperties
Scope: Namespaced
APIVersion: datacatalog.oracle.com/v1beta1
Sample: Sample (config/samples/datacatalog_v1beta1_customproperty.yaml)
Packages: Not currently exposed by a customer-visible package.

Spec¶

CustomPropertySpec defines the desired state of CustomProperty.

Field	Description	Type	Required	Default	Enum
`allowedValues`	Allowed values for the custom property if any	`list[string]`	No	-	-
`dataType`	The data type of the custom property	`string`	No	-	-
`description`	Detailed description of the custom property.	`string`	No	-	-
`displayName`	A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.	`string`	Yes	-	-
`isEditable`	If this field is a editable field	`boolean`	No	-	-
`isEventEnabled`	If an OCI Event will be emitted when the custom property is modified.	`boolean`	No	-	-
`isFilterable`	If this field allows to filter or create facets from UI	`boolean`	No	-	-
`isHidden`	If this field is a hidden field	`boolean`	No	-	-
`isHiddenInSearch`	If this field is allowed to pop in search results	`boolean`	No	-	-
`isMultiValued`	If this field allows multiple values to be set	`boolean`	No	-	-
`isShownInList`	If this field is displayed in a list view of applicable objects.	`boolean`	No	-	-
`isSortable`	If this field allows to sort from UI	`boolean`	No	-	-
`properties`	A map of maps that contains the properties which are specific to the data asset type. Each data asset type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data assets have required properties within the "default" category. To determine the set of optional and required properties for a data asset type, a query can be done on '/types?type=dataAsset' that returns a collection of all data asset types. The appropriate data asset type, which includes definitions of all of it's properties, can be identified from this collection. Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}`	`map[string, map[string, string]]`	No	-	-

Status¶

CustomPropertyStatus defines the observed state of CustomProperty.

Field	Description	Type	Required	Default	Enum
`allowedValues`	Allowed values for the custom property if any	`list[string]`	No	-	-
`createdById`	OCID of the user who created the custom property.	`string`	No	-	-
`dataType`	Data type of the custom property	`string`	No	-	-
`description`	Description for the custom property	`string`	No	-	-
`displayName`	Display name of the custom property	`string`	No	-	-
`events`	Event configuration for this custom property, against the desired subset of object types to which the property applies.	`list[object]`	No	-	-
`isEditable`	If this field is a editable field	`boolean`	No	-	-
`isEventEnabled`	If an OCI Event will be emitted when the custom property is modified.	`boolean`	No	-	-
`isFilterable`	If this field allows to filter or create facets from UI	`boolean`	No	-	-
`isHidden`	If this field is a hidden field	`boolean`	No	-	-
`isHiddenInSearch`	If this field is allowed to pop in search results	`boolean`	No	-	-
`isListType`	Is this property allowed to have list of values	`boolean`	No	-	-
`isMultiValued`	If this field allows multiple values to be set	`boolean`	No	-	-
`isServiceDefined`	If this field is defined by service or by a user	`boolean`	No	-	-
`isShownInList`	If this field is displayed in a list view of applicable objects.	`boolean`	No	-	-
`isSortable`	If this field allows to sort from UI	`boolean`	No	-	-
`key`	Unique data asset key that is immutable.	`string`	No	-	-
`lifecycleState`	The current state of the custom property.	`string`	No	-	-
`namespaceName`	Namespace name of the custom property	`string`	No	-	-
`properties`	A map of maps that contains the properties which are specific to the asset type. Each data asset type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data assets have required properties within the "default" category. Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}`	`map[string, map[string, string]]`	No	-	-
`scope`	The set of object types to which the custom property applies.	`list[object]`	No	-	-
`status`	-	`object`	Yes	-	-
`timeCreated`	The date and time the custom property was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: `2019-03-25T21:10:29.600Z`	`string`	No	-	-
`timeUpdated`	The last time that any change was made to the custom property. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.	`string`	No	-	-
`updatedById`	OCID of the user who last modified the custom property.	`string`	No	-	-
`usageCount`	Total number of first class objects using this custom property	`integer`	No	-	-

Status.events[]¶

CustomPropertyEvent defines nested fields for CustomProperty.Event.

Field	Description	Type	Required	Default	Enum
`createdById`	OCID of the user who created the configuration.	`string`	No	-	-
`eventConfigStatus`	Status of the configuration.	`string`	No	-	-
`propertyId`	Unique property key identifier.	`string`	No	-	-
`propertyName`	Name of the property.	`string`	No	-	-
`timeCreated`	The date and time the event was configured, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: `2019-03-25T21:10:29.600Z`	`string`	No	-	-
`timeUpdated`	The last time that any change was made to the configuration. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.	`string`	No	-	-
`typeId`	Unique type key identifier.	`string`	No	-	-
`typeName`	Name of the type.	`string`	No	-	-
`updatedById`	OCID of the user who last modified the configuration.	`string`	No	-	-

Status.scope[]¶

CustomPropertyScope defines nested fields for CustomProperty.Scope.

Field	Description	Type	Required	Default	Enum
`count`	Number of objects associated with this type	`integer`	No	-	-
`isEventEnabled`	If an OCI Event will be emitted when the custom property is modified.	`boolean`	No	-	-
`typeId`	Unique type key identifier	`string`	No	-	-
`typeName`	Name of the type associated with	`string`	No	-	-

Status.status¶

Field	Description	Type	Required	Default	Enum
`async`	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	`object`	No	-	-
`conditions`	-	`list[object]`	No	-	-
`createdAt`	-	`string (date-time)`	No	-	-
`deletedAt`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`ocid`	-	`string`	No	-	-
`opcRequestId`	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	`string`	No	-	-
`reason`	-	`string`	No	-	-
`requestedAt`	-	`string (date-time)`	No	-	-
`updatedAt`	-	`string (date-time)`	No	-	-

Status.status.async¶

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field	Description	Type	Required	Default	Enum
`current`	-	`object`	No	-	-

Status.status.async.current¶

Field	Description	Type	Required	Default	Enum
`message`	-	`string`	No	-	-
`normalizedClass`	-	`string`	Yes	-	`attention`, `canceled`, `failed`, `pending`, `succeeded`, `unknown`
`percentComplete`	-	`number`	No	-	-
`phase`	-	`string`	Yes	-	`create`, `delete`, `update`
`rawOperationType`	-	`string`	No	-	-
`rawStatus`	-	`string`	No	-	-
`source`	-	`string`	Yes	-	`lifecycle`, `none`, `workrequest`
`updatedAt`	-	`string (date-time)`	Yes	-	-
`workRequestId`	-	`string`	No	-	-

Status.status.conditions[]¶

Field	Description	Type	Required	Default	Enum
`lastTransitionTime`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`reason`	-	`string`	No	-	-
`status`	-	`string`	Yes	-	-
`type`	-	`string`	Yes	-	-

DataAsset¶

DataAsset is the Schema for the dataassets API.

Plural: dataassets
Scope: Namespaced
APIVersion: datacatalog.oracle.com/v1beta1
Sample: Sample (config/samples/datacatalog_v1beta1_dataasset.yaml)
Packages: Not currently exposed by a customer-visible package.

Spec¶

DataAssetSpec defines the desired state of DataAsset.

Field	Description	Type	Required	Default	Enum
`customPropertyMembers`	The list of customized properties along with the values for this object	`list[object]`	No	-	-
`description`	Detailed description of the data asset.	`string`	No	-	-
`displayName`	A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.	`string`	Yes	-	-
`properties`	A map of maps that contains the properties which are specific to the data asset type. Each data asset type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data assets have required properties within the "default" category. To determine the set of optional and required properties for a data asset type, a query can be done on '/types?type=dataAsset' that returns a collection of all data asset types. The appropriate data asset type, which includes definitions of all of it's properties, can be identified from this collection. Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}`	`map[string, map[string, string]]`	No	-	-
`typeKey`	The key of the data asset type. This can be obtained via the '/types' endpoint.	`string`	Yes	-	-

Spec.customPropertyMembers[]¶

Back to DataAsset spec

DataAssetCustomPropertyMember defines nested fields for DataAsset.CustomPropertyMember.

Field	Description	Type	Required	Default	Enum
`displayName`	Name of the custom property	`string`	No	-	-
`key`	Unique Identifier of the attribute which is ID	`string`	No	-	-
`namespaceName`	Namespace name of the custom property	`string`	No	-	-
`value`	The custom property value	`string`	No	-	-

Status¶

DataAssetStatus defines the observed state of DataAsset.

Field	Description	Type	Required	Default	Enum
`catalogId`	The data catalog's OCID.	`string`	No	-	-
`createdById`	OCID of the user who created the data asset.	`string`	No	-	-
`customPropertyMembers`	The list of customized properties along with the values for this object	`list[object]`	No	-	-
`dataSelectorPatterns`	The list of data selector patterns used in the harvest for this data asset to derive logical entities.	`list[object]`	No	-	-
`description`	Detailed description of the data asset.	`string`	No	-	-
`displayName`	A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.	`string`	No	-	-
`externalKey`	External URI that can be used to reference the object. Format will differ based on the type of object.	`string`	No	-	-
`key`	Unique data asset key that is immutable.	`string`	No	-	-
`lifecycleDetails`	A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, see service documentation for details.	`string`	No	-	-
`lifecycleState`	The current state of the data asset.	`string`	No	-	-
`properties`	A map of maps that contains the properties which are specific to the asset type. Each data asset type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data assets have required properties within the "default" category. Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}`	`map[string, map[string, string]]`	No	-	-
`status`	-	`object`	Yes	-	-
`timeCreated`	The date and time the data asset was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: `2019-03-25T21:10:29.600Z`	`string`	No	-	-
`timeHarvested`	The last time that a harvest was performed on the data asset. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.	`string`	No	-	-
`timeUpdated`	The last time that any change was made to the data asset. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.	`string`	No	-	-
`typeKey`	The key of the object type. Type key's can be found via the '/types' endpoint.	`string`	No	-	-
`updatedById`	OCID of the user who last modified the data asset.	`string`	No	-	-
`uri`	URI to the data asset instance in the API.	`string`	No	-	-

Status.customPropertyMembers[]¶

DataAssetCustomPropertyMember defines nested fields for DataAsset.CustomPropertyMember.

Field	Description	Type	Required	Default	Enum
`displayName`	Name of the custom property	`string`	No	-	-
`key`	Unique Identifier of the attribute which is ID	`string`	No	-	-
`namespaceName`	Namespace name of the custom property	`string`	No	-	-
`value`	The custom property value	`string`	No	-	-

Status.dataSelectorPatterns[]¶

DataAssetDataSelectorPattern defines nested fields for DataAsset.DataSelectorPattern.

Field	Description	Type	Required	Default	Enum
`catalogId`	The data catalog's OCID.	`string`	No	-	-
`description`	Detailed description of the pattern.	`string`	No	-	-
`displayName`	A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.	`string`	No	-	-
`expression`	Input string which drives the selection process, allowing for fine-grained control using qualifiers. Refer to the user documentation for details of the format and examples. A pattern cannot include both a prefix and an expression.	`string`	No	-	-
`filePathPrefix`	Input string which drives the selection process. Refer to the user documentation for details of the format and examples. A pattern cannot include both a prefix and an expression.	`string`	No	-	-
`key`	Unique pattern key that is immutable.	`string`	No	-	-
`lifecycleState`	State of the pattern.	`string`	No	-	-
`timeCreated`	The date and time the pattern was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: `2019-03-25T21:10:29.600Z`	`string`	No	-	-

Status.status¶

Field	Description	Type	Required	Default	Enum
`async`	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	`object`	No	-	-
`conditions`	-	`list[object]`	No	-	-
`createdAt`	-	`string (date-time)`	No	-	-
`deletedAt`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`ocid`	-	`string`	No	-	-
`opcRequestId`	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	`string`	No	-	-
`reason`	-	`string`	No	-	-
`requestedAt`	-	`string (date-time)`	No	-	-
`updatedAt`	-	`string (date-time)`	No	-	-

Status.status.async¶

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field	Description	Type	Required	Default	Enum
`current`	-	`object`	No	-	-

Status.status.async.current¶

Field	Description	Type	Required	Default	Enum
`message`	-	`string`	No	-	-
`normalizedClass`	-	`string`	Yes	-	`attention`, `canceled`, `failed`, `pending`, `succeeded`, `unknown`
`percentComplete`	-	`number`	No	-	-
`phase`	-	`string`	Yes	-	`create`, `delete`, `update`
`rawOperationType`	-	`string`	No	-	-
`rawStatus`	-	`string`	No	-	-
`source`	-	`string`	Yes	-	`lifecycle`, `none`, `workrequest`
`updatedAt`	-	`string (date-time)`	Yes	-	-
`workRequestId`	-	`string`	No	-	-

Status.status.conditions[]¶

Field	Description	Type	Required	Default	Enum
`lastTransitionTime`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`reason`	-	`string`	No	-	-
`status`	-	`string`	Yes	-	-
`type`	-	`string`	Yes	-	-

DataAssetTag¶

DataAssetTag is the Schema for the dataassettags API.

Plural: dataassettags
Scope: Namespaced
APIVersion: datacatalog.oracle.com/v1beta1
Sample: Sample (config/samples/datacatalog_v1beta1_dataassettag.yaml)
Packages: Not currently exposed by a customer-visible package.

Spec¶

DataAssetTagSpec defines the desired state of DataAssetTag.

Field	Description	Type	Required	Default	Enum
`name`	The name of the tag in the case of a free form tag. When linking to a glossary term, this field is not specified.	`string`	No	-	-
`termKey`	Unique key of the related term or null in the case of a free form tag.	`string`	No	-	-

Status¶

DataAssetTagStatus defines the observed state of DataAssetTag.

Field	Description	Type	Required	Default	Enum
`createdById`	OCID of the user who created the tag.	`string`	No	-	-
`dataAssetKey`	The unique key of the parent data asset.	`string`	No	-	-
`glossaryKey`	Unique id of the parent glossary of the term.	`string`	No	-	-
`key`	Unique tag key that is immutable.	`string`	No	-	-
`lifecycleState`	The current state of the tag.	`string`	No	-	-
`name`	Name of the tag which matches the term name.	`string`	No	-	-
`status`	-	`object`	Yes	-	-
`termDescription`	Description of the related term.	`string`	No	-	-
`termKey`	Unique key of the related term.	`string`	No	-	-
`termPath`	Path of the related term.	`string`	No	-	-
`timeCreated`	The date and time the tag was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: `2019-03-25T21:10:29.600Z`	`string`	No	-	-
`uri`	URI to the tag instance in the API.	`string`	No	-	-

Status.status¶

Field	Description	Type	Required	Default	Enum
`async`	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	`object`	No	-	-
`conditions`	-	`list[object]`	No	-	-
`createdAt`	-	`string (date-time)`	No	-	-
`deletedAt`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`ocid`	-	`string`	No	-	-
`opcRequestId`	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	`string`	No	-	-
`reason`	-	`string`	No	-	-
`requestedAt`	-	`string (date-time)`	No	-	-
`updatedAt`	-	`string (date-time)`	No	-	-

Status.status.async¶

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field	Description	Type	Required	Default	Enum
`current`	-	`object`	No	-	-

Status.status.async.current¶

Field	Description	Type	Required	Default	Enum
`message`	-	`string`	No	-	-
`normalizedClass`	-	`string`	Yes	-	`attention`, `canceled`, `failed`, `pending`, `succeeded`, `unknown`
`percentComplete`	-	`number`	No	-	-
`phase`	-	`string`	Yes	-	`create`, `delete`, `update`
`rawOperationType`	-	`string`	No	-	-
`rawStatus`	-	`string`	No	-	-
`source`	-	`string`	Yes	-	`lifecycle`, `none`, `workrequest`
`updatedAt`	-	`string (date-time)`	Yes	-	-
`workRequestId`	-	`string`	No	-	-

Status.status.conditions[]¶

Field	Description	Type	Required	Default	Enum
`lastTransitionTime`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`reason`	-	`string`	No	-	-
`status`	-	`string`	Yes	-	-
`type`	-	`string`	Yes	-	-

Entity¶

Entity is the Schema for the entities API.

Plural: entities
Scope: Namespaced
APIVersion: datacatalog.oracle.com/v1beta1
Sample: Sample (config/samples/datacatalog_v1beta1_entity.yaml)
Packages: Not currently exposed by a customer-visible package.

Spec¶

EntitySpec defines the desired state of Entity.

Field	Description	Type	Required	Default	Enum
`businessName`	Optional user friendly business name of the data entity. If set, this supplements the harvested display name of the object.	`string`	No	-	-
`customPropertyMembers`	The list of customized properties along with the values for this object	`list[object]`	No	-	-
`description`	Detailed description of a data entity.	`string`	No	-	-
`displayName`	A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.	`string`	Yes	-	-
`folderKey`	Key of the associated folder.	`string`	No	-	-
`harvestStatus`	Status of the object as updated by the harvest process. When an entity object is created , it's harvest status will indicate if the entity's metadata has been fully harvested or not. The harvest process can perform shallow harvesting to allow users to browse the metadata and can on-demand deep harvest on any object This requires a harvest status indicator for catalog objects.	`string`	No	-	-
`isLogical`	Property to indicate if the object is a physical materialized object or virtual. For example, View.	`boolean`	No	-	-
`isPartition`	Property to indicate if the object is a sub object of a parent physical object.	`boolean`	No	-	-
`lastJobKey`	Key of the last harvest process to update this object.	`string`	No	-	-
`patternKey`	Key of the associated pattern if this is a logical entity.	`string`	No	-	-
`properties`	A map of maps that contains the properties which are specific to the entity type. Each entity type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most entities have required properties within the "default" category. To determine the set of required and optional properties for an entity type, a query can be done on '/types?type=dataEntity' that returns a collection of all entity types. The appropriate entity type, which includes definitions of all of it's properties, can be identified from this collection. Example: `{"properties": { "default": { "key1": "value1"}}}`	`map[string, map[string, string]]`	No	-	-
`realizedExpression`	The expression realized after resolving qualifiers . Used in deriving this logical entity	`string`	No	-	-
`timeExternal`	Last modified timestamp of the object in the external system.	`string`	Yes	-	-
`typeKey`	The type of data entity object. Type key's can be found via the '/types' endpoint.	`string`	No	-	-

Spec.customPropertyMembers[]¶

Back to Entity spec

EntityCustomPropertyMember defines nested fields for Entity.CustomPropertyMember.

Field	Description	Type	Required	Default	Enum
`displayName`	Name of the custom property	`string`	No	-	-
`key`	Unique Identifier of the attribute which is ID	`string`	No	-	-
`namespaceName`	Namespace name of the custom property	`string`	No	-	-
`value`	The custom property value	`string`	No	-	-

Status¶

EntityStatus defines the observed state of Entity.

Field	Description	Type	Required	Default	Enum
`businessName`	Optional user friendly business name of the data entity. If set, this supplements the harvested display name of the object.	`string`	No	-	-
`createdById`	OCID of the user who created this object in the data catalog.	`string`	No	-	-
`customPropertyMembers`	The list of customized properties along with the values for this object	`list[object]`	No	-	-
`dataAssetKey`	Unique key of the parent data asset.	`string`	No	-	-
`description`	Detailed description of a data entity.	`string`	No	-	-
`displayName`	A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.	`string`	No	-	-
`externalKey`	Unique external key of this object in the source system.	`string`	No	-	-
`folderKey`	Key of the associated folder.	`string`	No	-	-
`folderName`	Name of the associated folder. This name is harvested from the source data asset when the parent folder for the entiy is harvested.	`string`	No	-	-
`harvestStatus`	Status of the object as updated by the harvest process.	`string`	No	-	-
`isLogical`	Property that identifies if the object is a physical object (materialized) or virtual/logical object defined on other objects.	`boolean`	No	-	-
`isPartition`	Property that identifies if an object is a sub object of a physical or materialized parent object.	`boolean`	No	-	-
`key`	Unique data entity key that is immutable.	`string`	No	-	-
`lastJobKey`	Key of the last harvest process to update this object.	`string`	No	-	-
`lifecycleDetails`	A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, see service documentation for details.	`string`	No	-	-
`lifecycleState`	The current state of the data entity.	`string`	No	-	-
`objectRelationships`	List of objects and their relationships to this entity.	`list[object]`	No	-	-
`objectStorageUrl`	URL of the data entity in the object store.	`string`	No	-	-
`path`	Full path of the data entity.	`string`	No	-	-
`patternKey`	Key of the associated pattern if this is a logical entity.	`string`	No	-	-
`properties`	A map of maps that contains the properties which are specific to the entity type. Each entity type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data entities have required properties within the "default" category. Example: `{"properties": { "default": { "key1": "value1"}}}`	`map[string, map[string, string]]`	No	-	-
`realizedExpression`	The expression realized after resolving qualifiers . Used in deriving this logical entity	`string`	No	-	-
`status`	-	`object`	Yes	-	-
`timeCreated`	The date and time the data entity was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: `2019-03-25T21:10:29.600Z`	`string`	No	-	-
`timeExternal`	Last modified timestamp of this object in the external system.	`string`	No	-	-
`timeHarvested`	The date and time the entity was harvested, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).	`string`	No	-	-
`timeStatusUpdated`	Time that the data entities status was last updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.	`string`	No	-	-
`timeUpdated`	The last time that any change was made to the data entity. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.	`string`	No	-	-
`typeKey`	The type of data entity object. Type key's can be found via the '/types' endpoint.	`string`	No	-	-
`updatedById`	OCID of the user who updated this object in the data catalog.	`string`	No	-	-
`uri`	URI to the data entity instance in the API.	`string`	No	-	-

Status.customPropertyMembers[]¶

EntityCustomPropertyMember defines nested fields for Entity.CustomPropertyMember.

Field	Description	Type	Required	Default	Enum
`displayName`	Name of the custom property	`string`	No	-	-
`key`	Unique Identifier of the attribute which is ID	`string`	No	-	-
`namespaceName`	Namespace name of the custom property	`string`	No	-	-
`value`	The custom property value	`string`	No	-	-

Status.objectRelationships[]¶

EntityObjectRelationship defines nested fields for Entity.ObjectRelationship.

Field	Description	Type	Required	Default	Enum
`key`	Unique id of the object.	`string`	No	-	-
`name`	Name of the object.	`string`	No	-	-
`parentKey`	Key of the parent object for the resource.	`string`	No	-	-
`parentPath`	Full path of the parent object.	`string`	No	-	-
`path`	Full path of the object.	`string`	No	-	-
`relationshipType`	Type of relationship with the referencing object.	`string`	No	-	-
`timeCreated`	The date and time the relationship was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: `2019-03-25T21:10:29.600Z`	`string`	No	-	-
`timeUpdated`	The last time a change was made to this reference. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.	`string`	No	-	-
`typeKey`	Type key of the object. Type keys can be found via the '/types' endpoint.	`string`	No	-	-
`typeName`	Type name of the object. Type names can be found via the '/types' endpoint.	`string`	No	-	-

Status.status¶

Field	Description	Type	Required	Default	Enum
`async`	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	`object`	No	-	-
`conditions`	-	`list[object]`	No	-	-
`createdAt`	-	`string (date-time)`	No	-	-
`deletedAt`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`ocid`	-	`string`	No	-	-
`opcRequestId`	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	`string`	No	-	-
`reason`	-	`string`	No	-	-
`requestedAt`	-	`string (date-time)`	No	-	-
`updatedAt`	-	`string (date-time)`	No	-	-

Status.status.async¶

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field	Description	Type	Required	Default	Enum
`current`	-	`object`	No	-	-

Status.status.async.current¶

Field	Description	Type	Required	Default	Enum
`message`	-	`string`	No	-	-
`normalizedClass`	-	`string`	Yes	-	`attention`, `canceled`, `failed`, `pending`, `succeeded`, `unknown`
`percentComplete`	-	`number`	No	-	-
`phase`	-	`string`	Yes	-	`create`, `delete`, `update`
`rawOperationType`	-	`string`	No	-	-
`rawStatus`	-	`string`	No	-	-
`source`	-	`string`	Yes	-	`lifecycle`, `none`, `workrequest`
`updatedAt`	-	`string (date-time)`	Yes	-	-
`workRequestId`	-	`string`	No	-	-

Status.status.conditions[]¶

Field	Description	Type	Required	Default	Enum
`lastTransitionTime`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`reason`	-	`string`	No	-	-
`status`	-	`string`	Yes	-	-
`type`	-	`string`	Yes	-	-

EntityTag¶

EntityTag is the Schema for the entitytags API.

Plural: entitytags
Scope: Namespaced
APIVersion: datacatalog.oracle.com/v1beta1
Sample: Sample (config/samples/datacatalog_v1beta1_entitytag.yaml)
Packages: Not currently exposed by a customer-visible package.

Spec¶

EntityTagSpec defines the desired state of EntityTag.

Field	Description	Type	Required	Default	Enum
`name`	The name of the tag in the case of a free form tag. When linking to a glossary term, this field is not specified.	`string`	No	-	-
`termKey`	Unique key of the related term or null in the case of a free form tag.	`string`	No	-	-

Status¶

EntityTagStatus defines the observed state of EntityTag.

Field	Description	Type	Required	Default	Enum
`createdById`	OCID of the user who created the tag.	`string`	No	-	-
`entityKey`	The unique key of the parent entity.	`string`	No	-	-
`glossaryKey`	Unique id of the parent glossary of the term.	`string`	No	-	-
`key`	Unique tag key that is immutable.	`string`	No	-	-
`lifecycleState`	The current state of the tag.	`string`	No	-	-
`name`	Name of the tag which matches the term name.	`string`	No	-	-
`status`	-	`object`	Yes	-	-
`termDescription`	Description of the related term.	`string`	No	-	-
`termKey`	Unique key of the related term.	`string`	No	-	-
`termPath`	Path of the related term.	`string`	No	-	-
`timeCreated`	The date and time the tag was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: `2019-03-25T21:10:29.600Z`	`string`	No	-	-
`uri`	URI to the tag instance in the API.	`string`	No	-	-

Status.status¶

Field	Description	Type	Required	Default	Enum
`async`	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	`object`	No	-	-
`conditions`	-	`list[object]`	No	-	-
`createdAt`	-	`string (date-time)`	No	-	-
`deletedAt`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`ocid`	-	`string`	No	-	-
`opcRequestId`	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	`string`	No	-	-
`reason`	-	`string`	No	-	-
`requestedAt`	-	`string (date-time)`	No	-	-
`updatedAt`	-	`string (date-time)`	No	-	-

Status.status.async¶

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field	Description	Type	Required	Default	Enum
`current`	-	`object`	No	-	-

Status.status.async.current¶

Field	Description	Type	Required	Default	Enum
`message`	-	`string`	No	-	-
`normalizedClass`	-	`string`	Yes	-	`attention`, `canceled`, `failed`, `pending`, `succeeded`, `unknown`
`percentComplete`	-	`number`	No	-	-
`phase`	-	`string`	Yes	-	`create`, `delete`, `update`
`rawOperationType`	-	`string`	No	-	-
`rawStatus`	-	`string`	No	-	-
`source`	-	`string`	Yes	-	`lifecycle`, `none`, `workrequest`
`updatedAt`	-	`string (date-time)`	Yes	-	-
`workRequestId`	-	`string`	No	-	-

Status.status.conditions[]¶

Field	Description	Type	Required	Default	Enum
`lastTransitionTime`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`reason`	-	`string`	No	-	-
`status`	-	`string`	Yes	-	-
`type`	-	`string`	Yes	-	-

Folder¶

Folder is the Schema for the folders API.

Plural: folders
Scope: Namespaced
APIVersion: datacatalog.oracle.com/v1beta1
Sample: Sample (config/samples/datacatalog_v1beta1_folder.yaml)
Packages: Not currently exposed by a customer-visible package.

Spec¶

FolderSpec defines the desired state of Folder.

Field	Description	Type	Required	Default	Enum
`businessName`	Optional user friendly business name of the folder. If set, this supplements the harvested display name of the object.	`string`	No	-	-
`customPropertyMembers`	The list of customized properties along with the values for this object	`list[object]`	No	-	-
`description`	Detailed description of a folder.	`string`	No	-	-
`displayName`	A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.	`string`	Yes	-	-
`harvestStatus`	Folder harvesting status.	`string`	No	-	-
`lastJobKey`	The job key of the harvest process that updated the folder definition from the source system.	`string`	No	-	-
`parentFolderKey`	The key of the containing folder or null if there isn't a parent folder.	`string`	No	-	-
`properties`	A map of maps that contains the properties which are specific to the folder type. Each folder type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most folders have required properties within the "default" category. To determine the set of optional and required properties for a folder type, a query can be done on '/types?type=folder' that returns a collection of all folder types. The appropriate folder type, which includes definitions of all of it's properties, can be identified from this collection. Example: `{"properties": { "default": { "key1": "value1"}}}`	`map[string, map[string, string]]`	No	-	-
`timeExternal`	Last modified timestamp of this object in the external system.	`string`	Yes	-	-
`typeKey`	Type key of the object. Type keys can be found via the '/types' endpoint.	`string`	No	-	-

Spec.customPropertyMembers[]¶

Back to Folder spec

FolderCustomPropertyMember defines nested fields for Folder.CustomPropertyMember.

Field	Description	Type	Required	Default	Enum
`displayName`	Name of the custom property	`string`	No	-	-
`key`	Unique Identifier of the attribute which is ID	`string`	No	-	-
`namespaceName`	Namespace name of the custom property	`string`	No	-	-
`value`	The custom property value	`string`	No	-	-

Status¶

FolderStatus defines the observed state of Folder.

Field	Description	Type	Required	Default	Enum
`businessName`	Optional user friendly business name of the folder. If set, this supplements the harvested display name of the object.	`string`	No	-	-
`createdById`	OCID of the user who created the folder.	`string`	No	-	-
`customPropertyMembers`	The list of customized properties along with the values for this object	`list[object]`	No	-	-
`dataAssetKey`	The key of the associated data asset.	`string`	No	-	-
`description`	Detailed description of a folder.	`string`	No	-	-
`displayName`	A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.	`string`	No	-	-
`externalKey`	Unique external key of this object in the source system.	`string`	No	-	-
`harvestStatus`	Status of the object as updated by the harvest process.	`string`	No	-	-
`key`	Unique folder key that is immutable.	`string`	No	-	-
`lastJobKey`	The key of the last harvest process to update the metadata of this object.	`string`	No	-	-
`lifecycleDetails`	A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, see service documentation for details.	`string`	No	-	-
`lifecycleState`	The current state of the folder.	`string`	No	-	-
`objectRelationships`	List of objects and their relationships to this folder.	`list[object]`	No	-	-
`objectStorageUrl`	URL of the folder in the object store.	`string`	No	-	-
`parentFolderKey`	The unique key of the containing folder or null if there is no parent folder.	`string`	No	-	-
`path`	Full path of the folder.	`string`	No	-	-
`properties`	A map of maps that contains the properties which are specific to the folder type. Each folder type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most folders have required properties within the "default" category. Example: `{"properties": { "default": { "key1": "value1"}}}`	`map[string, map[string, string]]`	No	-	-
`status`	-	`object`	Yes	-	-
`timeCreated`	The date and time the folder was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: `2019-03-25T21:10:29.600Z`	`string`	No	-	-
`timeExternal`	Last modified timestamp of this object in the external system.	`string`	No	-	-
`timeHarvested`	The date and time the folder was harvested, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).	`string`	No	-	-
`timeUpdated`	The last time that any change was made to the folder. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.	`string`	No	-	-
`typeKey`	The type of folder object. Type keys can be found via the '/types' endpoint.	`string`	No	-	-
`updatedById`	OCID of the user who modified the folder.	`string`	No	-	-
`uri`	URI to the folder instance in the API.	`string`	No	-	-

Status.customPropertyMembers[]¶

FolderCustomPropertyMember defines nested fields for Folder.CustomPropertyMember.

Field	Description	Type	Required	Default	Enum
`displayName`	Name of the custom property	`string`	No	-	-
`key`	Unique Identifier of the attribute which is ID	`string`	No	-	-
`namespaceName`	Namespace name of the custom property	`string`	No	-	-
`value`	The custom property value	`string`	No	-	-

Status.objectRelationships[]¶

FolderObjectRelationship defines nested fields for Folder.ObjectRelationship.

Field	Description	Type	Required	Default	Enum
`key`	Unique id of the object.	`string`	No	-	-
`name`	Name of the object.	`string`	No	-	-
`parentKey`	Key of the parent object for the resource.	`string`	No	-	-
`parentPath`	Full path of the parent object.	`string`	No	-	-
`path`	Full path of the object.	`string`	No	-	-
`relationshipType`	Type of relationship with the referencing object.	`string`	No	-	-
`timeCreated`	The date and time the relationship was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: `2019-03-25T21:10:29.600Z`	`string`	No	-	-
`timeUpdated`	The last time a change was made to this reference. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.	`string`	No	-	-
`typeKey`	Type key of the object. Type keys can be found via the '/types' endpoint.	`string`	No	-	-
`typeName`	Type name of the object. Type names can be found via the '/types' endpoint.	`string`	No	-	-

Status.status¶

Field	Description	Type	Required	Default	Enum
`async`	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	`object`	No	-	-
`conditions`	-	`list[object]`	No	-	-
`createdAt`	-	`string (date-time)`	No	-	-
`deletedAt`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`ocid`	-	`string`	No	-	-
`opcRequestId`	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	`string`	No	-	-
`reason`	-	`string`	No	-	-
`requestedAt`	-	`string (date-time)`	No	-	-
`updatedAt`	-	`string (date-time)`	No	-	-

Status.status.async¶

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field	Description	Type	Required	Default	Enum
`current`	-	`object`	No	-	-

Status.status.async.current¶

Field	Description	Type	Required	Default	Enum
`message`	-	`string`	No	-	-
`normalizedClass`	-	`string`	Yes	-	`attention`, `canceled`, `failed`, `pending`, `succeeded`, `unknown`
`percentComplete`	-	`number`	No	-	-
`phase`	-	`string`	Yes	-	`create`, `delete`, `update`
`rawOperationType`	-	`string`	No	-	-
`rawStatus`	-	`string`	No	-	-
`source`	-	`string`	Yes	-	`lifecycle`, `none`, `workrequest`
`updatedAt`	-	`string (date-time)`	Yes	-	-
`workRequestId`	-	`string`	No	-	-

Status.status.conditions[]¶

Field	Description	Type	Required	Default	Enum
`lastTransitionTime`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`reason`	-	`string`	No	-	-
`status`	-	`string`	Yes	-	-
`type`	-	`string`	Yes	-	-

FolderTag¶

FolderTag is the Schema for the foldertags API.

Plural: foldertags
Scope: Namespaced
APIVersion: datacatalog.oracle.com/v1beta1
Sample: Sample (config/samples/datacatalog_v1beta1_foldertag.yaml)
Packages: Not currently exposed by a customer-visible package.

Spec¶

FolderTagSpec defines the desired state of FolderTag.

Field	Description	Type	Required	Default	Enum
`name`	The name of the tag in the case of a free form tag. When linking to a glossary term, this field is not specified.	`string`	No	-	-
`termKey`	Unique key of the related term or null in the case of a free form tag.	`string`	No	-	-

Status¶

FolderTagStatus defines the observed state of FolderTag.

Field	Description	Type	Required	Default	Enum
`createdById`	OCID of the user who created the tag.	`string`	No	-	-
`folderKey`	The unique key of the folder associated with this tag.	`string`	No	-	-
`glossaryKey`	Unique id of the parent glossary of the term.	`string`	No	-	-
`key`	Unique tag key that is immutable.	`string`	No	-	-
`lifecycleState`	The current state of the tag.	`string`	No	-	-
`name`	Name of the tag which matches the term name.	`string`	No	-	-
`status`	-	`object`	Yes	-	-
`termDescription`	Description of the related term.	`string`	No	-	-
`termKey`	Unique key of the related term.	`string`	No	-	-
`termPath`	Path of the related term.	`string`	No	-	-
`timeCreated`	The date and time the tag was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: `2019-03-25T21:10:29.600Z`	`string`	No	-	-
`uri`	URI to the tag instance in the API.	`string`	No	-	-

Status.status¶

Field	Description	Type	Required	Default	Enum
`async`	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	`object`	No	-	-
`conditions`	-	`list[object]`	No	-	-
`createdAt`	-	`string (date-time)`	No	-	-
`deletedAt`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`ocid`	-	`string`	No	-	-
`opcRequestId`	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	`string`	No	-	-
`reason`	-	`string`	No	-	-
`requestedAt`	-	`string (date-time)`	No	-	-
`updatedAt`	-	`string (date-time)`	No	-	-

Status.status.async¶

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field	Description	Type	Required	Default	Enum
`current`	-	`object`	No	-	-

Status.status.async.current¶

Field	Description	Type	Required	Default	Enum
`message`	-	`string`	No	-	-
`normalizedClass`	-	`string`	Yes	-	`attention`, `canceled`, `failed`, `pending`, `succeeded`, `unknown`
`percentComplete`	-	`number`	No	-	-
`phase`	-	`string`	Yes	-	`create`, `delete`, `update`
`rawOperationType`	-	`string`	No	-	-
`rawStatus`	-	`string`	No	-	-
`source`	-	`string`	Yes	-	`lifecycle`, `none`, `workrequest`
`updatedAt`	-	`string (date-time)`	Yes	-	-
`workRequestId`	-	`string`	No	-	-

Status.status.conditions[]¶

Field	Description	Type	Required	Default	Enum
`lastTransitionTime`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`reason`	-	`string`	No	-	-
`status`	-	`string`	Yes	-	-
`type`	-	`string`	Yes	-	-

Glossary¶

Glossary is the Schema for the glossaries API.

Plural: glossaries
Scope: Namespaced
APIVersion: datacatalog.oracle.com/v1beta1
Sample: Sample (config/samples/datacatalog_v1beta1_glossary.yaml)
Packages: Not currently exposed by a customer-visible package.

Spec¶

GlossarySpec defines the desired state of Glossary.

Field	Description	Type	Required	Default	Enum
`customPropertyMembers`	The list of customized properties along with the values for this object	`list[object]`	No	-	-
`description`	Detailed description of the glossary.	`string`	No	-	-
`displayName`	A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.	`string`	Yes	-	-
`owner`	OCID of the user who is the owner of the glossary.	`string`	No	-	-
`workflowStatus`	Status of the approval process workflow for this business glossary.	`string`	No	-	-

Spec.customPropertyMembers[]¶

Back to Glossary spec

GlossaryCustomPropertyMember defines nested fields for Glossary.CustomPropertyMember.

Field	Description	Type	Required	Default	Enum
`displayName`	Name of the custom property	`string`	No	-	-
`key`	Unique Identifier of the attribute which is ID	`string`	No	-	-
`namespaceName`	Namespace name of the custom property	`string`	No	-	-
`value`	The custom property value	`string`	No	-	-

Status¶

GlossaryStatus defines the observed state of Glossary.

Field	Description	Type	Required	Default	Enum
`catalogId`	The data catalog's OCID.	`string`	No	-	-
`createdById`	OCID of the user who created this metadata element.	`string`	No	-	-
`customPropertyMembers`	The list of customized properties along with the values for this object	`list[object]`	No	-	-
`description`	Detailed description of the glossary.	`string`	No	-	-
`displayName`	A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.	`string`	No	-	-
`importJobDefinitionKey`	The unique key of the job definition resource that was used in the Glossary import.	`string`	No	-	-
`importJobKey`	The unique key of the job policy for Glossary import.	`string`	No	-	-
`key`	Unique glossary key that is immutable.	`string`	No	-	-
`latestImportJobExecutionKey`	The unique key of the parent job execution for which the log resource was created.	`string`	No	-	-
`latestImportJobExecutionStatus`	Status of the latest glossary import job execution, such as running, paused, or completed. This may include additional information like time import started , import file size and % of completion	`string`	No	-	-
`lifecycleState`	The current state of the glossary.	`string`	No	-	-
`owner`	OCID of the user who is the owner of the glossary.	`string`	No	-	-
`status`	-	`object`	Yes	-	-
`timeCreated`	The date and time the glossary was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: `2019-03-25T21:10:29.600Z`	`string`	No	-	-
`timeUpdated`	The last time that any change was made to the glossary. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.	`string`	No	-	-
`updatedById`	OCID of the user who updated this metadata element.	`string`	No	-	-
`uri`	URI to the tag instance in the API.	`string`	No	-	-
`workflowStatus`	Status of the approval process workflow for this business glossary.	`string`	No	-	-

Status.customPropertyMembers[]¶

GlossaryCustomPropertyMember defines nested fields for Glossary.CustomPropertyMember.

Field	Description	Type	Required	Default	Enum
`displayName`	Name of the custom property	`string`	No	-	-
`key`	Unique Identifier of the attribute which is ID	`string`	No	-	-
`namespaceName`	Namespace name of the custom property	`string`	No	-	-
`value`	The custom property value	`string`	No	-	-

Status.status¶

Field	Description	Type	Required	Default	Enum
`async`	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	`object`	No	-	-
`conditions`	-	`list[object]`	No	-	-
`createdAt`	-	`string (date-time)`	No	-	-
`deletedAt`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`ocid`	-	`string`	No	-	-
`opcRequestId`	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	`string`	No	-	-
`reason`	-	`string`	No	-	-
`requestedAt`	-	`string (date-time)`	No	-	-
`updatedAt`	-	`string (date-time)`	No	-	-

Status.status.async¶

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field	Description	Type	Required	Default	Enum
`current`	-	`object`	No	-	-

Status.status.async.current¶

Field	Description	Type	Required	Default	Enum
`message`	-	`string`	No	-	-
`normalizedClass`	-	`string`	Yes	-	`attention`, `canceled`, `failed`, `pending`, `succeeded`, `unknown`
`percentComplete`	-	`number`	No	-	-
`phase`	-	`string`	Yes	-	`create`, `delete`, `update`
`rawOperationType`	-	`string`	No	-	-
`rawStatus`	-	`string`	No	-	-
`source`	-	`string`	Yes	-	`lifecycle`, `none`, `workrequest`
`updatedAt`	-	`string (date-time)`	Yes	-	-
`workRequestId`	-	`string`	No	-	-

Status.status.conditions[]¶

Field	Description	Type	Required	Default	Enum
`lastTransitionTime`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`reason`	-	`string`	No	-	-
`status`	-	`string`	Yes	-	-
`type`	-	`string`	Yes	-	-

Job¶

Job is the Schema for the jobs API.

Plural: jobs
Scope: Namespaced
APIVersion: datacatalog.oracle.com/v1beta1
Sample: Sample (config/samples/datacatalog_v1beta1_job.yaml)
Packages: Not currently exposed by a customer-visible package.

Spec¶

JobSpec defines the desired state of Job.

Field	Description	Type	Required	Default	Enum
`connectionKey`	The key of the connection used by the job. This connection will override the default connection specified in the associated job definition. All executions will use this connection.	`string`	No	-	-
`description`	Detailed description of the job.	`string`	No	-	-
`displayName`	A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.	`string`	Yes	-	-
`jobDefinitionKey`	The unique key of the job definition that defined the scope of this job.	`string`	Yes	-	-
`scheduleCronExpression`	Interval on which the job will be run. Value is specified as a cron-supported time specification "nickname". The following subset of those is supported: @monthly, @weekly, @daily, @hourly. For metastore sync, an additional option @default is supported, which will schedule jobs at a more granular frequency.	`string`	No	-	-
`timeScheduleBegin`	Date that the schedule should be operational. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.	`string`	No	-	-
`timeScheduleEnd`	Date that the schedule should end from being operational. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.	`string`	No	-	-

Status¶

JobStatus defines the observed state of Job.

Field	Description	Type	Required	Default	Enum
`catalogId`	The data catalog's OCID.	`string`	No	-	-
`connectionKey`	The key of the connection used by the job. This connection will override the default connection specified in the associated job definition. All executions will use this connection.	`string`	No	-	-
`createdById`	OCID of the user who created this job.	`string`	No	-	-
`dataAssetKey`	Unique key of the data asset to which this job applies, if the job involves a data asset.	`string`	No	-	-
`description`	Detailed description of the job.	`string`	No	-	-
`displayName`	A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.	`string`	No	-	-
`errorCode`	Error code returned from the latest job execution for this job. Useful when the latest Job execution is in FAILED state.	`string`	No	-	-
`errorMessage`	Error message returned from the latest job execution for this job. Useful when the latest Job Execution is in a FAILED state.	`string`	No	-	-
`executionCount`	The total number of executions for this job schedule.	`integer`	No	-	-
`executions`	Array of the executions summary associated with this job.	`list[object]`	No	-	-
`glossaryKey`	Unique key of the glossary to which this job applies.	`string`	No	-	-
`internalVersion`	Internal version of the job resource.	`string`	No	-	-
`jobDefinitionKey`	The unique key of the job definition resource that defined the scope of this job.	`string`	No	-	-
`jobDefinitionName`	The display name of the job definition resource that defined the scope of this job.	`string`	No	-	-
`jobType`	Type of the job.	`string`	No	-	-
`key`	Unique key of the job resource.	`string`	No	-	-
`lifecycleState`	Lifecycle state for job.	`string`	No	-	-
`scheduleCronExpression`	Interval on which the job will be run. Value is specified as a cron-supported time specification "nickname". The following subset of those is supported: @monthly, @weekly, @daily, @hourly. For metastore sync, an additional option @default is supported, which will schedule jobs at a more granular frequency.	`string`	No	-	-
`scheduleType`	Type of job schedule that is inferred from the scheduling properties.	`string`	No	-	-
`status`	-	`object`	Yes	-	-
`timeCreated`	The date and time the job was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: `2019-03-25T21:10:29.600Z`	`string`	No	-	-
`timeOfLatestExecution`	The date and time of the most recent execution for this Job, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: `2019-03-25T21:10:29.600Z`	`string`	No	-	-
`timeScheduleBegin`	Date that the schedule should be operational. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.	`string`	No	-	-
`timeScheduleEnd`	Date that the schedule should end from being operational. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.	`string`	No	-	-
`timeUpdated`	Time that this job was last updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.	`string`	No	-	-
`updatedById`	OCID of the user who updated this job.	`string`	No	-	-
`uri`	URI to the job instance in the API.	`string`	No	-	-

Status.executions[]¶

JobExecution defines nested fields for Job.Execution.

Field	Description	Type	Required	Default	Enum
`jobKey`	The unique key of the parent job.	`string`	No	-	-
`jobType`	Type of the job execution.	`string`	No	-	-
`key`	Unique key of the job execution resource.	`string`	No	-	-
`lifecycleState`	Status of the job execution, such as running, paused, or completed.	`string`	No	-	-
`parentKey`	The unique key of the parent execution or null if this job execution has no parent.	`string`	No	-	-
`scheduleInstanceKey`	The unique key of the triggering external scheduler resource or null if this job execution is not externally triggered.	`string`	No	-	-
`timeCreated`	The date and time the job execution was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: `2019-03-25T21:10:29.600Z`	`string`	No	-	-
`timeEnded`	Time that the job execution ended or null if it hasn't yet completed. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.	`string`	No	-	-
`timeStarted`	Time that job execution started. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.	`string`	No	-	-
`uri`	URI to the job execution instance in the API.	`string`	No	-	-

Status.status¶

Field	Description	Type	Required	Default	Enum
`async`	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	`object`	No	-	-
`conditions`	-	`list[object]`	No	-	-
`createdAt`	-	`string (date-time)`	No	-	-
`deletedAt`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`ocid`	-	`string`	No	-	-
`opcRequestId`	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	`string`	No	-	-
`reason`	-	`string`	No	-	-
`requestedAt`	-	`string (date-time)`	No	-	-
`updatedAt`	-	`string (date-time)`	No	-	-

Status.status.async¶

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field	Description	Type	Required	Default	Enum
`current`	-	`object`	No	-	-

Status.status.async.current¶

Field	Description	Type	Required	Default	Enum
`message`	-	`string`	No	-	-
`normalizedClass`	-	`string`	Yes	-	`attention`, `canceled`, `failed`, `pending`, `succeeded`, `unknown`
`percentComplete`	-	`number`	No	-	-
`phase`	-	`string`	Yes	-	`create`, `delete`, `update`
`rawOperationType`	-	`string`	No	-	-
`rawStatus`	-	`string`	No	-	-
`source`	-	`string`	Yes	-	`lifecycle`, `none`, `workrequest`
`updatedAt`	-	`string (date-time)`	Yes	-	-
`workRequestId`	-	`string`	No	-	-

Status.status.conditions[]¶

Field	Description	Type	Required	Default	Enum
`lastTransitionTime`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`reason`	-	`string`	No	-	-
`status`	-	`string`	Yes	-	-
`type`	-	`string`	Yes	-	-

JobDefinition¶

JobDefinition is the Schema for the jobdefinitions API.

Plural: jobdefinitions
Scope: Namespaced
APIVersion: datacatalog.oracle.com/v1beta1
Sample: Sample (config/samples/datacatalog_v1beta1_jobdefinition.yaml)
Packages: Not currently exposed by a customer-visible package.

Spec¶

JobDefinitionSpec defines the desired state of JobDefinition.

Field	Description	Type	Required	Default	Enum
`connectionKey`	The key of the connection resource to be used for the job.	`string`	No	-	-
`dataAssetKey`	The key of the data asset for which the job is defined.	`string`	No	-	-
`description`	Detailed description of the job definition.	`string`	No	-	-
`displayName`	A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.	`string`	Yes	-	-
`glossaryKey`	Unique key of the glossary to which this job applies.	`string`	No	-	-
`isIncremental`	Specifies if the job definition is incremental or full.	`boolean`	No	-	-
`isSampleDataExtracted`	Specify if sample data to be extracted as part of this harvest.	`boolean`	No	-	-
`jobType`	Type of the job definition.	`string`	Yes	-	-
`properties`	A map of maps that contains the properties which are specific to the job type. Each job type definition may define it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most job definitions have required properties within the "default" category. Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}`	`map[string, map[string, string]]`	No	-	-
`sampleDataSizeInMBs`	Specify the sample data size in MB, specified as number of rows, for this metadata harvest.	`integer`	No	-	-

Status¶

JobDefinitionStatus defines the observed state of JobDefinition.

Field	Description	Type	Required	Default	Enum
`catalogId`	The data catalog's OCID.	`string`	No	-	-
`connectionKey`	The key of the default connection resource to be used for harvest, sampling, profiling jobs. This may be overridden in each job instance.	`string`	No	-	-
`createdById`	OCID of the user who created this job definition.	`string`	No	-	-
`dataAssetKey`	The key of the data asset for which the job is defined.	`string`	No	-	-
`description`	Detailed description of the job definition.	`string`	No	-	-
`displayName`	A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.	`string`	No	-	-
`glossaryKey`	Unique key of the glossary to which this job applies.	`string`	No	-	-
`internalVersion`	Version of the job definition object. Used internally but can be visible to users.	`string`	No	-	-
`isIncremental`	Specifies if the job definition is incremental or full.	`boolean`	No	-	-
`isSampleDataExtracted`	Specify if sample data to be extracted as part of this harvest.	`boolean`	No	-	-
`jobExecutionState`	Status of the latest job execution, such as running, paused, or completed.	`string`	No	-	-
`jobType`	Type of the job definition.	`string`	No	-	-
`key`	Unique key of the job definition resource that is immutable.	`string`	No	-	-
`lifecycleState`	Lifecycle state of the job definition.	`string`	No	-	-
`properties`	A map of maps that contains the properties which are specific to the job type. Each job type definition may define it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most job definitions have required properties within the "default" category. Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}`	`map[string, map[string, string]]`	No	-	-
`sampleDataSizeInMBs`	Specify the sample data size in MB, specified as number of rows, for this metadata harvest.	`integer`	No	-	-
`scheduleType`	Type of job schedule for the latest job executed.	`string`	No	-	-
`status`	-	`object`	Yes	-	-
`timeCreated`	The date and time the job definition was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: `2019-03-25T21:10:29.600Z`	`string`	No	-	-
`timeLatestExecutionEnded`	Time that the latest job execution ended or null if it hasn't yet completed. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.	`string`	No	-	-
`timeLatestExecutionStarted`	Time that the latest job execution started. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.	`string`	No	-	-
`timeUpdated`	The last time that any change was made to the data asset. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.	`string`	No	-	-
`updatedById`	OCID of the user who updated this job definition.	`string`	No	-	-
`uri`	URI to the job definition instance in the API.	`string`	No	-	-

Status.status¶

Field	Description	Type	Required	Default	Enum
`async`	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	`object`	No	-	-
`conditions`	-	`list[object]`	No	-	-
`createdAt`	-	`string (date-time)`	No	-	-
`deletedAt`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`ocid`	-	`string`	No	-	-
`opcRequestId`	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	`string`	No	-	-
`reason`	-	`string`	No	-	-
`requestedAt`	-	`string (date-time)`	No	-	-
`updatedAt`	-	`string (date-time)`	No	-	-

Status.status.async¶

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field	Description	Type	Required	Default	Enum
`current`	-	`object`	No	-	-

Status.status.async.current¶

Field	Description	Type	Required	Default	Enum
`message`	-	`string`	No	-	-
`normalizedClass`	-	`string`	Yes	-	`attention`, `canceled`, `failed`, `pending`, `succeeded`, `unknown`
`percentComplete`	-	`number`	No	-	-
`phase`	-	`string`	Yes	-	`create`, `delete`, `update`
`rawOperationType`	-	`string`	No	-	-
`rawStatus`	-	`string`	No	-	-
`source`	-	`string`	Yes	-	`lifecycle`, `none`, `workrequest`
`updatedAt`	-	`string (date-time)`	Yes	-	-
`workRequestId`	-	`string`	No	-	-

Status.status.conditions[]¶

Field	Description	Type	Required	Default	Enum
`lastTransitionTime`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`reason`	-	`string`	No	-	-
`status`	-	`string`	Yes	-	-
`type`	-	`string`	Yes	-	-

Metastore¶

Metastore is the Schema for the metastores API.

Plural: metastores
Scope: Namespaced
APIVersion: datacatalog.oracle.com/v1beta1
Sample: Sample (config/samples/datacatalog_v1beta1_metastore.yaml)
Packages: Not currently exposed by a customer-visible package.

Spec¶

MetastoreSpec defines the desired state of Metastore.

Field	Description	Type	Required	Default	Enum
`compartmentId`	OCID of the compartment which holds the metastore.	`string`	Yes	-	-
`defaultExternalTableLocation`	Location under which external tables will be created by default. This references Object Storage using an HDFS URI format. Example: oci://bucket@namespace/sub-dir/	`string`	Yes	-	-
`defaultManagedTableLocation`	Location under which managed tables will be created by default. This references Object Storage using an HDFS URI format. Example: oci://bucket@namespace/sub-dir/	`string`	Yes	-	-
`definedTags`	Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}`	`map[string, map[string, string]]`	No	-	-
`displayName`	Mutable name of the metastore.	`string`	No	-	-
`freeformTags`	Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`	`map[string, string]`	No	-	-

Status¶

MetastoreStatus defines the observed state of Metastore.

Field	Description	Type	Required	Default	Enum
`compartmentId`	OCID of the compartment which holds the metastore.	`string`	No	-	-
`defaultExternalTableLocation`	Location under which external tables will be created by default. This references Object Storage using an HDFS URI format. Example: oci://bucket@namespace/sub-dir/	`string`	No	-	-
`defaultManagedTableLocation`	Location under which managed tables will be created by default. This references Object Storage using an HDFS URI format. Example: oci://bucket@namespace/sub-dir/	`string`	No	-	-
`definedTags`	Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}`	`map[string, map[string, string]]`	No	-	-
`displayName`	Mutable name of the metastore.	`string`	No	-	-
`freeformTags`	Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`	`map[string, string]`	No	-	-
`id`	The metastore's OCID.	`string`	No	-	-
`lifecycleDetails`	A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.	`string`	No	-	-
`lifecycleState`	The current state of the metastore.	`string`	No	-	-
`locks`	Locks associated with this resource.	`list[object]`	No	-	-
`status`	-	`object`	Yes	-	-
`systemTags`	System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`	`map[string, map[string, string]]`	No	-	-
`timeCreated`	Time at which the metastore was created. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.	`string`	No	-	-
`timeUpdated`	Time at which the metastore was last modified. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.	`string`	No	-	-

Status.locks[]¶

MetastoreLock defines nested fields for Metastore.Lock.

Field	Description	Type	Required	Default	Enum
`message`	A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.	`string`	No	-	-
`relatedResourceId`	The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.	`string`	No	-	-
`timeCreated`	When the lock was created.	`string`	No	-	-
`type`	Type of the lock.	`string`	No	-	-

Status.status¶

Field	Description	Type	Required	Default	Enum
`async`	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	`object`	No	-	-
`conditions`	-	`list[object]`	No	-	-
`createdAt`	-	`string (date-time)`	No	-	-
`deletedAt`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`ocid`	-	`string`	No	-	-
`opcRequestId`	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	`string`	No	-	-
`reason`	-	`string`	No	-	-
`requestedAt`	-	`string (date-time)`	No	-	-
`updatedAt`	-	`string (date-time)`	No	-	-

Status.status.async¶

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field	Description	Type	Required	Default	Enum
`current`	-	`object`	No	-	-

Status.status.async.current¶

Field	Description	Type	Required	Default	Enum
`message`	-	`string`	No	-	-
`normalizedClass`	-	`string`	Yes	-	`attention`, `canceled`, `failed`, `pending`, `succeeded`, `unknown`
`percentComplete`	-	`number`	No	-	-
`phase`	-	`string`	Yes	-	`create`, `delete`, `update`
`rawOperationType`	-	`string`	No	-	-
`rawStatus`	-	`string`	No	-	-
`source`	-	`string`	Yes	-	`lifecycle`, `none`, `workrequest`
`updatedAt`	-	`string (date-time)`	Yes	-	-
`workRequestId`	-	`string`	No	-	-

Status.status.conditions[]¶

Field	Description	Type	Required	Default	Enum
`lastTransitionTime`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`reason`	-	`string`	No	-	-
`status`	-	`string`	Yes	-	-
`type`	-	`string`	Yes	-	-

Namespace¶

Namespace is the Schema for the namespaces API.

Plural: namespaces
Scope: Namespaced
APIVersion: datacatalog.oracle.com/v1beta1
Sample: Sample (config/samples/datacatalog_v1beta1_namespace.yaml)
Packages: Not currently exposed by a customer-visible package.

Spec¶

NamespaceSpec defines the desired state of Namespace.

Field	Description	Type	Required	Default	Enum
`description`	Detailed description of the Namespace.	`string`	No	-	-
`displayName`	A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.	`string`	Yes	-	-
`isServiceDefined`	If this field is defined by service or by a user	`boolean`	No	-	-

Status¶

NamespaceStatus defines the observed state of Namespace.

Field	Description	Type	Required	Default	Enum
`createdById`	OCID of the user who created the namespace.	`string`	No	-	-
`description`	Description for the namespace	`string`	No	-	-
`displayName`	Name of the Namespace	`string`	No	-	-
`isServiceDefined`	If this field is defined by service or by a user	`boolean`	No	-	-
`key`	Unique namespace key that is immutable.	`string`	No	-	-
`lifecycleState`	The current state of the namespace.	`string`	No	-	-
`status`	-	`object`	Yes	-	-
`timeCreated`	The date and time the namespace was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: `2019-03-25T21:10:29.600Z`	`string`	No	-	-
`timeUpdated`	The last time that any change was made to the namespace. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.	`string`	No	-	-
`updatedById`	OCID of the user who last modified the namespace.	`string`	No	-	-

Status.status¶

Field	Description	Type	Required	Default	Enum
`async`	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	`object`	No	-	-
`conditions`	-	`list[object]`	No	-	-
`createdAt`	-	`string (date-time)`	No	-	-
`deletedAt`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`ocid`	-	`string`	No	-	-
`opcRequestId`	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	`string`	No	-	-
`reason`	-	`string`	No	-	-
`requestedAt`	-	`string (date-time)`	No	-	-
`updatedAt`	-	`string (date-time)`	No	-	-

Status.status.async¶

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field	Description	Type	Required	Default	Enum
`current`	-	`object`	No	-	-

Status.status.async.current¶

Field	Description	Type	Required	Default	Enum
`message`	-	`string`	No	-	-
`normalizedClass`	-	`string`	Yes	-	`attention`, `canceled`, `failed`, `pending`, `succeeded`, `unknown`
`percentComplete`	-	`number`	No	-	-
`phase`	-	`string`	Yes	-	`create`, `delete`, `update`
`rawOperationType`	-	`string`	No	-	-
`rawStatus`	-	`string`	No	-	-
`source`	-	`string`	Yes	-	`lifecycle`, `none`, `workrequest`
`updatedAt`	-	`string (date-time)`	Yes	-	-
`workRequestId`	-	`string`	No	-	-

Status.status.conditions[]¶

Field	Description	Type	Required	Default	Enum
`lastTransitionTime`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`reason`	-	`string`	No	-	-
`status`	-	`string`	Yes	-	-
`type`	-	`string`	Yes	-	-

Pattern¶

Pattern is the Schema for the patterns API.

Plural: patterns
Scope: Namespaced
APIVersion: datacatalog.oracle.com/v1beta1
Sample: Sample (config/samples/datacatalog_v1beta1_pattern.yaml)
Packages: Not currently exposed by a customer-visible package.

Spec¶

PatternSpec defines the desired state of Pattern.

Field	Description	Type	Required	Default	Enum
`checkFailureLimit`	The maximum number of UNMATCHED files, in checkFilePathList, above which the check fails. Optional, if checkFilePathList is provided - but if isEnableCheckFailureLimit is set to true it is required.	`integer`	No	-	-
`checkFilePathList`	List of file paths against which the pattern can be tried, as a check. This documents, for reference purposes, some example objects a pattern is meant to work with. If isEnableCheckFailureLimit is set to true, this will be run as a validation during the request, such that if the check fails the request fails. If isEnableCheckFailureLimit instead is set to (the default) false, a pattern will still be created or updated even if the check fails, with a lifecycleState of FAILED.	`list[string]`	No	-	-
`description`	Detailed description of the Pattern.	`string`	No	-	-
`displayName`	A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.	`string`	Yes	-	-
`expression`	Input string which drives the selection process, allowing for fine-grained control using qualifiers. Refer to the user documentation for details of the format and examples. A pattern cannot include both a prefix and an expression.	`string`	No	-	-
`filePathPrefix`	Input string which drives the selection process. Refer to the user documentation for details of the format and examples. A pattern cannot include both a prefix and an expression.	`string`	No	-	-
`isEnableCheckFailureLimit`	Indicates whether the pattern check, against the checkFilePathList, will fail the request if the count of UNMATCHED files is above the checkFailureLimit.	`boolean`	No	-	-
`properties`	A map of maps that contains the properties which are specific to the pattern type. Each pattern type definition defines it's set of required and optional properties. Example: `{"properties": { "default": { "tbd"}}}`	`map[string, map[string, string]]`	No	-	-

Status¶

PatternStatus defines the observed state of Pattern.

Field	Description	Type	Required	Default	Enum
`catalogId`	The data catalog's OCID.	`string`	No	-	-
`checkFailureLimit`	The maximum number of UNMATCHED files, in checkFilePathList, above which the check fails. Optional, if checkFilePathList is provided - but if isEnableCheckFailureLimit is set to true it is required.	`integer`	No	-	-
`checkFilePathList`	List of file paths against which the pattern can be tried, as a check. This documents, for reference purposes, some example objects a pattern is meant to work with. If isEnableCheckFailureLimit is set to true, this will be run as a validation during the request, such that if the check fails the request fails. If isEnableCheckFailureLimit instead is set to (the default) false, a pattern will still be created or updated even if the check fails, with a lifecycleState of FAILED.	`list[string]`	No	-	-
`createdById`	OCID of the user who created the pattern.	`string`	No	-	-
`description`	Detailed description of the pattern.	`string`	No	-	-
`displayName`	A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.	`string`	No	-	-
`expression`	Input string which drives the selection process, allowing for fine-grained control using qualifiers. Refer to the user documentation for details of the format and examples. A pattern cannot include both a prefix and an expression.	`string`	No	-	-
`filePathPrefix`	Input string which drives the selection process. Refer to the user documentation for details of the format and examples. A pattern cannot include both a prefix and an expression.	`string`	No	-	-
`isEnableCheckFailureLimit`	Indicates whether the pattern check, against the checkFilePathList, will fail the request if the count of UNMATCHED files is above the checkFailureLimit.	`boolean`	No	-	-
`key`	Unique pattern key that is immutable.	`string`	No	-	-
`lifecycleState`	The current state of the pattern.	`string`	No	-	-
`properties`	A map of maps that contains the properties which are specific to the pattern type. Each pattern type definition defines it's set of required and optional properties. Example: `{"properties": { "default": { "tbd"}}}`	`map[string, map[string, string]]`	No	-	-
`status`	-	`object`	Yes	-	-
`timeCreated`	The date and time the pattern was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: `2019-03-25T21:10:29.600Z`	`string`	No	-	-
`timeUpdated`	The last time that any change was made to the pattern. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.	`string`	No	-	-
`updatedById`	OCID of the user who last modified the pattern.	`string`	No	-	-

Status.status¶

Field	Description	Type	Required	Default	Enum
`async`	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	`object`	No	-	-
`conditions`	-	`list[object]`	No	-	-
`createdAt`	-	`string (date-time)`	No	-	-
`deletedAt`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`ocid`	-	`string`	No	-	-
`opcRequestId`	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	`string`	No	-	-
`reason`	-	`string`	No	-	-
`requestedAt`	-	`string (date-time)`	No	-	-
`updatedAt`	-	`string (date-time)`	No	-	-

Status.status.async¶

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field	Description	Type	Required	Default	Enum
`current`	-	`object`	No	-	-

Status.status.async.current¶

Field	Description	Type	Required	Default	Enum
`message`	-	`string`	No	-	-
`normalizedClass`	-	`string`	Yes	-	`attention`, `canceled`, `failed`, `pending`, `succeeded`, `unknown`
`percentComplete`	-	`number`	No	-	-
`phase`	-	`string`	Yes	-	`create`, `delete`, `update`
`rawOperationType`	-	`string`	No	-	-
`rawStatus`	-	`string`	No	-	-
`source`	-	`string`	Yes	-	`lifecycle`, `none`, `workrequest`
`updatedAt`	-	`string (date-time)`	Yes	-	-
`workRequestId`	-	`string`	No	-	-

Status.status.conditions[]¶

Field	Description	Type	Required	Default	Enum
`lastTransitionTime`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`reason`	-	`string`	No	-	-
`status`	-	`string`	Yes	-	-
`type`	-	`string`	Yes	-	-

Term¶

Term is the Schema for the terms API.

Plural: terms
Scope: Namespaced
APIVersion: datacatalog.oracle.com/v1beta1
Sample: Sample (config/samples/datacatalog_v1beta1_term.yaml)
Packages: Not currently exposed by a customer-visible package.

Spec¶

TermSpec defines the desired state of Term.

Field	Description	Type	Required	Default	Enum
`customPropertyMembers`	The list of customized properties along with the values for this object	`list[object]`	No	-	-
`description`	Detailed description of the term.	`string`	No	-	-
`displayName`	A user-friendly display name. Is changeable. The combination of 'displayName' and 'parentTermKey' must be unique. Avoid entering confidential information.	`string`	Yes	-	-
`isAllowedToHaveChildTerms`	Indicates whether a term may contain child terms.	`boolean`	No	-	-
`owner`	OCID of the user who is the owner of this business terminology.	`string`	No	-	-
`parentTermKey`	The parent key of the term. In the case of a root-level category only, the term would have no parent and this should be left unset.	`string`	No	-	-
`workflowStatus`	Status of the approval process workflow for this business term in the glossary.	`string`	No	-	-

Spec.customPropertyMembers[]¶

Back to Term spec

TermCustomPropertyMember defines nested fields for Term.CustomPropertyMember.

Field	Description	Type	Required	Default	Enum
`displayName`	Name of the custom property	`string`	No	-	-
`key`	Unique Identifier of the attribute which is ID	`string`	No	-	-
`namespaceName`	Namespace name of the custom property	`string`	No	-	-
`value`	The custom property value	`string`	No	-	-

Status¶

TermStatus defines the observed state of Term.

Field	Description	Type	Required	Default	Enum
`associatedObjectCount`	The number of objects tagged with this term	`integer`	No	-	-
`associatedObjects`	Array of objects associated to a term.	`list[object]`	No	-	-
`createdById`	OCID of the user who created the term.	`string`	No	-	-
`customPropertyMembers`	The list of customized properties along with the values for this object	`list[object]`	No	-	-
`description`	Detailed description of the term.	`string`	No	-	-
`displayName`	A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.	`string`	No	-	-
`glossaryKey`	Unique id of the parent glossary.	`string`	No	-	-
`isAllowedToHaveChildTerms`	Indicates whether a term may contain child terms.	`boolean`	No	-	-
`key`	Unique term key that is immutable.	`string`	No	-	-
`lifecycleState`	The current state of the term.	`string`	No	-	-
`owner`	OCID of the user who is the owner of this business terminology.	`string`	No	-	-
`parentTermKey`	This terms parent term key. Will be null if the term has no parent term.	`string`	No	-	-
`path`	Absolute path of the term.	`string`	No	-	-
`status`	-	`object`	Yes	-	-
`timeCreated`	The date and time the term was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: `2019-03-25T21:10:29.600Z`	`string`	No	-	-
`timeUpdated`	The last time that any change was made to the term. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.	`string`	No	-	-
`updatedById`	OCID of the user who modified the term.	`string`	No	-	-
`uri`	URI to the term instance in the API.	`string`	No	-	-
`workflowStatus`	Status of the approval process workflow for this business term in the glossary.	`string`	No	-	-

Status.associatedObjects[]¶

TermAssociatedObject defines nested fields for Term.AssociatedObject.

Field	Description	Type	Required	Default	Enum
`key`	Immutable key used to uniquely identify the associated object.	`string`	No	-	-
`name`	Name of the associated object.	`string`	No	-	-
`uri`	URI of the associated object within the data catalog API.	`string`	No	-	-

Status.customPropertyMembers[]¶

TermCustomPropertyMember defines nested fields for Term.CustomPropertyMember.

Field	Description	Type	Required	Default	Enum
`displayName`	Name of the custom property	`string`	No	-	-
`key`	Unique Identifier of the attribute which is ID	`string`	No	-	-
`namespaceName`	Namespace name of the custom property	`string`	No	-	-
`value`	The custom property value	`string`	No	-	-

Status.status¶

Field	Description	Type	Required	Default	Enum
`async`	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	`object`	No	-	-
`conditions`	-	`list[object]`	No	-	-
`createdAt`	-	`string (date-time)`	No	-	-
`deletedAt`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`ocid`	-	`string`	No	-	-
`opcRequestId`	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	`string`	No	-	-
`reason`	-	`string`	No	-	-
`requestedAt`	-	`string (date-time)`	No	-	-
`updatedAt`	-	`string (date-time)`	No	-	-

Status.status.async¶

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field	Description	Type	Required	Default	Enum
`current`	-	`object`	No	-	-

Status.status.async.current¶

Field	Description	Type	Required	Default	Enum
`message`	-	`string`	No	-	-
`normalizedClass`	-	`string`	Yes	-	`attention`, `canceled`, `failed`, `pending`, `succeeded`, `unknown`
`percentComplete`	-	`number`	No	-	-
`phase`	-	`string`	Yes	-	`create`, `delete`, `update`
`rawOperationType`	-	`string`	No	-	-
`rawStatus`	-	`string`	No	-	-
`source`	-	`string`	Yes	-	`lifecycle`, `none`, `workrequest`
`updatedAt`	-	`string (date-time)`	Yes	-	-
`workRequestId`	-	`string`	No	-	-

Status.status.conditions[]¶

Field	Description	Type	Required	Default	Enum
`lastTransitionTime`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`reason`	-	`string`	No	-	-
`status`	-	`string`	Yes	-	-
`type`	-	`string`	Yes	-	-

TermRelationship¶

TermRelationship is the Schema for the termrelationships API.

Plural: termrelationships
Scope: Namespaced
APIVersion: datacatalog.oracle.com/v1beta1
Sample: Sample (config/samples/datacatalog_v1beta1_termrelationship.yaml)
Packages: Not currently exposed by a customer-visible package.

Spec¶

TermRelationshipSpec defines the desired state of TermRelationship.

Field	Description	Type	Required	Default	Enum
`description`	Detailed description of the term relationship usually defined at the time of creation.	`string`	No	-	-
`displayName`	A user-friendly display name. Is changeable. The combination of 'displayName' and 'parentTermKey' must be unique. Avoid entering confidential information. This is the same as 'relationshipType' for 'termRelationship'.	`string`	Yes	-	-
`relatedTermKey`	Unique id of the related term.	`string`	Yes	-	-

Status¶

TermRelationshipStatus defines the observed state of TermRelationship.

Field	Description	Type	Required	Default	Enum
`description`	Detailed description of the term relationship usually defined at the time of creation.	`string`	No	-	-
`displayName`	A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.This is the same as relationshipType for termRelationship	`string`	No	-	-
`key`	Unique term relationship key that is immutable.	`string`	No	-	-
`lifecycleState`	State of the term relationship.	`string`	No	-	-
`parentTermDescription`	Description of the parent term.	`string`	No	-	-
`parentTermDisplayName`	Name of the parent term.	`string`	No	-	-
`parentTermGlossaryKey`	Glossary key of the parent term.	`string`	No	-	-
`parentTermKey`	This relationships parent term key.	`string`	No	-	-
`parentTermPath`	Full path of the parent term.	`string`	No	-	-
`relatedTermDescription`	Description of the related term.	`string`	No	-	-
`relatedTermDisplayName`	Name of the related term.	`string`	No	-	-
`relatedTermGlossaryKey`	Glossary key of the related term.	`string`	No	-	-
`relatedTermKey`	Unique id of the related term.	`string`	No	-	-
`relatedTermPath`	Full path of the related term.	`string`	No	-	-
`status`	-	`object`	Yes	-	-
`timeCreated`	The date and time the term relationship was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: `2019-03-25T21:10:29.600Z`	`string`	No	-	-
`uri`	URI to the term relationship instance in the API.	`string`	No	-	-

Status.status¶

Field	Description	Type	Required	Default	Enum
`async`	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	`object`	No	-	-
`conditions`	-	`list[object]`	No	-	-
`createdAt`	-	`string (date-time)`	No	-	-
`deletedAt`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`ocid`	-	`string`	No	-	-
`opcRequestId`	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	`string`	No	-	-
`reason`	-	`string`	No	-	-
`requestedAt`	-	`string (date-time)`	No	-	-
`updatedAt`	-	`string (date-time)`	No	-	-

Status.status.async¶

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field	Description	Type	Required	Default	Enum
`current`	-	`object`	No	-	-

Status.status.async.current¶

Field	Description	Type	Required	Default	Enum
`message`	-	`string`	No	-	-
`normalizedClass`	-	`string`	Yes	-	`attention`, `canceled`, `failed`, `pending`, `succeeded`, `unknown`
`percentComplete`	-	`number`	No	-	-
`phase`	-	`string`	Yes	-	`create`, `delete`, `update`
`rawOperationType`	-	`string`	No	-	-
`rawStatus`	-	`string`	No	-	-
`source`	-	`string`	Yes	-	`lifecycle`, `none`, `workrequest`
`updatedAt`	-	`string (date-time)`	Yes	-	-
`workRequestId`	-	`string`	No	-	-

Status.status.conditions[]¶