Skip to content

dataintegration.oracle.com/v1beta1

Back to API Reference

APIVersion: dataintegration.oracle.com/v1beta1

This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.

Packages

No customer-visible package currently exposes dataintegration.oracle.com/v1beta1.

Resources

Kind Scope Sample Packages
Application Namespaced Sample -
ApplicationDetailedDescription Namespaced Sample -
Connection Namespaced Sample -
ConnectionValidation Namespaced Sample -
CopyObjectRequest Namespaced Sample -
DataAsset Namespaced Sample -
DataFlow Namespaced Sample -
DataFlowValidation Namespaced Sample -
DisApplication Namespaced Sample -
DisApplicationDetailedDescription Namespaced Sample -
ExportRequest Namespaced Sample -
ExternalPublication Namespaced Sample -
ExternalPublicationValidation Namespaced Sample -
Folder Namespaced Sample -
FunctionLibrary Namespaced Sample -
ImportRequest Namespaced Sample -
Patch Namespaced Sample -
Pipeline Namespaced Sample -
PipelineValidation Namespaced Sample -
Project Namespaced Sample -
Schedule Namespaced Sample -
Task Namespaced Sample -
TaskRun Namespaced Sample -
TaskSchedule Namespaced Sample -
TaskValidation Namespaced Sample -
UserDefinedFunction Namespaced Sample -
UserDefinedFunctionValidation Namespaced Sample -
Workspace Namespaced Sample -

Application

Application is the Schema for the applications API.

  • Plural: applications
  • Scope: Namespaced
  • APIVersion: dataintegration.oracle.com/v1beta1
  • Sample: Sample (config/samples/dataintegration_v1beta1_application.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

ApplicationSpec defines the desired state of Application.

Field Description Type Required Default Enum
applicationVersion version integer No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
description Detailed description for the object. string No - -
displayName Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
freeformTags Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string Yes - -
key Currently not used on application creation. Reserved for future. string No - -
lifecycleState The current state of the workspace. string No - -
metadata ApplicationMetadata defines nested fields for Application.Metadata. object No - -
modelType The type of the application. string No - -
modelVersion The object's model version. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string Yes - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer Yes - -
parentRef ApplicationParentRef defines nested fields for Application.ParentRef. object No - -
registryMetadata ApplicationRegistryMetadata defines nested fields for Application.RegistryMetadata. object No - -
sourceApplicationInfo ApplicationSourceApplicationInfo defines nested fields for Application.SourceApplicationInfo. object No - -

Spec.metadata

Back to Application spec

ApplicationMetadata defines nested fields for Application.Metadata.

Field Description Type Required Default Enum
aggregator ApplicationMetadataAggregator defines nested fields for Application.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ApplicationMetadataCountStatistics defines nested fields for Application.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Spec.metadata.aggregator

Back to Application spec

ApplicationMetadataAggregator defines nested fields for Application.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Spec.metadata.countStatistics

Back to Application spec

ApplicationMetadataCountStatistics defines nested fields for Application.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Spec.metadata.countStatistics.objectTypeCountList[]

Back to Application spec

ApplicationMetadataCountStatisticsObjectTypeCountList defines nested fields for Application.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Spec.parentRef

Back to Application spec

ApplicationParentRef defines nested fields for Application.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.registryMetadata

Back to Application spec

ApplicationRegistryMetadata defines nested fields for Application.RegistryMetadata.

Field Description Type Required Default Enum
aggregatorKey The owning object's key for this object. string No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
key The identifying key for the object. string No - -
labels Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version. integer No - -

Spec.sourceApplicationInfo

Back to Application spec

ApplicationSourceApplicationInfo defines nested fields for Application.SourceApplicationInfo.

Field Description Type Required Default Enum
applicationKey The source application key to use when creating the application. string No - -
copyType Parameter to specify the link between SOURCE and TARGET application after copying. CONNECTED - Indicate that TARGET application is conneced to SOURCE and can be synced after copy. DISCONNECTED - Indicate that TARGET application is not conneced to SOURCE and can evolve independently. string No - -
workspaceId The OCID of the workspace containing the application. This allows cross workspace deployment to publish an application from a different workspace into the current workspace specified in this operation. string No - -

Status

ApplicationStatus defines the observed state of Application.

Field Description Type Required Default Enum
applicationVersion The application's version. integer No - -
compartmentId OCID of the compartment that this resource belongs to. Defaults to compartment of the Workspace. 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 - -
dependentObjectMetadata A list of dependent objects in this patch. list[object] No - -
description Detailed description for the object. string No - -
displayName Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. 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 resource that is used to uniquely identify the application string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
key Generated key that can be used in API calls to identify application. string No - -
keyMap A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. map[string, string] No - -
lifecycleState The current state of the workspace. string No - -
metadata ApplicationMetadata defines nested fields for Application.Metadata. object No - -
modelType The object type. string No - -
modelVersion The object's model version. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef ApplicationParentRef defines nested fields for Application.ParentRef. object No - -
publishedObjectMetadata A list of objects that are published or unpublished in this patch. map[string, object] No - -
sourceApplicationInfo ApplicationSourceApplicationInfo defines nested fields for Application.SourceApplicationInfo. object No - -
status - object Yes - -
timeCreated The date and time the application was created, in the timestamp format defined by RFC3339. string No - -
timePatched The date and time the application was patched, in the timestamp format defined by RFC3339. string No - -
timeUpdated The date and time the application was updated, in the timestamp format defined by RFC3339. example: 2019-08-25T21:10:29.41Z string No - -

Status.dependentObjectMetadata[]

Back to Application status

ApplicationDependentObjectMetadata defines nested fields for Application.DependentObjectMetadata.

Field Description Type Required Default Enum
action The patch action indicating if object was created, updated, or deleted. string No - -
identifier Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
key The key of the object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
namePath The fully qualified path of the published object, which would include its project and folder. string No - -
objectVersion The object version. integer No - -
type The type of the object in patch. string No - -

Status.metadata

Back to Application status

ApplicationMetadata defines nested fields for Application.Metadata.

Field Description Type Required Default Enum
aggregator ApplicationMetadataAggregator defines nested fields for Application.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ApplicationMetadataCountStatistics defines nested fields for Application.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.metadata.aggregator

Back to Application status

ApplicationMetadataAggregator defines nested fields for Application.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.metadata.countStatistics

Back to Application status

ApplicationMetadataCountStatistics defines nested fields for Application.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Status.metadata.countStatistics.objectTypeCountList[]

Back to Application status

ApplicationMetadataCountStatisticsObjectTypeCountList defines nested fields for Application.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.parentRef

Back to Application status

ApplicationParentRef defines nested fields for Application.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.publishedObjectMetadata{}

Back to Application status

ApplicationPublishedObjectMetadata defines nested fields for Application.PublishedObjectMetadata.

Field Description Type Required Default Enum
action The patch action indicating if object was created, updated, or deleted. string No - -
identifier Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
key The key of the object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
namePath The fully qualified path of the published object, which would include its project and folder. string No - -
objectVersion The object version. integer No - -
type The type of the object in patch. string No - -

Status.sourceApplicationInfo

Back to Application status

ApplicationSourceApplicationInfo defines nested fields for Application.SourceApplicationInfo.

Field Description Type Required Default Enum
applicationKey The source application key to use when creating the application. string No - -
copyType Parameter to specify the link between SOURCE and TARGET application after copying. CONNECTED - Indicate that TARGET application is conneced to SOURCE and can be synced after copy. DISCONNECTED - Indicate that TARGET application is not conneced to SOURCE and can evolve independently. string No - -
workspaceId The OCID of the workspace containing the application. This allows cross workspace deployment to publish an application from a different workspace into the current workspace specified in this operation. string No - -

Status.status

Back to Application 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

Back to Application status

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

Back to Application status

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[]

Back to Application status

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

ApplicationDetailedDescription

ApplicationDetailedDescription is the Schema for the applicationdetaileddescriptions API.

  • Plural: applicationdetaileddescriptions
  • Scope: Namespaced
  • APIVersion: dataintegration.oracle.com/v1beta1
  • Sample: Sample (config/samples/dataintegration_v1beta1_applicationdetaileddescription.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

ApplicationDetailedDescriptionSpec defines the desired state of ApplicationDetailedDescription.

Field Description Type Required Default Enum
detailedDescription Base64 encoded rich text description of the object. string No - -
logo Base64 encoded image to represent logo of the object. string No - -

Status

ApplicationDetailedDescriptionStatus defines the observed state of ApplicationDetailedDescription.

Field Description Type Required Default Enum
status - object Yes - -

Status.status

Back to ApplicationDetailedDescription 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

Back to ApplicationDetailedDescription status

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

Back to ApplicationDetailedDescription status

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[]

Back to ApplicationDetailedDescription status

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: dataintegration.oracle.com/v1beta1
  • Sample: Sample (config/samples/dataintegration_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
accessKey ConnectionAccessKey defines nested fields for Connection.AccessKey. object No - -
accessTokenUrl Specifies the endpoint used to exchange authentication credentials for access tokens string No - -
authHeader Optional header name if used other than default header(Authorization). string No - -
clientId Specifies the client ID key for specific application string No - -
clientSecret ConnectionClientSecret defines nested fields for Connection.ClientSecret. object No - -
connectionProperties The properties for the connection. list[object] No - -
credentialFileContent The credential file content from an Oracle Object Storage wallet. string No - -
dataNodePrincipal The HDFS Data Node principal. string No - -
defaultExternalStorage ConnectionDefaultExternalStorage defines nested fields for Connection.DefaultExternalStorage. object No - -
description User-defined description for the connection. string No - -
fingerPrint The fingerprint for the user. string No - -
grantType Specifies the OAuth2 grant mechanism. Example CLIENT_CREDENTIALS, Implicit Flow etc. string No - -
hdfsPrincipal The HDFS principal. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string Yes - -
jsonData - string No - -
key Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create. string No - -
keyDistributionCenter The HDFS Key Distribution Center. string No - -
keyTabContent ConnectionKeyTabContent defines nested fields for Connection.KeyTabContent. object No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string Yes - -
nameNodePrincipal The HDFS Name Node principal. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer Yes - -
parentRef ConnectionParentRef defines nested fields for Connection.ParentRef. object No - -
passPhrase The passphrase for the connection. string No - -
password The password for the connection. string No - -
passwordSecret ConnectionPasswordSecret defines nested fields for Connection.PasswordSecret. object No - -
realm HDFS Realm name. string No - -
registryMetadata ConnectionRegistryMetadata defines nested fields for Connection.RegistryMetadata. object No - -
scope Specifies the OAuth scopes that limit the permissions granted by an access token. string No - -
secretKey ConnectionSecretKey defines nested fields for Connection.SecretKey. object No - -
tnsAlias The Autonomous Transaction Processing instance service name. string No - -
tnsNames Array of service names that are available for selection in the tnsAlias property. list[string] No - -
userId The OCI user OCID for the user to connect to. string No - -
username The user name for the connection. string No - -

Spec.accessKey

Back to Connection spec

ConnectionAccessKey defines nested fields for Connection.AccessKey.

Field Description Type Required Default Enum
secretConfig ConnectionAccessKeySecretConfig defines nested fields for Connection.AccessKey.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.accessKey.secretConfig

Back to Connection spec

ConnectionAccessKeySecretConfig defines nested fields for Connection.AccessKey.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.clientSecret

Back to Connection spec

ConnectionClientSecret defines nested fields for Connection.ClientSecret.

Field Description Type Required Default Enum
secretConfig ConnectionClientSecretSecretConfig defines nested fields for Connection.ClientSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.clientSecret.secretConfig

Back to Connection spec

ConnectionClientSecretSecretConfig defines nested fields for Connection.ClientSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.connectionProperties[]

Back to Connection spec

ConnectionProperty defines nested fields for Connection.ConnectionProperty.

Field Description Type Required Default Enum
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
value The value for the connection name property. string No - -

Spec.defaultExternalStorage

Back to Connection spec

ConnectionDefaultExternalStorage defines nested fields for Connection.DefaultExternalStorage.

Field Description Type Required Default Enum
bucket Bucket Name where BICC extracts stores the files string No - -
host Object Storage host Url. DO not give http/https. string No - -
namespace Namespace for the OOS bucket string No - -
storageId Id of the external stoarge configured in BICC console. Usually its numeric. string No - -
storageName Name of the external storage configured in BICC console string No - -
tenancyId Tenancy OCID for the OOS bucket string No - -

Spec.keyTabContent

Back to Connection spec

ConnectionKeyTabContent defines nested fields for Connection.KeyTabContent.

Field Description Type Required Default Enum
secretConfig ConnectionKeyTabContentSecretConfig defines nested fields for Connection.KeyTabContent.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.keyTabContent.secretConfig

Back to Connection spec

ConnectionKeyTabContentSecretConfig defines nested fields for Connection.KeyTabContent.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.parentRef

Back to Connection spec

ConnectionParentRef defines nested fields for Connection.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.passwordSecret

Back to Connection spec

ConnectionPasswordSecret defines nested fields for Connection.PasswordSecret.

Field Description Type Required Default Enum
secretConfig ConnectionPasswordSecretSecretConfig defines nested fields for Connection.PasswordSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.passwordSecret.secretConfig

Back to Connection spec

ConnectionPasswordSecretSecretConfig defines nested fields for Connection.PasswordSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.registryMetadata

Back to Connection spec

ConnectionRegistryMetadata defines nested fields for Connection.RegistryMetadata.

Field Description Type Required Default Enum
aggregatorKey The owning object's key for this object. string No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
key The identifying key for the object. string No - -
labels Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version. integer No - -

Spec.secretKey

Back to Connection spec

ConnectionSecretKey defines nested fields for Connection.SecretKey.

Field Description Type Required Default Enum
secretConfig ConnectionSecretKeySecretConfig defines nested fields for Connection.SecretKey.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.secretKey.secretConfig

Back to Connection spec

ConnectionSecretKeySecretConfig defines nested fields for Connection.SecretKey.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Status

ConnectionStatus defines the observed state of Connection.

Field Description Type Required Default Enum
accessKey ConnectionAccessKey defines nested fields for Connection.AccessKey. object No - -
accessTokenUrl Specifies the endpoint used to exchange authentication credentials for access tokens string No - -
authHeader Optional header name if used other than default header(Authorization). string No - -
clientId Specifies the client ID key for specific application string No - -
clientSecret ConnectionClientSecret defines nested fields for Connection.ClientSecret. object No - -
connectionProperties The properties for the connection. list[object] No - -
credentialFileContent The credential file content from an Oracle Object Storage wallet. string No - -
dataNodePrincipal The HDFS Data Node principal. string No - -
defaultExternalStorage ConnectionDefaultExternalStorage defines nested fields for Connection.DefaultExternalStorage. object No - -
description User-defined description for the connection. string No - -
fingerPrint The fingerprint for the user. string No - -
grantType Specifies the OAuth2 grant mechanism. Example CLIENT_CREDENTIALS, Implicit Flow etc. string No - -
hdfsPrincipal The HDFS principal. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isDefault The default property for the connection. boolean No - -
jsonData - string No - -
key Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create. string No - -
keyDistributionCenter The HDFS Key Distribution Center. string No - -
keyMap A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. map[string, string] No - -
keyTabContent ConnectionKeyTabContent defines nested fields for Connection.KeyTabContent. object No - -
metadata ConnectionMetadata defines nested fields for Connection.Metadata. object No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
nameNodePrincipal The HDFS Name Node principal. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef ConnectionParentRef defines nested fields for Connection.ParentRef. object No - -
passPhrase The passphrase for the connection. string No - -
passwordSecret ConnectionPasswordSecret defines nested fields for Connection.PasswordSecret. object No - -
primarySchema ConnectionPrimarySchema defines nested fields for Connection.PrimarySchema. object No - -
realm HDFS Realm name. string No - -
scope Specifies the OAuth scopes that limit the permissions granted by an access token. string No - -
secretKey ConnectionSecretKey defines nested fields for Connection.SecretKey. object No - -
status - object Yes - -
tnsAlias The Autonomous Data Warehouse instance service name. string No - -
tnsNames Array of service names that are available for selection in the tnsAlias property. list[string] No - -
userId The OCI user OCID for the user to connect to. string No - -
username The user name for the connection. string No - -

Status.accessKey

Back to Connection status

ConnectionAccessKey defines nested fields for Connection.AccessKey.

Field Description Type Required Default Enum
secretConfig ConnectionAccessKeySecretConfig defines nested fields for Connection.AccessKey.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Status.accessKey.secretConfig

Back to Connection status

ConnectionAccessKeySecretConfig defines nested fields for Connection.AccessKey.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Status.clientSecret

Back to Connection status

ConnectionClientSecret defines nested fields for Connection.ClientSecret.

Field Description Type Required Default Enum
secretConfig ConnectionClientSecretSecretConfig defines nested fields for Connection.ClientSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Status.clientSecret.secretConfig

Back to Connection status

ConnectionClientSecretSecretConfig defines nested fields for Connection.ClientSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Status.connectionProperties[]

Back to Connection status

ConnectionProperty defines nested fields for Connection.ConnectionProperty.

Field Description Type Required Default Enum
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
value The value for the connection name property. string No - -

Status.defaultExternalStorage

Back to Connection status

ConnectionDefaultExternalStorage defines nested fields for Connection.DefaultExternalStorage.

Field Description Type Required Default Enum
bucket Bucket Name where BICC extracts stores the files string No - -
host Object Storage host Url. DO not give http/https. string No - -
namespace Namespace for the OOS bucket string No - -
storageId Id of the external stoarge configured in BICC console. Usually its numeric. string No - -
storageName Name of the external storage configured in BICC console string No - -
tenancyId Tenancy OCID for the OOS bucket string No - -

Status.keyTabContent

Back to Connection status

ConnectionKeyTabContent defines nested fields for Connection.KeyTabContent.

Field Description Type Required Default Enum
secretConfig ConnectionKeyTabContentSecretConfig defines nested fields for Connection.KeyTabContent.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Status.keyTabContent.secretConfig

Back to Connection status

ConnectionKeyTabContentSecretConfig defines nested fields for Connection.KeyTabContent.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Status.metadata

Back to Connection status

ConnectionMetadata defines nested fields for Connection.Metadata.

Field Description Type Required Default Enum
aggregator ConnectionMetadataAggregator defines nested fields for Connection.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ConnectionMetadataCountStatistics defines nested fields for Connection.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.metadata.aggregator

Back to Connection status

ConnectionMetadataAggregator defines nested fields for Connection.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.metadata.countStatistics

Back to Connection status

ConnectionMetadataCountStatistics defines nested fields for Connection.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] No - -

Status.metadata.countStatistics.objectTypeCountList[]

Back to Connection status

ConnectionMetadataCountStatisticsObjectTypeCountList defines nested fields for Connection.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.parentRef

Back to Connection status

ConnectionParentRef defines nested fields for Connection.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.passwordSecret

Back to Connection status

ConnectionPasswordSecret defines nested fields for Connection.PasswordSecret.

Field Description Type Required Default Enum
secretConfig ConnectionPasswordSecretSecretConfig defines nested fields for Connection.PasswordSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Status.passwordSecret.secretConfig

Back to Connection status

ConnectionPasswordSecretSecretConfig defines nested fields for Connection.PasswordSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Status.primarySchema

Back to Connection status

ConnectionPrimarySchema defines nested fields for Connection.PrimarySchema.

Field Description Type Required Default Enum
defaultConnection The default connection key. string No - -
description User-defined description for the schema. string No - -
externalKey The external key for the object. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isHasContainers Specifies whether the schema has containers. boolean No - -
key The object key. string No - -
metadata ConnectionPrimarySchemaMetadata defines nested fields for Connection.PrimarySchema.Metadata. object No - -
modelType The object's type. string No - -
modelVersion The object's model version. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef ConnectionPrimarySchemaParentRef defines nested fields for Connection.PrimarySchema.ParentRef. object No - -
resourceName A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters. string No - -

Status.primarySchema.metadata

Back to Connection status

ConnectionPrimarySchemaMetadata defines nested fields for Connection.PrimarySchema.Metadata.

Field Description Type Required Default Enum
aggregator ConnectionPrimarySchemaMetadataAggregator defines nested fields for Connection.PrimarySchema.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ConnectionPrimarySchemaMetadataCountStatistics defines nested fields for Connection.PrimarySchema.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.primarySchema.metadata.aggregator

Back to Connection status

ConnectionPrimarySchemaMetadataAggregator defines nested fields for Connection.PrimarySchema.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.primarySchema.metadata.countStatistics

Back to Connection status

ConnectionPrimarySchemaMetadataCountStatistics defines nested fields for Connection.PrimarySchema.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] No - -

Status.primarySchema.metadata.countStatistics.objectTypeCountList[]

Back to Connection status

ConnectionPrimarySchemaMetadataCountStatisticsObjectTypeCountList defines nested fields for Connection.PrimarySchema.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.primarySchema.parentRef

Back to Connection status

ConnectionPrimarySchemaParentRef defines nested fields for Connection.PrimarySchema.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.secretKey

Back to Connection status

ConnectionSecretKey defines nested fields for Connection.SecretKey.

Field Description Type Required Default Enum
secretConfig ConnectionSecretKeySecretConfig defines nested fields for Connection.SecretKey.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Status.secretKey.secretConfig

Back to Connection status

ConnectionSecretKeySecretConfig defines nested fields for Connection.SecretKey.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Status.status

Back to Connection 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

Back to Connection status

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

Back to Connection status

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[]

Back to Connection status

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

ConnectionValidation

ConnectionValidation is the Schema for the connectionvalidations API.

  • Plural: connectionvalidations
  • Scope: Namespaced
  • APIVersion: dataintegration.oracle.com/v1beta1
  • Sample: Sample (config/samples/dataintegration_v1beta1_connectionvalidation.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

ConnectionValidationSpec defines the desired state of ConnectionValidation.

Field Description Type Required Default Enum
connection ConnectionValidationConnection defines nested fields for ConnectionValidation.Connection. object No - -
dataAsset ConnectionValidationDataAsset defines nested fields for ConnectionValidation.DataAsset. object No - -
registryMetadata ConnectionValidationRegistryMetadata defines nested fields for ConnectionValidation.RegistryMetadata. object No - -

Spec.connection

Back to ConnectionValidation spec

ConnectionValidationConnection defines nested fields for ConnectionValidation.Connection.

Field Description Type Required Default Enum
accessKey ConnectionValidationConnectionAccessKey defines nested fields for ConnectionValidation.Connection.AccessKey. object No - -
accessTokenUrl Specifies the endpoint used to exchange authentication credentials for access tokens string No - -
authHeader Optional header name if used other than default header(Authorization). string No - -
clientId Specifies the client ID key for specific application string No - -
clientSecret ConnectionValidationConnectionClientSecret defines nested fields for ConnectionValidation.Connection.ClientSecret. object No - -
connectionProperties The properties for the connection. list[object] No - -
credentialFileContent The credential file content from an Oracle Object Storage wallet. string No - -
dataNodePrincipal The HDFS Data Node principal. string No - -
defaultExternalStorage ConnectionValidationConnectionDefaultExternalStorage defines nested fields for ConnectionValidation.Connection.DefaultExternalStorage. object No - -
description User-defined description for the connection. string No - -
fingerPrint The fingerprint for the user. string No - -
grantType Specifies the OAuth2 grant mechanism. Example CLIENT_CREDENTIALS, Implicit Flow etc. string No - -
hdfsPrincipal The HDFS principal. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string Yes - -
jsonData - string No - -
key Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create. string No - -
keyDistributionCenter The HDFS Key Distribution Center. string No - -
keyTabContent ConnectionValidationConnectionKeyTabContent defines nested fields for ConnectionValidation.Connection.KeyTabContent. object No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string Yes - -
nameNodePrincipal The HDFS Name Node principal. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef ConnectionValidationConnectionParentRef defines nested fields for ConnectionValidation.Connection.ParentRef. object No - -
passPhrase The passphrase for the connection. string No - -
password The password for the connection. string No - -
passwordSecret ConnectionValidationConnectionPasswordSecret defines nested fields for ConnectionValidation.Connection.PasswordSecret. object No - -
realm HDFS Realm name. string No - -
registryMetadata ConnectionValidationConnectionRegistryMetadata defines nested fields for ConnectionValidation.Connection.RegistryMetadata. object No - -
scope Specifies the OAuth scopes that limit the permissions granted by an access token. string No - -
secretKey ConnectionValidationConnectionSecretKey defines nested fields for ConnectionValidation.Connection.SecretKey. object No - -
tnsAlias The Autonomous Transaction Processing instance service name. string No - -
tnsNames Array of service names that are available for selection in the tnsAlias property. list[string] No - -
userId The OCI user OCID for the user to connect to. string No - -
username The user name for the connection. string No - -

Spec.connection.accessKey

Back to ConnectionValidation spec

ConnectionValidationConnectionAccessKey defines nested fields for ConnectionValidation.Connection.AccessKey.

Field Description Type Required Default Enum
secretConfig ConnectionValidationConnectionAccessKeySecretConfig defines nested fields for ConnectionValidation.Connection.AccessKey.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.connection.accessKey.secretConfig

Back to ConnectionValidation spec

ConnectionValidationConnectionAccessKeySecretConfig defines nested fields for ConnectionValidation.Connection.AccessKey.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.connection.clientSecret

Back to ConnectionValidation spec

ConnectionValidationConnectionClientSecret defines nested fields for ConnectionValidation.Connection.ClientSecret.

Field Description Type Required Default Enum
secretConfig ConnectionValidationConnectionClientSecretSecretConfig defines nested fields for ConnectionValidation.Connection.ClientSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.connection.clientSecret.secretConfig

Back to ConnectionValidation spec

ConnectionValidationConnectionClientSecretSecretConfig defines nested fields for ConnectionValidation.Connection.ClientSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.connection.connectionProperties[]

Back to ConnectionValidation spec

ConnectionValidationConnectionConnectionProperty defines nested fields for ConnectionValidation.Connection.ConnectionProperty.

Field Description Type Required Default Enum
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
value The value for the connection name property. string No - -

Spec.connection.defaultExternalStorage

Back to ConnectionValidation spec

ConnectionValidationConnectionDefaultExternalStorage defines nested fields for ConnectionValidation.Connection.DefaultExternalStorage.

Field Description Type Required Default Enum
bucket Bucket Name where BICC extracts stores the files string No - -
host Object Storage host Url. DO not give http/https. string No - -
namespace Namespace for the OOS bucket string No - -
storageId Id of the external stoarge configured in BICC console. Usually its numeric. string No - -
storageName Name of the external storage configured in BICC console string No - -
tenancyId Tenancy OCID for the OOS bucket string No - -

Spec.connection.keyTabContent

Back to ConnectionValidation spec

ConnectionValidationConnectionKeyTabContent defines nested fields for ConnectionValidation.Connection.KeyTabContent.

Field Description Type Required Default Enum
secretConfig ConnectionValidationConnectionKeyTabContentSecretConfig defines nested fields for ConnectionValidation.Connection.KeyTabContent.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.connection.keyTabContent.secretConfig

Back to ConnectionValidation spec

ConnectionValidationConnectionKeyTabContentSecretConfig defines nested fields for ConnectionValidation.Connection.KeyTabContent.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.connection.parentRef

Back to ConnectionValidation spec

ConnectionValidationConnectionParentRef defines nested fields for ConnectionValidation.Connection.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.connection.passwordSecret

Back to ConnectionValidation spec

ConnectionValidationConnectionPasswordSecret defines nested fields for ConnectionValidation.Connection.PasswordSecret.

Field Description Type Required Default Enum
secretConfig ConnectionValidationConnectionPasswordSecretSecretConfig defines nested fields for ConnectionValidation.Connection.PasswordSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.connection.passwordSecret.secretConfig

Back to ConnectionValidation spec

ConnectionValidationConnectionPasswordSecretSecretConfig defines nested fields for ConnectionValidation.Connection.PasswordSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.connection.registryMetadata

Back to ConnectionValidation spec

ConnectionValidationConnectionRegistryMetadata defines nested fields for ConnectionValidation.Connection.RegistryMetadata.

Field Description Type Required Default Enum
aggregatorKey The owning object's key for this object. string No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
key The identifying key for the object. string No - -
labels Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version. integer No - -

Spec.connection.secretKey

Back to ConnectionValidation spec

ConnectionValidationConnectionSecretKey defines nested fields for ConnectionValidation.Connection.SecretKey.

Field Description Type Required Default Enum
secretConfig ConnectionValidationConnectionSecretKeySecretConfig defines nested fields for ConnectionValidation.Connection.SecretKey.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.connection.secretKey.secretConfig

Back to ConnectionValidation spec

ConnectionValidationConnectionSecretKeySecretConfig defines nested fields for ConnectionValidation.Connection.SecretKey.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.dataAsset

Back to ConnectionValidation spec

ConnectionValidationDataAsset defines nested fields for ConnectionValidation.DataAsset.

Field Description Type Required Default Enum
assetProperties Additional properties for the data asset. map[string, string] No - -
autonomousDbId Tha Autonomous Database Id string No - -
baseUrl The base url of the rest server. string No - -
bucketSchema ConnectionValidationDataAssetBucketSchema defines nested fields for ConnectionValidation.DataAsset.BucketSchema. object No - -
compartmentId The Autonomous Data Warehouse instance compartment Id. string No - -
credentialFileContent The credential file content from a wallet for the data asset. string No - -
dataAssetType The data asset type for the generic JDBC data asset. string No - -
defaultConnection ConnectionValidationDataAssetDefaultConnection defines nested fields for ConnectionValidation.DataAsset.DefaultConnection. object No - -
description User-defined description of the data asset. string No - -
driverClass The Oracle Siebel driver class. string No - -
externalKey The external key for the object. string No - -
host The HDFS hostname. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string Yes - -
jsonData - string No - -
key Currently not used on data asset creation. Reserved for future. string No - -
lakeId The Lake Ocid. string No - -
lakeProxyEndpoint The lakeProxyEndpoint for the specified Lake Resource. string No - -
manifestFileContent The manifest file content of the rest APIs. string No - -
metastoreId The metastoreId for the specified Lake Resource. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string Yes - -
namespace The namespace for the specified Oracle Object storage resource. You can find the namespace under Object Storage Settings in the Console. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
ociRegion The Oracle Object storage Region ie. us-ashburn-1 string No - -
port The HDFS port. string No - -
protocol The HDFS Protocol name. string No - -
region The region for Amazon s3 string No - -
regionId The Autonomous Data Warehouse instance region Id. string No - -
registryMetadata ConnectionValidationDataAssetRegistryMetadata defines nested fields for ConnectionValidation.DataAsset.RegistryMetadata. object No - -
serviceName The MySql HeatWave service name for the database. string No - -
serviceUrl The generic JDBC host name. string No - -
sid The Oracle Siebel SID. string No - -
stagingConnection ConnectionValidationDataAssetStagingConnection defines nested fields for ConnectionValidation.DataAsset.StagingConnection. object No - -
stagingDataAsset ConnectionValidationDataAssetStagingDataAsset defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset. object No - -
tenancyId The Autonomous Data Warehouse instance tenancy Id. string No - -
url The Oracle Object storage URL. string No - -
validateCertificate Specifies whether certificate validation is needed boolean No - -
walletPasswordSecret ConnectionValidationDataAssetWalletPasswordSecret defines nested fields for ConnectionValidation.DataAsset.WalletPasswordSecret. object No - -
walletSecret ConnectionValidationDataAssetWalletSecret defines nested fields for ConnectionValidation.DataAsset.WalletSecret. object No - -

Spec.dataAsset.bucketSchema

Back to ConnectionValidation spec

ConnectionValidationDataAssetBucketSchema defines nested fields for ConnectionValidation.DataAsset.BucketSchema.

Field Description Type Required Default Enum
defaultConnection The default connection key. string No - -
description User-defined description for the schema. string No - -
externalKey The external key for the object. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isHasContainers Specifies whether the schema has containers. boolean No - -
key The object key. string No - -
metadata ConnectionValidationDataAssetBucketSchemaMetadata defines nested fields for ConnectionValidation.DataAsset.BucketSchema.Metadata. object No - -
modelType The object's type. string No - -
modelVersion The object's model version. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef ConnectionValidationDataAssetBucketSchemaParentRef defines nested fields for ConnectionValidation.DataAsset.BucketSchema.ParentRef. object No - -
resourceName A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters. string No - -

Spec.dataAsset.bucketSchema.metadata

Back to ConnectionValidation spec

ConnectionValidationDataAssetBucketSchemaMetadata defines nested fields for ConnectionValidation.DataAsset.BucketSchema.Metadata.

Field Description Type Required Default Enum
aggregator ConnectionValidationDataAssetBucketSchemaMetadataAggregator defines nested fields for ConnectionValidation.DataAsset.BucketSchema.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ConnectionValidationDataAssetBucketSchemaMetadataCountStatistics defines nested fields for ConnectionValidation.DataAsset.BucketSchema.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Spec.dataAsset.bucketSchema.metadata.aggregator

Back to ConnectionValidation spec

ConnectionValidationDataAssetBucketSchemaMetadataAggregator defines nested fields for ConnectionValidation.DataAsset.BucketSchema.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Spec.dataAsset.bucketSchema.metadata.countStatistics

Back to ConnectionValidation spec

ConnectionValidationDataAssetBucketSchemaMetadataCountStatistics defines nested fields for ConnectionValidation.DataAsset.BucketSchema.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Spec.dataAsset.bucketSchema.metadata.countStatistics.objectTypeCountList[]

Back to ConnectionValidation spec

ConnectionValidationDataAssetBucketSchemaMetadataCountStatisticsObjectTypeCountList defines nested fields for ConnectionValidation.DataAsset.BucketSchema.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Spec.dataAsset.bucketSchema.parentRef

Back to ConnectionValidation spec

ConnectionValidationDataAssetBucketSchemaParentRef defines nested fields for ConnectionValidation.DataAsset.BucketSchema.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.dataAsset.defaultConnection

Back to ConnectionValidation spec

ConnectionValidationDataAssetDefaultConnection defines nested fields for ConnectionValidation.DataAsset.DefaultConnection.

Field Description Type Required Default Enum
connectionProperties The properties for the connection. list[object] No - -
dataNodePrincipal The HDFS Data Node principal. string Yes - -
description User-defined description for the connection. string No - -
hdfsPrincipal The HDFS principal. string Yes - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string Yes - -
key Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create. string No - -
keyDistributionCenter The HDFS Key Distribution Center. string No - -
keyTabContent ConnectionValidationDataAssetDefaultConnectionKeyTabContent defines nested fields for ConnectionValidation.DataAsset.DefaultConnection.KeyTabContent. object No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string Yes - -
nameNodePrincipal The HDFS Name Node principal. string Yes - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef ConnectionValidationDataAssetDefaultConnectionParentRef defines nested fields for ConnectionValidation.DataAsset.DefaultConnection.ParentRef. object No - -
realm HDFS Realm name. string No - -
registryMetadata ConnectionValidationDataAssetDefaultConnectionRegistryMetadata defines nested fields for ConnectionValidation.DataAsset.DefaultConnection.RegistryMetadata. object No - -

Spec.dataAsset.defaultConnection.connectionProperties[]

Back to ConnectionValidation spec

ConnectionValidationDataAssetDefaultConnectionConnectionProperty defines nested fields for ConnectionValidation.DataAsset.DefaultConnection.ConnectionProperty.

Field Description Type Required Default Enum
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
value The value for the connection name property. string No - -

Spec.dataAsset.defaultConnection.keyTabContent

Back to ConnectionValidation spec

ConnectionValidationDataAssetDefaultConnectionKeyTabContent defines nested fields for ConnectionValidation.DataAsset.DefaultConnection.KeyTabContent.

Field Description Type Required Default Enum
secretConfig ConnectionValidationDataAssetDefaultConnectionKeyTabContentSecretConfig defines nested fields for ConnectionValidation.DataAsset.DefaultConnection.KeyTabContent.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.dataAsset.defaultConnection.keyTabContent.secretConfig

Back to ConnectionValidation spec

ConnectionValidationDataAssetDefaultConnectionKeyTabContentSecretConfig defines nested fields for ConnectionValidation.DataAsset.DefaultConnection.KeyTabContent.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.dataAsset.defaultConnection.parentRef

Back to ConnectionValidation spec

ConnectionValidationDataAssetDefaultConnectionParentRef defines nested fields for ConnectionValidation.DataAsset.DefaultConnection.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.dataAsset.defaultConnection.registryMetadata

Back to ConnectionValidation spec

ConnectionValidationDataAssetDefaultConnectionRegistryMetadata defines nested fields for ConnectionValidation.DataAsset.DefaultConnection.RegistryMetadata.

Field Description Type Required Default Enum
aggregatorKey The owning object's key for this object. string No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
key The identifying key for the object. string No - -
labels Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version. integer No - -

Spec.dataAsset.registryMetadata

Back to ConnectionValidation spec

ConnectionValidationDataAssetRegistryMetadata defines nested fields for ConnectionValidation.DataAsset.RegistryMetadata.

Field Description Type Required Default Enum
aggregatorKey The owning object's key for this object. string No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
key The identifying key for the object. string No - -
labels Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version. integer No - -

Spec.dataAsset.stagingConnection

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingConnection defines nested fields for ConnectionValidation.DataAsset.StagingConnection.

Field Description Type Required Default Enum
accessKey ConnectionValidationDataAssetStagingConnectionAccessKey defines nested fields for ConnectionValidation.DataAsset.StagingConnection.AccessKey. object No - -
accessTokenUrl Specifies the endpoint used to exchange authentication credentials for access tokens string No - -
authHeader Optional header name if used other than default header(Authorization). string No - -
clientId Specifies the client ID key for specific application string No - -
clientSecret ConnectionValidationDataAssetStagingConnectionClientSecret defines nested fields for ConnectionValidation.DataAsset.StagingConnection.ClientSecret. object No - -
connectionProperties The properties for the connection. list[object] No - -
credentialFileContent The credential file content from an Oracle Object Storage wallet. string No - -
dataNodePrincipal The HDFS Data Node principal. string No - -
defaultExternalStorage ConnectionValidationDataAssetStagingConnectionDefaultExternalStorage defines nested fields for ConnectionValidation.DataAsset.StagingConnection.DefaultExternalStorage. object No - -
description User-defined description for the connection. string No - -
fingerPrint The fingerprint for the user. string No - -
grantType Specifies the OAuth2 grant mechanism. Example CLIENT_CREDENTIALS, Implicit Flow etc. string No - -
hdfsPrincipal The HDFS principal. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isDefault The default property for the connection. boolean No - -
jsonData - string No - -
key Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create. string No - -
keyDistributionCenter The HDFS Key Distribution Center. string No - -
keyMap A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. map[string, string] No - -
keyTabContent ConnectionValidationDataAssetStagingConnectionKeyTabContent defines nested fields for ConnectionValidation.DataAsset.StagingConnection.KeyTabContent. object No - -
metadata ConnectionValidationDataAssetStagingConnectionMetadata defines nested fields for ConnectionValidation.DataAsset.StagingConnection.Metadata. object No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
nameNodePrincipal The HDFS Name Node principal. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef ConnectionValidationDataAssetStagingConnectionParentRef defines nested fields for ConnectionValidation.DataAsset.StagingConnection.ParentRef. object No - -
passPhrase The passphrase for the connection. string No - -
password The password for the connection. string No - -
passwordSecret ConnectionValidationDataAssetStagingConnectionPasswordSecret defines nested fields for ConnectionValidation.DataAsset.StagingConnection.PasswordSecret. object No - -
primarySchema ConnectionValidationDataAssetStagingConnectionPrimarySchema defines nested fields for ConnectionValidation.DataAsset.StagingConnection.PrimarySchema. object No - -
realm HDFS Realm name. string No - -
scope Specifies the OAuth scopes that limit the permissions granted by an access token. string No - -
secretKey ConnectionValidationDataAssetStagingConnectionSecretKey defines nested fields for ConnectionValidation.DataAsset.StagingConnection.SecretKey. object No - -
tnsAlias The Autonomous Data Warehouse instance service name. string No - -
tnsNames Array of service names that are available for selection in the tnsAlias property. list[string] No - -
userId The OCI user OCID for the user to connect to. string No - -
username The user name for the connection. string No - -

Spec.dataAsset.stagingConnection.accessKey

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingConnectionAccessKey defines nested fields for ConnectionValidation.DataAsset.StagingConnection.AccessKey.

Field Description Type Required Default Enum
secretConfig ConnectionValidationDataAssetStagingConnectionAccessKeySecretConfig defines nested fields for ConnectionValidation.DataAsset.StagingConnection.AccessKey.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.dataAsset.stagingConnection.accessKey.secretConfig

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingConnectionAccessKeySecretConfig defines nested fields for ConnectionValidation.DataAsset.StagingConnection.AccessKey.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.dataAsset.stagingConnection.clientSecret

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingConnectionClientSecret defines nested fields for ConnectionValidation.DataAsset.StagingConnection.ClientSecret.

Field Description Type Required Default Enum
secretConfig ConnectionValidationDataAssetStagingConnectionClientSecretSecretConfig defines nested fields for ConnectionValidation.DataAsset.StagingConnection.ClientSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.dataAsset.stagingConnection.clientSecret.secretConfig

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingConnectionClientSecretSecretConfig defines nested fields for ConnectionValidation.DataAsset.StagingConnection.ClientSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.dataAsset.stagingConnection.connectionProperties[]

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingConnectionConnectionProperty defines nested fields for ConnectionValidation.DataAsset.StagingConnection.ConnectionProperty.

Field Description Type Required Default Enum
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
value The value for the connection name property. string No - -

Spec.dataAsset.stagingConnection.defaultExternalStorage

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingConnectionDefaultExternalStorage defines nested fields for ConnectionValidation.DataAsset.StagingConnection.DefaultExternalStorage.

Field Description Type Required Default Enum
bucket Bucket Name where BICC extracts stores the files string No - -
host Object Storage host Url. DO not give http/https. string No - -
namespace Namespace for the OOS bucket string No - -
storageId Id of the external stoarge configured in BICC console. Usually its numeric. string No - -
storageName Name of the external storage configured in BICC console string No - -
tenancyId Tenancy OCID for the OOS bucket string No - -

Spec.dataAsset.stagingConnection.keyTabContent

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingConnectionKeyTabContent defines nested fields for ConnectionValidation.DataAsset.StagingConnection.KeyTabContent.

Field Description Type Required Default Enum
secretConfig ConnectionValidationDataAssetStagingConnectionKeyTabContentSecretConfig defines nested fields for ConnectionValidation.DataAsset.StagingConnection.KeyTabContent.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.dataAsset.stagingConnection.keyTabContent.secretConfig

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingConnectionKeyTabContentSecretConfig defines nested fields for ConnectionValidation.DataAsset.StagingConnection.KeyTabContent.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.dataAsset.stagingConnection.metadata

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingConnectionMetadata defines nested fields for ConnectionValidation.DataAsset.StagingConnection.Metadata.

Field Description Type Required Default Enum
aggregator ConnectionValidationDataAssetStagingConnectionMetadataAggregator defines nested fields for ConnectionValidation.DataAsset.StagingConnection.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ConnectionValidationDataAssetStagingConnectionMetadataCountStatistics defines nested fields for ConnectionValidation.DataAsset.StagingConnection.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Spec.dataAsset.stagingConnection.metadata.aggregator

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingConnectionMetadataAggregator defines nested fields for ConnectionValidation.DataAsset.StagingConnection.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Spec.dataAsset.stagingConnection.metadata.countStatistics

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingConnectionMetadataCountStatistics defines nested fields for ConnectionValidation.DataAsset.StagingConnection.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Spec.dataAsset.stagingConnection.metadata.countStatistics.objectTypeCountList[]

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingConnectionMetadataCountStatisticsObjectTypeCountList defines nested fields for ConnectionValidation.DataAsset.StagingConnection.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Spec.dataAsset.stagingConnection.parentRef

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingConnectionParentRef defines nested fields for ConnectionValidation.DataAsset.StagingConnection.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.dataAsset.stagingConnection.passwordSecret

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingConnectionPasswordSecret defines nested fields for ConnectionValidation.DataAsset.StagingConnection.PasswordSecret.

Field Description Type Required Default Enum
secretConfig ConnectionValidationDataAssetStagingConnectionPasswordSecretSecretConfig defines nested fields for ConnectionValidation.DataAsset.StagingConnection.PasswordSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.dataAsset.stagingConnection.passwordSecret.secretConfig

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingConnectionPasswordSecretSecretConfig defines nested fields for ConnectionValidation.DataAsset.StagingConnection.PasswordSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.dataAsset.stagingConnection.primarySchema

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingConnectionPrimarySchema defines nested fields for ConnectionValidation.DataAsset.StagingConnection.PrimarySchema.

Field Description Type Required Default Enum
defaultConnection The default connection key. string No - -
description User-defined description for the schema. string No - -
externalKey The external key for the object. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isHasContainers Specifies whether the schema has containers. boolean No - -
key The object key. string No - -
metadata ConnectionValidationDataAssetStagingConnectionPrimarySchemaMetadata defines nested fields for ConnectionValidation.DataAsset.StagingConnection.PrimarySchema.Metadata. object No - -
modelType The object's type. string No - -
modelVersion The object's model version. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef ConnectionValidationDataAssetStagingConnectionPrimarySchemaParentRef defines nested fields for ConnectionValidation.DataAsset.StagingConnection.PrimarySchema.ParentRef. object No - -
resourceName A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters. string No - -

Spec.dataAsset.stagingConnection.primarySchema.metadata

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingConnectionPrimarySchemaMetadata defines nested fields for ConnectionValidation.DataAsset.StagingConnection.PrimarySchema.Metadata.

Field Description Type Required Default Enum
aggregator ConnectionValidationDataAssetStagingConnectionPrimarySchemaMetadataAggregator defines nested fields for ConnectionValidation.DataAsset.StagingConnection.PrimarySchema.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ConnectionValidationDataAssetStagingConnectionPrimarySchemaMetadataCountStatistics defines nested fields for ConnectionValidation.DataAsset.StagingConnection.PrimarySchema.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Spec.dataAsset.stagingConnection.primarySchema.metadata.aggregator

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingConnectionPrimarySchemaMetadataAggregator defines nested fields for ConnectionValidation.DataAsset.StagingConnection.PrimarySchema.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Spec.dataAsset.stagingConnection.primarySchema.metadata.countStatistics

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingConnectionPrimarySchemaMetadataCountStatistics defines nested fields for ConnectionValidation.DataAsset.StagingConnection.PrimarySchema.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Spec.dataAsset.stagingConnection.primarySchema.metadata.countStatistics.objectTypeCountList[]

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingConnectionPrimarySchemaMetadataCountStatisticsObjectTypeCountList defines nested fields for ConnectionValidation.DataAsset.StagingConnection.PrimarySchema.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Spec.dataAsset.stagingConnection.primarySchema.parentRef

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingConnectionPrimarySchemaParentRef defines nested fields for ConnectionValidation.DataAsset.StagingConnection.PrimarySchema.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.dataAsset.stagingConnection.secretKey

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingConnectionSecretKey defines nested fields for ConnectionValidation.DataAsset.StagingConnection.SecretKey.

Field Description Type Required Default Enum
secretConfig ConnectionValidationDataAssetStagingConnectionSecretKeySecretConfig defines nested fields for ConnectionValidation.DataAsset.StagingConnection.SecretKey.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.dataAsset.stagingConnection.secretKey.secretConfig

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingConnectionSecretKeySecretConfig defines nested fields for ConnectionValidation.DataAsset.StagingConnection.SecretKey.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.dataAsset.stagingDataAsset

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAsset defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.

Field Description Type Required Default Enum
assetProperties Additional properties for the data asset. map[string, string] No - -
baseUrl The base url of the rest server. string No - -
bucketSchema ConnectionValidationDataAssetStagingDataAssetBucketSchema defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.BucketSchema. object No - -
credentialFileContent The credential file content from a wallet for the data asset. string No - -
dataAssetType The data asset type for the generic JDBC data asset. string No - -
defaultConnection ConnectionValidationDataAssetStagingDataAssetDefaultConnection defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.DefaultConnection. object No - -
description User-defined description of the data asset. string No - -
driverClass The Oracle Database driver class. string No - -
externalKey The external key for the object. string No - -
host The generic JDBC host name. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
jsonData - string No - -
key Generated key that can be used in API calls to identify data asset. string No - -
keyMap A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. map[string, string] No - -
lakeId The Lake Ocid. string No - -
lakeProxyEndpoint The lakeProxyEndpoint for the specified Lake Resource. string No - -
manifestFileContent The manifest file content of the rest APIs. string No - -
metadata ConnectionValidationDataAssetStagingDataAssetMetadata defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.Metadata. object No - -
metastoreId The metastoreId for the specified Lake Resource. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
namespace The namespace for the specified Oracle Object storage resource. You can find the namespace under Object Storage Settings in the Console. string No - -
nativeTypeSystem ConnectionValidationDataAssetStagingDataAssetNativeTypeSystem defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem. object No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
ociRegion The Oracle Object storage Region ie. us-ashburn-1 string No - -
parentRef ConnectionValidationDataAssetStagingDataAssetParentRef defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.ParentRef. object No - -
port The generic JDBC port number. string No - -
protocol The HDFS Protocol name. string No - -
region The region for Amazon s3 string No - -
serviceName The Oracle Database service name. string No - -
serviceNames Array of service names that are available for selection in the serviceName property. list[string] No - -
serviceUrl The service url of the BI Server. string No - -
sid The Oracle Database SID. string No - -
stagingConnection ConnectionValidationDataAssetStagingDataAssetStagingConnection defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection. object No - -
stagingDataAsset JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
tenancyId The OCI tenancy OCID. string No - -
url The Oracle Object storage URL. string No - -
validateCertificate Specifies whether certificate validation is needed boolean No - -
walletPasswordSecret ConnectionValidationDataAssetStagingDataAssetWalletPasswordSecret defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.WalletPasswordSecret. object No - -
walletSecret ConnectionValidationDataAssetStagingDataAssetWalletSecret defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.WalletSecret. object No - -

Spec.dataAsset.stagingDataAsset.bucketSchema

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetBucketSchema defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.BucketSchema.

Field Description Type Required Default Enum
defaultConnection The default connection key. string No - -
description User-defined description for the schema. string No - -
externalKey The external key for the object. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isHasContainers Specifies whether the schema has containers. boolean No - -
key The object key. string No - -
metadata ConnectionValidationDataAssetStagingDataAssetBucketSchemaMetadata defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.BucketSchema.Metadata. object No - -
modelType The object's type. string No - -
modelVersion The object's model version. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef ConnectionValidationDataAssetStagingDataAssetBucketSchemaParentRef defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.BucketSchema.ParentRef. object No - -
resourceName A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters. string No - -

Spec.dataAsset.stagingDataAsset.bucketSchema.metadata

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetBucketSchemaMetadata defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.BucketSchema.Metadata.

Field Description Type Required Default Enum
aggregator ConnectionValidationDataAssetStagingDataAssetBucketSchemaMetadataAggregator defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.BucketSchema.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ConnectionValidationDataAssetStagingDataAssetBucketSchemaMetadataCountStatistics defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.BucketSchema.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Spec.dataAsset.stagingDataAsset.bucketSchema.metadata.aggregator

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetBucketSchemaMetadataAggregator defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.BucketSchema.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Spec.dataAsset.stagingDataAsset.bucketSchema.metadata.countStatistics

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetBucketSchemaMetadataCountStatistics defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.BucketSchema.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Spec.dataAsset.stagingDataAsset.bucketSchema.metadata.countStatistics.objectTypeCountList[]

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetBucketSchemaMetadataCountStatisticsObjectTypeCountList defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.BucketSchema.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Spec.dataAsset.stagingDataAsset.bucketSchema.parentRef

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetBucketSchemaParentRef defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.BucketSchema.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.dataAsset.stagingDataAsset.defaultConnection

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetDefaultConnection defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.DefaultConnection.

Field Description Type Required Default Enum
connectionProperties The properties for the connection. list[object] No - -
description User-defined description for the connection. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isDefault The default property for the connection. boolean No - -
key Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create. string No - -
metadata ConnectionValidationDataAssetStagingDataAssetDefaultConnectionMetadata defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.DefaultConnection.Metadata. object No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef ConnectionValidationDataAssetStagingDataAssetDefaultConnectionParentRef defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.DefaultConnection.ParentRef. object No - -
primarySchema ConnectionValidationDataAssetStagingDataAssetDefaultConnectionPrimarySchema defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.DefaultConnection.PrimarySchema. object No - -
username The user name for the connection. string No - -

Spec.dataAsset.stagingDataAsset.defaultConnection.connectionProperties[]

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetDefaultConnectionConnectionProperty defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.DefaultConnection.ConnectionProperty.

Field Description Type Required Default Enum
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
value The value for the connection name property. string No - -

Spec.dataAsset.stagingDataAsset.defaultConnection.metadata

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetDefaultConnectionMetadata defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.DefaultConnection.Metadata.

Field Description Type Required Default Enum
aggregator ConnectionValidationDataAssetStagingDataAssetDefaultConnectionMetadataAggregator defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.DefaultConnection.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ConnectionValidationDataAssetStagingDataAssetDefaultConnectionMetadataCountStatistics defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.DefaultConnection.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Spec.dataAsset.stagingDataAsset.defaultConnection.metadata.aggregator

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetDefaultConnectionMetadataAggregator defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.DefaultConnection.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Spec.dataAsset.stagingDataAsset.defaultConnection.metadata.countStatistics

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetDefaultConnectionMetadataCountStatistics defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.DefaultConnection.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Spec.dataAsset.stagingDataAsset.defaultConnection.metadata.countStatistics.objectTypeCountList[]

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetDefaultConnectionMetadataCountStatisticsObjectTypeCountList defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.DefaultConnection.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Spec.dataAsset.stagingDataAsset.defaultConnection.parentRef

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetDefaultConnectionParentRef defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.DefaultConnection.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.dataAsset.stagingDataAsset.defaultConnection.primarySchema

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetDefaultConnectionPrimarySchema defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.DefaultConnection.PrimarySchema.

Field Description Type Required Default Enum
defaultConnection The default connection key. string No - -
description User-defined description for the schema. string No - -
externalKey The external key for the object. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isHasContainers Specifies whether the schema has containers. boolean No - -
key The object key. string No - -
metadata ConnectionValidationDataAssetStagingDataAssetDefaultConnectionPrimarySchemaMetadata defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.DefaultConnection.PrimarySchema.Metadata. object No - -
modelType The object's type. string No - -
modelVersion The object's model version. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef ConnectionValidationDataAssetStagingDataAssetDefaultConnectionPrimarySchemaParentRef defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.DefaultConnection.PrimarySchema.ParentRef. object No - -
resourceName A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters. string No - -

Spec.dataAsset.stagingDataAsset.defaultConnection.primarySchema.metadata

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetDefaultConnectionPrimarySchemaMetadata defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.DefaultConnection.PrimarySchema.Metadata.

Field Description Type Required Default Enum
aggregator ConnectionValidationDataAssetStagingDataAssetDefaultConnectionPrimarySchemaMetadataAggregator defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.DefaultConnection.PrimarySchema.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ConnectionValidationDataAssetStagingDataAssetDefaultConnectionPrimarySchemaMetadataCountStatistics defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.DefaultConnection.PrimarySchema.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Spec.dataAsset.stagingDataAsset.defaultConnection.primarySchema.metadata.aggregator

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetDefaultConnectionPrimarySchemaMetadataAggregator defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.DefaultConnection.PrimarySchema.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Spec.dataAsset.stagingDataAsset.defaultConnection.primarySchema.metadata.countStatistics

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetDefaultConnectionPrimarySchemaMetadataCountStatistics defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.DefaultConnection.PrimarySchema.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Spec.dataAsset.stagingDataAsset.defaultConnection.primarySchema.metadata.countStatistics.objectTypeCountList[]

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetDefaultConnectionPrimarySchemaMetadataCountStatisticsObjectTypeCountList defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.DefaultConnection.PrimarySchema.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Spec.dataAsset.stagingDataAsset.defaultConnection.primarySchema.parentRef

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetDefaultConnectionPrimarySchemaParentRef defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.DefaultConnection.PrimarySchema.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.dataAsset.stagingDataAsset.metadata

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetMetadata defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.Metadata.

Field Description Type Required Default Enum
aggregator ConnectionValidationDataAssetStagingDataAssetMetadataAggregator defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ConnectionValidationDataAssetStagingDataAssetMetadataCountStatistics defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Spec.dataAsset.stagingDataAsset.metadata.aggregator

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetMetadataAggregator defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Spec.dataAsset.stagingDataAsset.metadata.countStatistics

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetMetadataCountStatistics defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Spec.dataAsset.stagingDataAsset.metadata.countStatistics.objectTypeCountList[]

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetMetadataCountStatisticsObjectTypeCountList defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Spec.dataAsset.stagingDataAsset.nativeTypeSystem

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetNativeTypeSystem defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.

Field Description Type Required Default Enum
description A user defined description for the object. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
key The key of the object. string No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemParentRef defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.ParentRef. object No - -
typeMappingFrom The type system to map from. map[string, string] No - -
typeMappingTo The type system to map to. map[string, string] No - -
types An array of types. list[object] No - -

Spec.dataAsset.stagingDataAsset.nativeTypeSystem.parentRef

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemParentRef defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.dataAsset.stagingDataAsset.nativeTypeSystem.types[]

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemType defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.

Field Description Type Required Default Enum
configDefinition ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinition defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition. object No - -
description A user defined description for the object. string No - -
dtType The data type. string No - -
key The key of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeParentRef defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ParentRef. object No - -
typeSystemName The data type system name. string No - -

Spec.dataAsset.stagingDataAsset.nativeTypeSystem.types[].configDefinition

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinition defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.

Field Description Type Required Default Enum
configParameterDefinitions The parameter configuration details. map[string, object] No - -
isContained Specifies whether the configuration is contained or not. boolean No - -
key The key of the object. string No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionParentRef defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ParentRef. object No - -

Spec.dataAsset.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitions defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.

Field Description Type Required Default Enum
classFieldName The parameter class field name. string No - -
defaultValue The default value for the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
description A user defined description for the object. string No - -
isClassFieldValue Specifies whether the parameter is a class field or not. boolean No - -
isStatic Specifies whether the parameter is static or not. boolean No - -
parameterName This object represents the configurable properties for an object type. string No - -
parameterType ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterType defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType. object No - -

Spec.dataAsset.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterType defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.

Field Description Type Required Default Enum
configDefinition JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
configValues ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValues defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues. object No - -
containsNull Defines whether null values are allowed. boolean No - -
description A user defined description for the object. string No - -
dtType The data type. string No - -
elementType Seeded type string No - -
elements An array of elements. list[string] No - -
javaTypeName The java type name. string No - -
jsonData - string No - -
key The key of the object. string No - -
keyElementType Seeded type string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeParentRef defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ParentRef. object No - -
pathNames An array of path names corresponding to the elements. The path names are used when referring to the field in an expression. list[string] No - -
typeHandler ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandler defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler. object No - -
typeSystemName The data type system name. string No - -
valueElementType Seeded type string No - -
wrappedType A wrapped type, may be a string or a BaseType. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Spec.dataAsset.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.configValues

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValues defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesParentRef defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ParentRef. object No - -

Spec.dataAsset.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.configValues.configParamValues{}

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesConfigParamValues defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.dataAsset.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.configValues.parentRef

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesParentRef defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.dataAsset.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.parentRef

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeParentRef defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.dataAsset.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandler defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.

Field Description Type Required Default Enum
configValues ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValues defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues. object No - -
flattenDetails Contains a key for referencing the flattenDetails information. string No - -
isOrderByRule Specifies whether it is ordered by rule. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerParentRef defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ParentRef. object No - -
projectionRules The projection rules. list[object] No - -
scope Reference key for the typed object. string No - -
scopeReference ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerScopeReference defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ScopeReference. object No - -

Spec.dataAsset.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValues defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesParentRef defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ParentRef. object No - -

Spec.dataAsset.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues.configParamValues{}

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesConfigParamValues defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.dataAsset.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues.parentRef

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesParentRef defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.dataAsset.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.parentRef

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerParentRef defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.dataAsset.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[]

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRule defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.

Field Description Type Required Default Enum
configValues ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValues defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues. object No - -
description A user defined description for the object. string No - -
fromName The attribute name that needs to be renamed. string No - -
isCascade Specifies whether to cascade or not. boolean No - -
isCaseSensitive Specifies if the rule is case sensitive. boolean No - -
isJavaRegexSyntax Specifies whether the rule uses a java regex syntax. boolean No - -
isSkipRemainingRulesOnMatch Specifies whether to skip remaining rules when a match is found. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
matchingStrategy The pattern matching strategy. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Name of the group. string No - -
names Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. list[string] No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleParentRef defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ParentRef. object No - -
pattern The rule pattern. string No - -
ruleType The rule type. string No - -
scope Reference to a typed object. This can be either a key value to an object within the document, a shall referenced to a TypedObject, or a full TypedObject definition. Unknown nested fields are preserved. object (preserves unknown fields) No - -
toName The new attribute name. string No - -
types An arry of types. list[object (preserves unknown fields)] No - -

Spec.dataAsset.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValues defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ParentRef. object No - -

Spec.dataAsset.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues.configParamValues{}

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesConfigParamValues defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.dataAsset.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues.parentRef

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.dataAsset.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].parentRef

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleParentRef defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.dataAsset.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.scopeReference

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerScopeReference defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ScopeReference.

Field Description Type Required Default Enum
refObjectName The referenced object name for this reference. Set to the field name if the referenceType is BOUND_ENTITY_SHAPE_FIELD, else set to null. string No - -
referenceObject A key or shallow reference to an object. For direct reference, it points to the actual scope object. For BOUND_ENTITY_SHAPE or BOUND_ENTITY_SHAPE_FIELD, it points to the source or target operator. For OCI_FUNCTION_INPUT_SHAPE or OCI_FUNCTION_OUTPUT_SHAPE, it points to the OCI Function object. string Yes - -
referenceType The reference type for this reference. Set to null for a direct reference, for indirect references set to a type of association such as "BOUND_ENTITY_SHAPE". Current known reference type values are "BOUND_ENTITY_SHAPE", "BOUND_ENTITY_SHAPE_FIELD", "OCI_FUNCTION_INPUT_SHAPE", "OCI_FUNCTION_OUTPUT_SHAPE" string No - -

Spec.dataAsset.stagingDataAsset.nativeTypeSystem.types[].configDefinition.parentRef

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionParentRef defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.dataAsset.stagingDataAsset.nativeTypeSystem.types[].parentRef

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetNativeTypeSystemTypeParentRef defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.NativeTypeSystem.Type.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.dataAsset.stagingDataAsset.parentRef

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetParentRef defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.dataAsset.stagingDataAsset.stagingConnection

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetStagingConnection defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.

Field Description Type Required Default Enum
accessKey ConnectionValidationDataAssetStagingDataAssetStagingConnectionAccessKey defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.AccessKey. object No - -
accessTokenUrl Specifies the endpoint used to exchange authentication credentials for access tokens string No - -
authHeader Optional header name if used other than default header(Authorization). string No - -
clientId Specifies the client ID key for specific application string No - -
clientSecret ConnectionValidationDataAssetStagingDataAssetStagingConnectionClientSecret defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.ClientSecret. object No - -
connectionProperties The properties for the connection. list[object] No - -
credentialFileContent The credential file content from an Oracle Object Storage wallet. string No - -
dataNodePrincipal The HDFS Data Node principal. string No - -
defaultExternalStorage ConnectionValidationDataAssetStagingDataAssetStagingConnectionDefaultExternalStorage defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.DefaultExternalStorage. object No - -
description User-defined description for the connection. string No - -
fingerPrint The fingerprint for the user. string No - -
grantType Specifies the OAuth2 grant mechanism. Example CLIENT_CREDENTIALS, Implicit Flow etc. string No - -
hdfsPrincipal The HDFS principal. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isDefault The default property for the connection. boolean No - -
jsonData - string No - -
key Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create. string No - -
keyDistributionCenter The HDFS Key Distribution Center. string No - -
keyMap A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. map[string, string] No - -
keyTabContent ConnectionValidationDataAssetStagingDataAssetStagingConnectionKeyTabContent defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.KeyTabContent. object No - -
metadata ConnectionValidationDataAssetStagingDataAssetStagingConnectionMetadata defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.Metadata. object No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
nameNodePrincipal The HDFS Name Node principal. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef ConnectionValidationDataAssetStagingDataAssetStagingConnectionParentRef defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.ParentRef. object No - -
passPhrase The passphrase for the connection. string No - -
password The password for the connection. string No - -
passwordSecret ConnectionValidationDataAssetStagingDataAssetStagingConnectionPasswordSecret defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.PasswordSecret. object No - -
primarySchema ConnectionValidationDataAssetStagingDataAssetStagingConnectionPrimarySchema defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.PrimarySchema. object No - -
realm HDFS Realm name. string No - -
scope Specifies the OAuth scopes that limit the permissions granted by an access token. string No - -
secretKey ConnectionValidationDataAssetStagingDataAssetStagingConnectionSecretKey defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.SecretKey. object No - -
tnsAlias The Autonomous Data Warehouse instance service name. string No - -
tnsNames Array of service names that are available for selection in the tnsAlias property. list[string] No - -
userId The OCI user OCID for the user to connect to. string No - -
username The user name for the connection. string No - -

Spec.dataAsset.stagingDataAsset.stagingConnection.accessKey

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetStagingConnectionAccessKey defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.AccessKey.

Field Description Type Required Default Enum
secretConfig ConnectionValidationDataAssetStagingDataAssetStagingConnectionAccessKeySecretConfig defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.AccessKey.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.dataAsset.stagingDataAsset.stagingConnection.accessKey.secretConfig

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetStagingConnectionAccessKeySecretConfig defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.AccessKey.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.dataAsset.stagingDataAsset.stagingConnection.clientSecret

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetStagingConnectionClientSecret defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.ClientSecret.

Field Description Type Required Default Enum
secretConfig ConnectionValidationDataAssetStagingDataAssetStagingConnectionClientSecretSecretConfig defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.ClientSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.dataAsset.stagingDataAsset.stagingConnection.clientSecret.secretConfig

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetStagingConnectionClientSecretSecretConfig defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.ClientSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.dataAsset.stagingDataAsset.stagingConnection.connectionProperties[]

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetStagingConnectionConnectionProperty defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.ConnectionProperty.

Field Description Type Required Default Enum
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
value The value for the connection name property. string No - -

Spec.dataAsset.stagingDataAsset.stagingConnection.defaultExternalStorage

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetStagingConnectionDefaultExternalStorage defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.DefaultExternalStorage.

Field Description Type Required Default Enum
bucket Bucket Name where BICC extracts stores the files string No - -
host Object Storage host Url. DO not give http/https. string No - -
namespace Namespace for the OOS bucket string No - -
storageId Id of the external stoarge configured in BICC console. Usually its numeric. string No - -
storageName Name of the external storage configured in BICC console string No - -
tenancyId Tenancy OCID for the OOS bucket string No - -

Spec.dataAsset.stagingDataAsset.stagingConnection.keyTabContent

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetStagingConnectionKeyTabContent defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.KeyTabContent.

Field Description Type Required Default Enum
secretConfig ConnectionValidationDataAssetStagingDataAssetStagingConnectionKeyTabContentSecretConfig defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.KeyTabContent.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.dataAsset.stagingDataAsset.stagingConnection.keyTabContent.secretConfig

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetStagingConnectionKeyTabContentSecretConfig defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.KeyTabContent.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.dataAsset.stagingDataAsset.stagingConnection.metadata

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetStagingConnectionMetadata defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.Metadata.

Field Description Type Required Default Enum
aggregator ConnectionValidationDataAssetStagingDataAssetStagingConnectionMetadataAggregator defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ConnectionValidationDataAssetStagingDataAssetStagingConnectionMetadataCountStatistics defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Spec.dataAsset.stagingDataAsset.stagingConnection.metadata.aggregator

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetStagingConnectionMetadataAggregator defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Spec.dataAsset.stagingDataAsset.stagingConnection.metadata.countStatistics

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetStagingConnectionMetadataCountStatistics defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Spec.dataAsset.stagingDataAsset.stagingConnection.metadata.countStatistics.objectTypeCountList[]

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetStagingConnectionMetadataCountStatisticsObjectTypeCountList defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Spec.dataAsset.stagingDataAsset.stagingConnection.parentRef

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetStagingConnectionParentRef defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.dataAsset.stagingDataAsset.stagingConnection.passwordSecret

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetStagingConnectionPasswordSecret defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.PasswordSecret.

Field Description Type Required Default Enum
secretConfig ConnectionValidationDataAssetStagingDataAssetStagingConnectionPasswordSecretSecretConfig defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.PasswordSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.dataAsset.stagingDataAsset.stagingConnection.passwordSecret.secretConfig

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetStagingConnectionPasswordSecretSecretConfig defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.PasswordSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.dataAsset.stagingDataAsset.stagingConnection.primarySchema

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetStagingConnectionPrimarySchema defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.PrimarySchema.

Field Description Type Required Default Enum
defaultConnection The default connection key. string No - -
description User-defined description for the schema. string No - -
externalKey The external key for the object. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isHasContainers Specifies whether the schema has containers. boolean No - -
key The object key. string No - -
metadata ConnectionValidationDataAssetStagingDataAssetStagingConnectionPrimarySchemaMetadata defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.PrimarySchema.Metadata. object No - -
modelType The object's type. string No - -
modelVersion The object's model version. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef ConnectionValidationDataAssetStagingDataAssetStagingConnectionPrimarySchemaParentRef defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.PrimarySchema.ParentRef. object No - -
resourceName A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters. string No - -

Spec.dataAsset.stagingDataAsset.stagingConnection.primarySchema.metadata

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetStagingConnectionPrimarySchemaMetadata defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.PrimarySchema.Metadata.

Field Description Type Required Default Enum
aggregator ConnectionValidationDataAssetStagingDataAssetStagingConnectionPrimarySchemaMetadataAggregator defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.PrimarySchema.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ConnectionValidationDataAssetStagingDataAssetStagingConnectionPrimarySchemaMetadataCountStatistics defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.PrimarySchema.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Spec.dataAsset.stagingDataAsset.stagingConnection.primarySchema.metadata.aggregator

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetStagingConnectionPrimarySchemaMetadataAggregator defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.PrimarySchema.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Spec.dataAsset.stagingDataAsset.stagingConnection.primarySchema.metadata.countStatistics

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetStagingConnectionPrimarySchemaMetadataCountStatistics defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.PrimarySchema.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Spec.dataAsset.stagingDataAsset.stagingConnection.primarySchema.metadata.countStatistics.objectTypeCountList[]

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetStagingConnectionPrimarySchemaMetadataCountStatisticsObjectTypeCountList defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.PrimarySchema.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Spec.dataAsset.stagingDataAsset.stagingConnection.primarySchema.parentRef

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetStagingConnectionPrimarySchemaParentRef defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.PrimarySchema.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.dataAsset.stagingDataAsset.stagingConnection.secretKey

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetStagingConnectionSecretKey defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.SecretKey.

Field Description Type Required Default Enum
secretConfig ConnectionValidationDataAssetStagingDataAssetStagingConnectionSecretKeySecretConfig defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.SecretKey.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.dataAsset.stagingDataAsset.stagingConnection.secretKey.secretConfig

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetStagingConnectionSecretKeySecretConfig defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.StagingConnection.SecretKey.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.dataAsset.stagingDataAsset.walletPasswordSecret

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetWalletPasswordSecret defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.WalletPasswordSecret.

Field Description Type Required Default Enum
secretConfig ConnectionValidationDataAssetStagingDataAssetWalletPasswordSecretSecretConfig defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.WalletPasswordSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.dataAsset.stagingDataAsset.walletPasswordSecret.secretConfig

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetWalletPasswordSecretSecretConfig defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.WalletPasswordSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.dataAsset.stagingDataAsset.walletSecret

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetWalletSecret defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.WalletSecret.

Field Description Type Required Default Enum
secretConfig ConnectionValidationDataAssetStagingDataAssetWalletSecretSecretConfig defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.WalletSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.dataAsset.stagingDataAsset.walletSecret.secretConfig

Back to ConnectionValidation spec

ConnectionValidationDataAssetStagingDataAssetWalletSecretSecretConfig defines nested fields for ConnectionValidation.DataAsset.StagingDataAsset.WalletSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.dataAsset.walletPasswordSecret

Back to ConnectionValidation spec

ConnectionValidationDataAssetWalletPasswordSecret defines nested fields for ConnectionValidation.DataAsset.WalletPasswordSecret.

Field Description Type Required Default Enum
secretConfig ConnectionValidationDataAssetWalletPasswordSecretSecretConfig defines nested fields for ConnectionValidation.DataAsset.WalletPasswordSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.dataAsset.walletPasswordSecret.secretConfig

Back to ConnectionValidation spec

ConnectionValidationDataAssetWalletPasswordSecretSecretConfig defines nested fields for ConnectionValidation.DataAsset.WalletPasswordSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.dataAsset.walletSecret

Back to ConnectionValidation spec

ConnectionValidationDataAssetWalletSecret defines nested fields for ConnectionValidation.DataAsset.WalletSecret.

Field Description Type Required Default Enum
secretConfig ConnectionValidationDataAssetWalletSecretSecretConfig defines nested fields for ConnectionValidation.DataAsset.WalletSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.dataAsset.walletSecret.secretConfig

Back to ConnectionValidation spec

ConnectionValidationDataAssetWalletSecretSecretConfig defines nested fields for ConnectionValidation.DataAsset.WalletSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.registryMetadata

Back to ConnectionValidation spec

ConnectionValidationRegistryMetadata defines nested fields for ConnectionValidation.RegistryMetadata.

Field Description Type Required Default Enum
aggregatorKey The owning object's key for this object. string No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
key The identifying key for the object. string No - -
labels Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version. integer No - -

Status

ConnectionValidationStatus defines the observed state of ConnectionValidation.

Field Description Type Required Default Enum
description Detailed description for the object. string No - -
identifier Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
key Objects will use a 36 character key as unique ID. It is system generated and cannot be modified. string No - -
metadata ConnectionValidationMetadata defines nested fields for ConnectionValidation.Metadata. object No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef ConnectionValidationParentRef defines nested fields for ConnectionValidation.ParentRef. object No - -
status - object Yes - -
validationMessage ConnectionValidationValidationMessage defines nested fields for ConnectionValidation.ValidationMessage. object No - -

Status.metadata

Back to ConnectionValidation status

ConnectionValidationMetadata defines nested fields for ConnectionValidation.Metadata.

Field Description Type Required Default Enum
aggregator ConnectionValidationMetadataAggregator defines nested fields for ConnectionValidation.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ConnectionValidationMetadataCountStatistics defines nested fields for ConnectionValidation.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.metadata.aggregator

Back to ConnectionValidation status

ConnectionValidationMetadataAggregator defines nested fields for ConnectionValidation.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.metadata.countStatistics

Back to ConnectionValidation status

ConnectionValidationMetadataCountStatistics defines nested fields for ConnectionValidation.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] No - -

Status.metadata.countStatistics.objectTypeCountList[]

Back to ConnectionValidation status

ConnectionValidationMetadataCountStatisticsObjectTypeCountList defines nested fields for ConnectionValidation.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.parentRef

Back to ConnectionValidation status

ConnectionValidationParentRef defines nested fields for ConnectionValidation.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.status

Back to ConnectionValidation 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

Back to ConnectionValidation status

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

Back to ConnectionValidation status

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[]

Back to ConnectionValidation status

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

Status.validationMessage

Back to ConnectionValidation status

ConnectionValidationValidationMessage defines nested fields for ConnectionValidation.ValidationMessage.

Field Description Type Required Default Enum
code The message code. string No - -
message The message text. string No - -
type The type of message (error, warning, or info). string No - -

CopyObjectRequest

CopyObjectRequest is the Schema for the copyobjectrequests API.

  • Plural: copyobjectrequests
  • Scope: Namespaced
  • APIVersion: dataintegration.oracle.com/v1beta1
  • Sample: Sample (config/samples/dataintegration_v1beta1_copyobjectrequest.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

CopyObjectRequestSpec defines the desired state of CopyObjectRequest.

Field Description Type Required Default Enum
copyConflictResolution CopyObjectRequestCopyConflictResolution defines nested fields for CopyObjectRequest.CopyConflictResolution. object Yes - -
objectKeys The list of the objects to be copied. list[string] Yes - -
sourceWorkspaceId The workspace id of the source from where we need to copy object. string Yes - -
status The status of the object. string No - -

Spec.copyConflictResolution

Back to CopyObjectRequest spec

CopyObjectRequestCopyConflictResolution defines nested fields for CopyObjectRequest.CopyConflictResolution.

Field Description Type Required Default Enum
duplicatePrefix In case of DUPLICATE mode, this prefix will be used to disambiguate the object. string No - -
duplicateSuffix In case of DUPLICATE mode, this suffix will be used to disambiguate the object. string No - -
requestType Copy Object Conflict Resolution Type (RETAIN/DUPLICATE/REPLACE). string Yes - -

Status

CopyObjectRequestStatus defines the observed state of CopyObjectRequest.

Field Description Type Required Default Enum
copiedItems The array of copy object details. list[object] No - -
copyConflictResolution CopyObjectRequestCopyConflictResolution defines nested fields for CopyObjectRequest.CopyConflictResolution. object No - -
copyMetadataObjectRequestStatus Copy Object request status. string No - -
createdBy OCID of the user who initiated copy request. string No - -
createdByName Name of the user who created the copy object request. string No - -
key Copy object request key. string No - -
name Name of the copy object request. string No - -
objectKeys The list of the objects to be copied. list[string] No - -
referencedItems The array of copied referenced objects. list[object] No - -
sourceWorkspaceId The workspace id of the source from where we need to copy object. string No - -
status - object Yes - -
timeEndedInMillis Time at which the request was completely processed. integer (int64) No - -
timeStartedInMillis Time at which the request started getting processed. integer (int64) No - -
totalObjectsCopiedIntoTarget Number of objects copied into the target. integer No - -
totalSourceObjectCount Number of source objects to be copied. integer No - -

Status.copiedItems[]

Back to CopyObjectRequest status

CopyObjectRequestCopiedItem defines nested fields for CopyObjectRequest.CopiedItem.

Field Description Type Required Default Enum
aggregatorKey Aggregator key string No - -
identifier Object identifier. string No - -
name Name of the object. string No - -
namePath Object name path. string No - -
newKey New key of the object to identify the copied object. For example the new dataflow key. string No - -
objectType Object type. string No - -
objectVersion Object version. string No - -
oldKey Old key of the object from where the object was copied. For example a dataflow key within the project being copied. string No - -
resolutionAction Object resolution action. string No - -
timeUpdatedInMillis time at which this object was last updated. integer (int64) No - -

Status.copyConflictResolution

Back to CopyObjectRequest status

CopyObjectRequestCopyConflictResolution defines nested fields for CopyObjectRequest.CopyConflictResolution.

Field Description Type Required Default Enum
duplicatePrefix In case of DUPLICATE mode, this prefix will be used to disambiguate the object. string No - -
duplicateSuffix In case of DUPLICATE mode, this suffix will be used to disambiguate the object. string No - -
requestType Copy Object Conflict Resolution Type (RETAIN/DUPLICATE/REPLACE). string Yes - -

Status.referencedItems[]

Back to CopyObjectRequest status

CopyObjectRequestReferencedItem defines nested fields for CopyObjectRequest.ReferencedItem.

Field Description Type Required Default Enum
aggregatorKey Aggregator key string No - -
identifier Object identifier. string No - -
name Name of the object. string No - -
namePath Object name path. string No - -
newKey New key of the object to identify the copied object. For example the new dataflow key. string No - -
objectType Object type. string No - -
objectVersion Object version. string No - -
oldKey Old key of the object from where the object was copied. For example a dataflow key within the project being copied. string No - -
resolutionAction Object resolution action. string No - -
timeUpdatedInMillis time at which this object was last updated. integer (int64) No - -

Status.status

Back to CopyObjectRequest 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

Back to CopyObjectRequest status

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

Back to CopyObjectRequest status

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[]

Back to CopyObjectRequest status

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: dataintegration.oracle.com/v1beta1
  • Sample: Sample (config/samples/dataintegration_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
assetProperties Additional properties for the data asset. map[string, string] No - -
autonomousDbId Tha Autonomous Database Id string No - -
baseUrl The base url of the rest server. string No - -
bucketSchema DataAssetBucketSchema defines nested fields for DataAsset.BucketSchema. object No - -
compartmentId The Autonomous Data Warehouse instance compartment Id. string No - -
credentialFileContent The credential file content from a wallet for the data asset. string No - -
dataAssetType The data asset type for the generic JDBC data asset. string No - -
defaultConnection DataAssetDefaultConnection defines nested fields for DataAsset.DefaultConnection. object No - -
description User-defined description of the data asset. string No - -
driverClass The Oracle Siebel driver class. string No - -
externalKey The external key for the object. string No - -
host The HDFS hostname. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string Yes - -
jsonData - string No - -
key Currently not used on data asset creation. Reserved for future. string No - -
lakeId The Lake Ocid. string No - -
lakeProxyEndpoint The lakeProxyEndpoint for the specified Lake Resource. string No - -
manifestFileContent The manifest file content of the rest APIs. string No - -
metastoreId The metastoreId for the specified Lake Resource. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string Yes - -
namespace The namespace for the specified Oracle Object storage resource. You can find the namespace under Object Storage Settings in the Console. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer Yes - -
ociRegion The Oracle Object storage Region ie. us-ashburn-1 string No - -
port The HDFS port. string No - -
protocol The HDFS Protocol name. string No - -
region The region for Amazon s3 string No - -
regionId The Autonomous Data Warehouse instance region Id. string No - -
registryMetadata DataAssetRegistryMetadata defines nested fields for DataAsset.RegistryMetadata. object No - -
serviceName The MySql HeatWave service name for the database. string No - -
serviceUrl The generic JDBC host name. string No - -
sid The Oracle Siebel SID. string No - -
stagingConnection DataAssetStagingConnection defines nested fields for DataAsset.StagingConnection. object No - -
stagingDataAsset DataAssetStagingDataAsset defines nested fields for DataAsset.StagingDataAsset. object No - -
tenancyId The Autonomous Data Warehouse instance tenancy Id. string No - -
url The Oracle Object storage URL. string No - -
validateCertificate Specifies whether certificate validation is needed boolean No - -
walletPasswordSecret DataAssetWalletPasswordSecret defines nested fields for DataAsset.WalletPasswordSecret. object No - -
walletSecret DataAssetWalletSecret defines nested fields for DataAsset.WalletSecret. object No - -

Spec.bucketSchema

Back to DataAsset spec

DataAssetBucketSchema defines nested fields for DataAsset.BucketSchema.

Field Description Type Required Default Enum
defaultConnection The default connection key. string No - -
description User-defined description for the schema. string No - -
externalKey The external key for the object. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isHasContainers Specifies whether the schema has containers. boolean No - -
key The object key. string No - -
metadata DataAssetBucketSchemaMetadata defines nested fields for DataAsset.BucketSchema.Metadata. object No - -
modelType The object's type. string No - -
modelVersion The object's model version. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef DataAssetBucketSchemaParentRef defines nested fields for DataAsset.BucketSchema.ParentRef. object No - -
resourceName A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters. string No - -

Spec.bucketSchema.metadata

Back to DataAsset spec

DataAssetBucketSchemaMetadata defines nested fields for DataAsset.BucketSchema.Metadata.

Field Description Type Required Default Enum
aggregator DataAssetBucketSchemaMetadataAggregator defines nested fields for DataAsset.BucketSchema.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics DataAssetBucketSchemaMetadataCountStatistics defines nested fields for DataAsset.BucketSchema.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Spec.bucketSchema.metadata.aggregator

Back to DataAsset spec

DataAssetBucketSchemaMetadataAggregator defines nested fields for DataAsset.BucketSchema.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Spec.bucketSchema.metadata.countStatistics

Back to DataAsset spec

DataAssetBucketSchemaMetadataCountStatistics defines nested fields for DataAsset.BucketSchema.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Spec.bucketSchema.metadata.countStatistics.objectTypeCountList[]

Back to DataAsset spec

DataAssetBucketSchemaMetadataCountStatisticsObjectTypeCountList defines nested fields for DataAsset.BucketSchema.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Spec.bucketSchema.parentRef

Back to DataAsset spec

DataAssetBucketSchemaParentRef defines nested fields for DataAsset.BucketSchema.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.defaultConnection

Back to DataAsset spec

DataAssetDefaultConnection defines nested fields for DataAsset.DefaultConnection.

Field Description Type Required Default Enum
connectionProperties The properties for the connection. list[object] No - -
dataNodePrincipal The HDFS Data Node principal. string Yes - -
description User-defined description for the connection. string No - -
hdfsPrincipal The HDFS principal. string Yes - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string Yes - -
key Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create. string No - -
keyDistributionCenter The HDFS Key Distribution Center. string No - -
keyTabContent DataAssetDefaultConnectionKeyTabContent defines nested fields for DataAsset.DefaultConnection.KeyTabContent. object No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string Yes - -
nameNodePrincipal The HDFS Name Node principal. string Yes - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef DataAssetDefaultConnectionParentRef defines nested fields for DataAsset.DefaultConnection.ParentRef. object No - -
realm HDFS Realm name. string No - -
registryMetadata DataAssetDefaultConnectionRegistryMetadata defines nested fields for DataAsset.DefaultConnection.RegistryMetadata. object No - -

Spec.defaultConnection.connectionProperties[]

Back to DataAsset spec

DataAssetDefaultConnectionConnectionProperty defines nested fields for DataAsset.DefaultConnection.ConnectionProperty.

Field Description Type Required Default Enum
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
value The value for the connection name property. string No - -

Spec.defaultConnection.keyTabContent

Back to DataAsset spec

DataAssetDefaultConnectionKeyTabContent defines nested fields for DataAsset.DefaultConnection.KeyTabContent.

Field Description Type Required Default Enum
secretConfig DataAssetDefaultConnectionKeyTabContentSecretConfig defines nested fields for DataAsset.DefaultConnection.KeyTabContent.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.defaultConnection.keyTabContent.secretConfig

Back to DataAsset spec

DataAssetDefaultConnectionKeyTabContentSecretConfig defines nested fields for DataAsset.DefaultConnection.KeyTabContent.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.defaultConnection.parentRef

Back to DataAsset spec

DataAssetDefaultConnectionParentRef defines nested fields for DataAsset.DefaultConnection.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.defaultConnection.registryMetadata

Back to DataAsset spec

DataAssetDefaultConnectionRegistryMetadata defines nested fields for DataAsset.DefaultConnection.RegistryMetadata.

Field Description Type Required Default Enum
aggregatorKey The owning object's key for this object. string No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
key The identifying key for the object. string No - -
labels Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version. integer No - -

Spec.registryMetadata

Back to DataAsset spec

DataAssetRegistryMetadata defines nested fields for DataAsset.RegistryMetadata.

Field Description Type Required Default Enum
aggregatorKey The owning object's key for this object. string No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
key The identifying key for the object. string No - -
labels Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version. integer No - -

Spec.stagingConnection

Back to DataAsset spec

DataAssetStagingConnection defines nested fields for DataAsset.StagingConnection.

Field Description Type Required Default Enum
accessKey DataAssetStagingConnectionAccessKey defines nested fields for DataAsset.StagingConnection.AccessKey. object No - -
accessTokenUrl Specifies the endpoint used to exchange authentication credentials for access tokens string No - -
authHeader Optional header name if used other than default header(Authorization). string No - -
clientId Specifies the client ID key for specific application string No - -
clientSecret DataAssetStagingConnectionClientSecret defines nested fields for DataAsset.StagingConnection.ClientSecret. object No - -
connectionProperties The properties for the connection. list[object] No - -
credentialFileContent The credential file content from an Oracle Object Storage wallet. string No - -
dataNodePrincipal The HDFS Data Node principal. string No - -
defaultExternalStorage DataAssetStagingConnectionDefaultExternalStorage defines nested fields for DataAsset.StagingConnection.DefaultExternalStorage. object No - -
description User-defined description for the connection. string No - -
fingerPrint The fingerprint for the user. string No - -
grantType Specifies the OAuth2 grant mechanism. Example CLIENT_CREDENTIALS, Implicit Flow etc. string No - -
hdfsPrincipal The HDFS principal. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isDefault The default property for the connection. boolean No - -
jsonData - string No - -
key Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create. string No - -
keyDistributionCenter The HDFS Key Distribution Center. string No - -
keyMap A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. map[string, string] No - -
keyTabContent DataAssetStagingConnectionKeyTabContent defines nested fields for DataAsset.StagingConnection.KeyTabContent. object No - -
metadata DataAssetStagingConnectionMetadata defines nested fields for DataAsset.StagingConnection.Metadata. object No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
nameNodePrincipal The HDFS Name Node principal. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef DataAssetStagingConnectionParentRef defines nested fields for DataAsset.StagingConnection.ParentRef. object No - -
passPhrase The passphrase for the connection. string No - -
password The password for the connection. string No - -
passwordSecret DataAssetStagingConnectionPasswordSecret defines nested fields for DataAsset.StagingConnection.PasswordSecret. object No - -
primarySchema DataAssetStagingConnectionPrimarySchema defines nested fields for DataAsset.StagingConnection.PrimarySchema. object No - -
realm HDFS Realm name. string No - -
scope Specifies the OAuth scopes that limit the permissions granted by an access token. string No - -
secretKey DataAssetStagingConnectionSecretKey defines nested fields for DataAsset.StagingConnection.SecretKey. object No - -
tnsAlias The Autonomous Data Warehouse instance service name. string No - -
tnsNames Array of service names that are available for selection in the tnsAlias property. list[string] No - -
userId The OCI user OCID for the user to connect to. string No - -
username The user name for the connection. string No - -

Spec.stagingConnection.accessKey

Back to DataAsset spec

DataAssetStagingConnectionAccessKey defines nested fields for DataAsset.StagingConnection.AccessKey.

Field Description Type Required Default Enum
secretConfig DataAssetStagingConnectionAccessKeySecretConfig defines nested fields for DataAsset.StagingConnection.AccessKey.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.stagingConnection.accessKey.secretConfig

Back to DataAsset spec

DataAssetStagingConnectionAccessKeySecretConfig defines nested fields for DataAsset.StagingConnection.AccessKey.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.stagingConnection.clientSecret

Back to DataAsset spec

DataAssetStagingConnectionClientSecret defines nested fields for DataAsset.StagingConnection.ClientSecret.

Field Description Type Required Default Enum
secretConfig DataAssetStagingConnectionClientSecretSecretConfig defines nested fields for DataAsset.StagingConnection.ClientSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.stagingConnection.clientSecret.secretConfig

Back to DataAsset spec

DataAssetStagingConnectionClientSecretSecretConfig defines nested fields for DataAsset.StagingConnection.ClientSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.stagingConnection.connectionProperties[]

Back to DataAsset spec

DataAssetStagingConnectionConnectionProperty defines nested fields for DataAsset.StagingConnection.ConnectionProperty.

Field Description Type Required Default Enum
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
value The value for the connection name property. string No - -

Spec.stagingConnection.defaultExternalStorage

Back to DataAsset spec

DataAssetStagingConnectionDefaultExternalStorage defines nested fields for DataAsset.StagingConnection.DefaultExternalStorage.

Field Description Type Required Default Enum
bucket Bucket Name where BICC extracts stores the files string No - -
host Object Storage host Url. DO not give http/https. string No - -
namespace Namespace for the OOS bucket string No - -
storageId Id of the external stoarge configured in BICC console. Usually its numeric. string No - -
storageName Name of the external storage configured in BICC console string No - -
tenancyId Tenancy OCID for the OOS bucket string No - -

Spec.stagingConnection.keyTabContent

Back to DataAsset spec

DataAssetStagingConnectionKeyTabContent defines nested fields for DataAsset.StagingConnection.KeyTabContent.

Field Description Type Required Default Enum
secretConfig DataAssetStagingConnectionKeyTabContentSecretConfig defines nested fields for DataAsset.StagingConnection.KeyTabContent.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.stagingConnection.keyTabContent.secretConfig

Back to DataAsset spec

DataAssetStagingConnectionKeyTabContentSecretConfig defines nested fields for DataAsset.StagingConnection.KeyTabContent.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.stagingConnection.metadata

Back to DataAsset spec

DataAssetStagingConnectionMetadata defines nested fields for DataAsset.StagingConnection.Metadata.

Field Description Type Required Default Enum
aggregator DataAssetStagingConnectionMetadataAggregator defines nested fields for DataAsset.StagingConnection.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics DataAssetStagingConnectionMetadataCountStatistics defines nested fields for DataAsset.StagingConnection.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Spec.stagingConnection.metadata.aggregator

Back to DataAsset spec

DataAssetStagingConnectionMetadataAggregator defines nested fields for DataAsset.StagingConnection.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Spec.stagingConnection.metadata.countStatistics

Back to DataAsset spec

DataAssetStagingConnectionMetadataCountStatistics defines nested fields for DataAsset.StagingConnection.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Spec.stagingConnection.metadata.countStatistics.objectTypeCountList[]

Back to DataAsset spec

DataAssetStagingConnectionMetadataCountStatisticsObjectTypeCountList defines nested fields for DataAsset.StagingConnection.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Spec.stagingConnection.parentRef

Back to DataAsset spec

DataAssetStagingConnectionParentRef defines nested fields for DataAsset.StagingConnection.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.stagingConnection.passwordSecret

Back to DataAsset spec

DataAssetStagingConnectionPasswordSecret defines nested fields for DataAsset.StagingConnection.PasswordSecret.

Field Description Type Required Default Enum
secretConfig DataAssetStagingConnectionPasswordSecretSecretConfig defines nested fields for DataAsset.StagingConnection.PasswordSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.stagingConnection.passwordSecret.secretConfig

Back to DataAsset spec

DataAssetStagingConnectionPasswordSecretSecretConfig defines nested fields for DataAsset.StagingConnection.PasswordSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.stagingConnection.primarySchema

Back to DataAsset spec

DataAssetStagingConnectionPrimarySchema defines nested fields for DataAsset.StagingConnection.PrimarySchema.

Field Description Type Required Default Enum
defaultConnection The default connection key. string No - -
description User-defined description for the schema. string No - -
externalKey The external key for the object. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isHasContainers Specifies whether the schema has containers. boolean No - -
key The object key. string No - -
metadata DataAssetStagingConnectionPrimarySchemaMetadata defines nested fields for DataAsset.StagingConnection.PrimarySchema.Metadata. object No - -
modelType The object's type. string No - -
modelVersion The object's model version. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef DataAssetStagingConnectionPrimarySchemaParentRef defines nested fields for DataAsset.StagingConnection.PrimarySchema.ParentRef. object No - -
resourceName A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters. string No - -

Spec.stagingConnection.primarySchema.metadata

Back to DataAsset spec

DataAssetStagingConnectionPrimarySchemaMetadata defines nested fields for DataAsset.StagingConnection.PrimarySchema.Metadata.

Field Description Type Required Default Enum
aggregator DataAssetStagingConnectionPrimarySchemaMetadataAggregator defines nested fields for DataAsset.StagingConnection.PrimarySchema.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics DataAssetStagingConnectionPrimarySchemaMetadataCountStatistics defines nested fields for DataAsset.StagingConnection.PrimarySchema.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Spec.stagingConnection.primarySchema.metadata.aggregator

Back to DataAsset spec

DataAssetStagingConnectionPrimarySchemaMetadataAggregator defines nested fields for DataAsset.StagingConnection.PrimarySchema.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Spec.stagingConnection.primarySchema.metadata.countStatistics

Back to DataAsset spec

DataAssetStagingConnectionPrimarySchemaMetadataCountStatistics defines nested fields for DataAsset.StagingConnection.PrimarySchema.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Spec.stagingConnection.primarySchema.metadata.countStatistics.objectTypeCountList[]

Back to DataAsset spec

DataAssetStagingConnectionPrimarySchemaMetadataCountStatisticsObjectTypeCountList defines nested fields for DataAsset.StagingConnection.PrimarySchema.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Spec.stagingConnection.primarySchema.parentRef

Back to DataAsset spec

DataAssetStagingConnectionPrimarySchemaParentRef defines nested fields for DataAsset.StagingConnection.PrimarySchema.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.stagingConnection.secretKey

Back to DataAsset spec

DataAssetStagingConnectionSecretKey defines nested fields for DataAsset.StagingConnection.SecretKey.

Field Description Type Required Default Enum
secretConfig DataAssetStagingConnectionSecretKeySecretConfig defines nested fields for DataAsset.StagingConnection.SecretKey.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.stagingConnection.secretKey.secretConfig

Back to DataAsset spec

DataAssetStagingConnectionSecretKeySecretConfig defines nested fields for DataAsset.StagingConnection.SecretKey.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.stagingDataAsset

Back to DataAsset spec

DataAssetStagingDataAsset defines nested fields for DataAsset.StagingDataAsset.

Field Description Type Required Default Enum
assetProperties Additional properties for the data asset. map[string, string] No - -
baseUrl The base url of the rest server. string No - -
bucketSchema DataAssetStagingDataAssetBucketSchema defines nested fields for DataAsset.StagingDataAsset.BucketSchema. object No - -
credentialFileContent The credential file content from a wallet for the data asset. string No - -
dataAssetType The data asset type for the generic JDBC data asset. string No - -
defaultConnection DataAssetStagingDataAssetDefaultConnection defines nested fields for DataAsset.StagingDataAsset.DefaultConnection. object No - -
description User-defined description of the data asset. string No - -
driverClass The Oracle Database driver class. string No - -
externalKey The external key for the object. string No - -
host The generic JDBC host name. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
jsonData - string No - -
key Generated key that can be used in API calls to identify data asset. string No - -
keyMap A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. map[string, string] No - -
lakeId The Lake Ocid. string No - -
lakeProxyEndpoint The lakeProxyEndpoint for the specified Lake Resource. string No - -
manifestFileContent The manifest file content of the rest APIs. string No - -
metadata DataAssetStagingDataAssetMetadata defines nested fields for DataAsset.StagingDataAsset.Metadata. object No - -
metastoreId The metastoreId for the specified Lake Resource. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
namespace The namespace for the specified Oracle Object storage resource. You can find the namespace under Object Storage Settings in the Console. string No - -
nativeTypeSystem DataAssetStagingDataAssetNativeTypeSystem defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem. object No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
ociRegion The Oracle Object storage Region ie. us-ashburn-1 string No - -
parentRef DataAssetStagingDataAssetParentRef defines nested fields for DataAsset.StagingDataAsset.ParentRef. object No - -
port The generic JDBC port number. string No - -
protocol The HDFS Protocol name. string No - -
region The region for Amazon s3 string No - -
serviceName The Oracle Database service name. string No - -
serviceNames Array of service names that are available for selection in the serviceName property. list[string] No - -
serviceUrl The service url of the BI Server. string No - -
sid The Oracle Database SID. string No - -
stagingConnection DataAssetStagingDataAssetStagingConnection defines nested fields for DataAsset.StagingDataAsset.StagingConnection. object No - -
stagingDataAsset JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
tenancyId The OCI tenancy OCID. string No - -
url The Oracle Object storage URL. string No - -
validateCertificate Specifies whether certificate validation is needed boolean No - -
walletPasswordSecret DataAssetStagingDataAssetWalletPasswordSecret defines nested fields for DataAsset.StagingDataAsset.WalletPasswordSecret. object No - -
walletSecret DataAssetStagingDataAssetWalletSecret defines nested fields for DataAsset.StagingDataAsset.WalletSecret. object No - -

Spec.stagingDataAsset.bucketSchema

Back to DataAsset spec

DataAssetStagingDataAssetBucketSchema defines nested fields for DataAsset.StagingDataAsset.BucketSchema.

Field Description Type Required Default Enum
defaultConnection The default connection key. string No - -
description User-defined description for the schema. string No - -
externalKey The external key for the object. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isHasContainers Specifies whether the schema has containers. boolean No - -
key The object key. string No - -
metadata DataAssetStagingDataAssetBucketSchemaMetadata defines nested fields for DataAsset.StagingDataAsset.BucketSchema.Metadata. object No - -
modelType The object's type. string No - -
modelVersion The object's model version. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef DataAssetStagingDataAssetBucketSchemaParentRef defines nested fields for DataAsset.StagingDataAsset.BucketSchema.ParentRef. object No - -
resourceName A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters. string No - -

Spec.stagingDataAsset.bucketSchema.metadata

Back to DataAsset spec

DataAssetStagingDataAssetBucketSchemaMetadata defines nested fields for DataAsset.StagingDataAsset.BucketSchema.Metadata.

Field Description Type Required Default Enum
aggregator DataAssetStagingDataAssetBucketSchemaMetadataAggregator defines nested fields for DataAsset.StagingDataAsset.BucketSchema.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics DataAssetStagingDataAssetBucketSchemaMetadataCountStatistics defines nested fields for DataAsset.StagingDataAsset.BucketSchema.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Spec.stagingDataAsset.bucketSchema.metadata.aggregator

Back to DataAsset spec

DataAssetStagingDataAssetBucketSchemaMetadataAggregator defines nested fields for DataAsset.StagingDataAsset.BucketSchema.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Spec.stagingDataAsset.bucketSchema.metadata.countStatistics

Back to DataAsset spec

DataAssetStagingDataAssetBucketSchemaMetadataCountStatistics defines nested fields for DataAsset.StagingDataAsset.BucketSchema.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Spec.stagingDataAsset.bucketSchema.metadata.countStatistics.objectTypeCountList[]

Back to DataAsset spec

DataAssetStagingDataAssetBucketSchemaMetadataCountStatisticsObjectTypeCountList defines nested fields for DataAsset.StagingDataAsset.BucketSchema.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Spec.stagingDataAsset.bucketSchema.parentRef

Back to DataAsset spec

DataAssetStagingDataAssetBucketSchemaParentRef defines nested fields for DataAsset.StagingDataAsset.BucketSchema.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.stagingDataAsset.defaultConnection

Back to DataAsset spec

DataAssetStagingDataAssetDefaultConnection defines nested fields for DataAsset.StagingDataAsset.DefaultConnection.

Field Description Type Required Default Enum
connectionProperties The properties for the connection. list[object] No - -
description User-defined description for the connection. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isDefault The default property for the connection. boolean No - -
key Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create. string No - -
metadata DataAssetStagingDataAssetDefaultConnectionMetadata defines nested fields for DataAsset.StagingDataAsset.DefaultConnection.Metadata. object No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef DataAssetStagingDataAssetDefaultConnectionParentRef defines nested fields for DataAsset.StagingDataAsset.DefaultConnection.ParentRef. object No - -
primarySchema DataAssetStagingDataAssetDefaultConnectionPrimarySchema defines nested fields for DataAsset.StagingDataAsset.DefaultConnection.PrimarySchema. object No - -
username The user name for the connection. string No - -

Spec.stagingDataAsset.defaultConnection.connectionProperties[]

Back to DataAsset spec

DataAssetStagingDataAssetDefaultConnectionConnectionProperty defines nested fields for DataAsset.StagingDataAsset.DefaultConnection.ConnectionProperty.

Field Description Type Required Default Enum
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
value The value for the connection name property. string No - -

Spec.stagingDataAsset.defaultConnection.metadata

Back to DataAsset spec

DataAssetStagingDataAssetDefaultConnectionMetadata defines nested fields for DataAsset.StagingDataAsset.DefaultConnection.Metadata.

Field Description Type Required Default Enum
aggregator DataAssetStagingDataAssetDefaultConnectionMetadataAggregator defines nested fields for DataAsset.StagingDataAsset.DefaultConnection.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics DataAssetStagingDataAssetDefaultConnectionMetadataCountStatistics defines nested fields for DataAsset.StagingDataAsset.DefaultConnection.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Spec.stagingDataAsset.defaultConnection.metadata.aggregator

Back to DataAsset spec

DataAssetStagingDataAssetDefaultConnectionMetadataAggregator defines nested fields for DataAsset.StagingDataAsset.DefaultConnection.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Spec.stagingDataAsset.defaultConnection.metadata.countStatistics

Back to DataAsset spec

DataAssetStagingDataAssetDefaultConnectionMetadataCountStatistics defines nested fields for DataAsset.StagingDataAsset.DefaultConnection.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Spec.stagingDataAsset.defaultConnection.metadata.countStatistics.objectTypeCountList[]

Back to DataAsset spec

DataAssetStagingDataAssetDefaultConnectionMetadataCountStatisticsObjectTypeCountList defines nested fields for DataAsset.StagingDataAsset.DefaultConnection.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Spec.stagingDataAsset.defaultConnection.parentRef

Back to DataAsset spec

DataAssetStagingDataAssetDefaultConnectionParentRef defines nested fields for DataAsset.StagingDataAsset.DefaultConnection.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.stagingDataAsset.defaultConnection.primarySchema

Back to DataAsset spec

DataAssetStagingDataAssetDefaultConnectionPrimarySchema defines nested fields for DataAsset.StagingDataAsset.DefaultConnection.PrimarySchema.

Field Description Type Required Default Enum
defaultConnection The default connection key. string No - -
description User-defined description for the schema. string No - -
externalKey The external key for the object. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isHasContainers Specifies whether the schema has containers. boolean No - -
key The object key. string No - -
metadata DataAssetStagingDataAssetDefaultConnectionPrimarySchemaMetadata defines nested fields for DataAsset.StagingDataAsset.DefaultConnection.PrimarySchema.Metadata. object No - -
modelType The object's type. string No - -
modelVersion The object's model version. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef DataAssetStagingDataAssetDefaultConnectionPrimarySchemaParentRef defines nested fields for DataAsset.StagingDataAsset.DefaultConnection.PrimarySchema.ParentRef. object No - -
resourceName A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters. string No - -

Spec.stagingDataAsset.defaultConnection.primarySchema.metadata

Back to DataAsset spec

DataAssetStagingDataAssetDefaultConnectionPrimarySchemaMetadata defines nested fields for DataAsset.StagingDataAsset.DefaultConnection.PrimarySchema.Metadata.

Field Description Type Required Default Enum
aggregator DataAssetStagingDataAssetDefaultConnectionPrimarySchemaMetadataAggregator defines nested fields for DataAsset.StagingDataAsset.DefaultConnection.PrimarySchema.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics DataAssetStagingDataAssetDefaultConnectionPrimarySchemaMetadataCountStatistics defines nested fields for DataAsset.StagingDataAsset.DefaultConnection.PrimarySchema.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Spec.stagingDataAsset.defaultConnection.primarySchema.metadata.aggregator

Back to DataAsset spec

DataAssetStagingDataAssetDefaultConnectionPrimarySchemaMetadataAggregator defines nested fields for DataAsset.StagingDataAsset.DefaultConnection.PrimarySchema.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Spec.stagingDataAsset.defaultConnection.primarySchema.metadata.countStatistics

Back to DataAsset spec

DataAssetStagingDataAssetDefaultConnectionPrimarySchemaMetadataCountStatistics defines nested fields for DataAsset.StagingDataAsset.DefaultConnection.PrimarySchema.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Spec.stagingDataAsset.defaultConnection.primarySchema.metadata.countStatistics.objectTypeCountList[]

Back to DataAsset spec

DataAssetStagingDataAssetDefaultConnectionPrimarySchemaMetadataCountStatisticsObjectTypeCountList defines nested fields for DataAsset.StagingDataAsset.DefaultConnection.PrimarySchema.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Spec.stagingDataAsset.defaultConnection.primarySchema.parentRef

Back to DataAsset spec

DataAssetStagingDataAssetDefaultConnectionPrimarySchemaParentRef defines nested fields for DataAsset.StagingDataAsset.DefaultConnection.PrimarySchema.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.stagingDataAsset.metadata

Back to DataAsset spec

DataAssetStagingDataAssetMetadata defines nested fields for DataAsset.StagingDataAsset.Metadata.

Field Description Type Required Default Enum
aggregator DataAssetStagingDataAssetMetadataAggregator defines nested fields for DataAsset.StagingDataAsset.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics DataAssetStagingDataAssetMetadataCountStatistics defines nested fields for DataAsset.StagingDataAsset.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Spec.stagingDataAsset.metadata.aggregator

Back to DataAsset spec

DataAssetStagingDataAssetMetadataAggregator defines nested fields for DataAsset.StagingDataAsset.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Spec.stagingDataAsset.metadata.countStatistics

Back to DataAsset spec

DataAssetStagingDataAssetMetadataCountStatistics defines nested fields for DataAsset.StagingDataAsset.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Spec.stagingDataAsset.metadata.countStatistics.objectTypeCountList[]

Back to DataAsset spec

DataAssetStagingDataAssetMetadataCountStatisticsObjectTypeCountList defines nested fields for DataAsset.StagingDataAsset.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Spec.stagingDataAsset.nativeTypeSystem

Back to DataAsset spec

DataAssetStagingDataAssetNativeTypeSystem defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.

Field Description Type Required Default Enum
description A user defined description for the object. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
key The key of the object. string No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef DataAssetStagingDataAssetNativeTypeSystemParentRef defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.ParentRef. object No - -
typeMappingFrom The type system to map from. map[string, string] No - -
typeMappingTo The type system to map to. map[string, string] No - -
types An array of types. list[object] No - -

Spec.stagingDataAsset.nativeTypeSystem.parentRef

Back to DataAsset spec

DataAssetStagingDataAssetNativeTypeSystemParentRef defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.stagingDataAsset.nativeTypeSystem.types[]

Back to DataAsset spec

DataAssetStagingDataAssetNativeTypeSystemType defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.

Field Description Type Required Default Enum
configDefinition DataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinition defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition. object No - -
description A user defined description for the object. string No - -
dtType The data type. string No - -
key The key of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef DataAssetStagingDataAssetNativeTypeSystemTypeParentRef defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ParentRef. object No - -
typeSystemName The data type system name. string No - -

Spec.stagingDataAsset.nativeTypeSystem.types[].configDefinition

Back to DataAsset spec

DataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinition defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.

Field Description Type Required Default Enum
configParameterDefinitions The parameter configuration details. map[string, object] No - -
isContained Specifies whether the configuration is contained or not. boolean No - -
key The key of the object. string No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef DataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionParentRef defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ParentRef. object No - -

Spec.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}

Back to DataAsset spec

DataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitions defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.

Field Description Type Required Default Enum
classFieldName The parameter class field name. string No - -
defaultValue The default value for the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
description A user defined description for the object. string No - -
isClassFieldValue Specifies whether the parameter is a class field or not. boolean No - -
isStatic Specifies whether the parameter is static or not. boolean No - -
parameterName This object represents the configurable properties for an object type. string No - -
parameterType DataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterType defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType. object No - -

Spec.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType

Back to DataAsset spec

DataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterType defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.

Field Description Type Required Default Enum
configDefinition JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
configValues DataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValues defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues. object No - -
containsNull Defines whether null values are allowed. boolean No - -
description A user defined description for the object. string No - -
dtType The data type. string No - -
elementType Seeded type string No - -
elements An array of elements. list[string] No - -
javaTypeName The java type name. string No - -
jsonData - string No - -
key The key of the object. string No - -
keyElementType Seeded type string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef DataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeParentRef defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ParentRef. object No - -
pathNames An array of path names corresponding to the elements. The path names are used when referring to the field in an expression. list[string] No - -
typeHandler DataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandler defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler. object No - -
typeSystemName The data type system name. string No - -
valueElementType Seeded type string No - -
wrappedType A wrapped type, may be a string or a BaseType. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Spec.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.configValues

Back to DataAsset spec

DataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValues defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef DataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesParentRef defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ParentRef. object No - -

Spec.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.configValues.configParamValues{}

Back to DataAsset spec

DataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesConfigParamValues defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.configValues.parentRef

Back to DataAsset spec

DataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesParentRef defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.parentRef

Back to DataAsset spec

DataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeParentRef defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler

Back to DataAsset spec

DataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandler defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.

Field Description Type Required Default Enum
configValues DataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValues defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues. object No - -
flattenDetails Contains a key for referencing the flattenDetails information. string No - -
isOrderByRule Specifies whether it is ordered by rule. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef DataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerParentRef defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ParentRef. object No - -
projectionRules The projection rules. list[object] No - -
scope Reference key for the typed object. string No - -
scopeReference DataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerScopeReference defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ScopeReference. object No - -

Spec.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues

Back to DataAsset spec

DataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValues defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef DataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesParentRef defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ParentRef. object No - -

Spec.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues.configParamValues{}

Back to DataAsset spec

DataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesConfigParamValues defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues.parentRef

Back to DataAsset spec

DataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesParentRef defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.parentRef

Back to DataAsset spec

DataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerParentRef defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[]

Back to DataAsset spec

DataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRule defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.

Field Description Type Required Default Enum
configValues DataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValues defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues. object No - -
description A user defined description for the object. string No - -
fromName The attribute name that needs to be renamed. string No - -
isCascade Specifies whether to cascade or not. boolean No - -
isCaseSensitive Specifies if the rule is case sensitive. boolean No - -
isJavaRegexSyntax Specifies whether the rule uses a java regex syntax. boolean No - -
isSkipRemainingRulesOnMatch Specifies whether to skip remaining rules when a match is found. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
matchingStrategy The pattern matching strategy. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Name of the group. string No - -
names Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. list[string] No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef DataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleParentRef defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ParentRef. object No - -
pattern The rule pattern. string No - -
ruleType The rule type. string No - -
scope Reference to a typed object. This can be either a key value to an object within the document, a shall referenced to a TypedObject, or a full TypedObject definition. Unknown nested fields are preserved. object (preserves unknown fields) No - -
toName The new attribute name. string No - -
types An arry of types. list[object (preserves unknown fields)] No - -

Spec.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues

Back to DataAsset spec

DataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValues defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef DataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ParentRef. object No - -

Spec.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues.configParamValues{}

Back to DataAsset spec

DataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesConfigParamValues defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues.parentRef

Back to DataAsset spec

DataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].parentRef

Back to DataAsset spec

DataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleParentRef defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.stagingDataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.scopeReference

Back to DataAsset spec

DataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerScopeReference defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ScopeReference.

Field Description Type Required Default Enum
refObjectName The referenced object name for this reference. Set to the field name if the referenceType is BOUND_ENTITY_SHAPE_FIELD, else set to null. string No - -
referenceObject A key or shallow reference to an object. For direct reference, it points to the actual scope object. For BOUND_ENTITY_SHAPE or BOUND_ENTITY_SHAPE_FIELD, it points to the source or target operator. For OCI_FUNCTION_INPUT_SHAPE or OCI_FUNCTION_OUTPUT_SHAPE, it points to the OCI Function object. string Yes - -
referenceType The reference type for this reference. Set to null for a direct reference, for indirect references set to a type of association such as "BOUND_ENTITY_SHAPE". Current known reference type values are "BOUND_ENTITY_SHAPE", "BOUND_ENTITY_SHAPE_FIELD", "OCI_FUNCTION_INPUT_SHAPE", "OCI_FUNCTION_OUTPUT_SHAPE" string No - -

Spec.stagingDataAsset.nativeTypeSystem.types[].configDefinition.parentRef

Back to DataAsset spec

DataAssetStagingDataAssetNativeTypeSystemTypeConfigDefinitionParentRef defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ConfigDefinition.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.stagingDataAsset.nativeTypeSystem.types[].parentRef

Back to DataAsset spec

DataAssetStagingDataAssetNativeTypeSystemTypeParentRef defines nested fields for DataAsset.StagingDataAsset.NativeTypeSystem.Type.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.stagingDataAsset.parentRef

Back to DataAsset spec

DataAssetStagingDataAssetParentRef defines nested fields for DataAsset.StagingDataAsset.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.stagingDataAsset.stagingConnection

Back to DataAsset spec

DataAssetStagingDataAssetStagingConnection defines nested fields for DataAsset.StagingDataAsset.StagingConnection.

Field Description Type Required Default Enum
accessKey DataAssetStagingDataAssetStagingConnectionAccessKey defines nested fields for DataAsset.StagingDataAsset.StagingConnection.AccessKey. object No - -
accessTokenUrl Specifies the endpoint used to exchange authentication credentials for access tokens string No - -
authHeader Optional header name if used other than default header(Authorization). string No - -
clientId Specifies the client ID key for specific application string No - -
clientSecret DataAssetStagingDataAssetStagingConnectionClientSecret defines nested fields for DataAsset.StagingDataAsset.StagingConnection.ClientSecret. object No - -
connectionProperties The properties for the connection. list[object] No - -
credentialFileContent The credential file content from an Oracle Object Storage wallet. string No - -
dataNodePrincipal The HDFS Data Node principal. string No - -
defaultExternalStorage DataAssetStagingDataAssetStagingConnectionDefaultExternalStorage defines nested fields for DataAsset.StagingDataAsset.StagingConnection.DefaultExternalStorage. object No - -
description User-defined description for the connection. string No - -
fingerPrint The fingerprint for the user. string No - -
grantType Specifies the OAuth2 grant mechanism. Example CLIENT_CREDENTIALS, Implicit Flow etc. string No - -
hdfsPrincipal The HDFS principal. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isDefault The default property for the connection. boolean No - -
jsonData - string No - -
key Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create. string No - -
keyDistributionCenter The HDFS Key Distribution Center. string No - -
keyMap A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. map[string, string] No - -
keyTabContent DataAssetStagingDataAssetStagingConnectionKeyTabContent defines nested fields for DataAsset.StagingDataAsset.StagingConnection.KeyTabContent. object No - -
metadata DataAssetStagingDataAssetStagingConnectionMetadata defines nested fields for DataAsset.StagingDataAsset.StagingConnection.Metadata. object No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
nameNodePrincipal The HDFS Name Node principal. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef DataAssetStagingDataAssetStagingConnectionParentRef defines nested fields for DataAsset.StagingDataAsset.StagingConnection.ParentRef. object No - -
passPhrase The passphrase for the connection. string No - -
password The password for the connection. string No - -
passwordSecret DataAssetStagingDataAssetStagingConnectionPasswordSecret defines nested fields for DataAsset.StagingDataAsset.StagingConnection.PasswordSecret. object No - -
primarySchema DataAssetStagingDataAssetStagingConnectionPrimarySchema defines nested fields for DataAsset.StagingDataAsset.StagingConnection.PrimarySchema. object No - -
realm HDFS Realm name. string No - -
scope Specifies the OAuth scopes that limit the permissions granted by an access token. string No - -
secretKey DataAssetStagingDataAssetStagingConnectionSecretKey defines nested fields for DataAsset.StagingDataAsset.StagingConnection.SecretKey. object No - -
tnsAlias The Autonomous Data Warehouse instance service name. string No - -
tnsNames Array of service names that are available for selection in the tnsAlias property. list[string] No - -
userId The OCI user OCID for the user to connect to. string No - -
username The user name for the connection. string No - -

Spec.stagingDataAsset.stagingConnection.accessKey

Back to DataAsset spec

DataAssetStagingDataAssetStagingConnectionAccessKey defines nested fields for DataAsset.StagingDataAsset.StagingConnection.AccessKey.

Field Description Type Required Default Enum
secretConfig DataAssetStagingDataAssetStagingConnectionAccessKeySecretConfig defines nested fields for DataAsset.StagingDataAsset.StagingConnection.AccessKey.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.stagingDataAsset.stagingConnection.accessKey.secretConfig

Back to DataAsset spec

DataAssetStagingDataAssetStagingConnectionAccessKeySecretConfig defines nested fields for DataAsset.StagingDataAsset.StagingConnection.AccessKey.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.stagingDataAsset.stagingConnection.clientSecret

Back to DataAsset spec

DataAssetStagingDataAssetStagingConnectionClientSecret defines nested fields for DataAsset.StagingDataAsset.StagingConnection.ClientSecret.

Field Description Type Required Default Enum
secretConfig DataAssetStagingDataAssetStagingConnectionClientSecretSecretConfig defines nested fields for DataAsset.StagingDataAsset.StagingConnection.ClientSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.stagingDataAsset.stagingConnection.clientSecret.secretConfig

Back to DataAsset spec

DataAssetStagingDataAssetStagingConnectionClientSecretSecretConfig defines nested fields for DataAsset.StagingDataAsset.StagingConnection.ClientSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.stagingDataAsset.stagingConnection.connectionProperties[]

Back to DataAsset spec

DataAssetStagingDataAssetStagingConnectionConnectionProperty defines nested fields for DataAsset.StagingDataAsset.StagingConnection.ConnectionProperty.

Field Description Type Required Default Enum
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
value The value for the connection name property. string No - -

Spec.stagingDataAsset.stagingConnection.defaultExternalStorage

Back to DataAsset spec

DataAssetStagingDataAssetStagingConnectionDefaultExternalStorage defines nested fields for DataAsset.StagingDataAsset.StagingConnection.DefaultExternalStorage.

Field Description Type Required Default Enum
bucket Bucket Name where BICC extracts stores the files string No - -
host Object Storage host Url. DO not give http/https. string No - -
namespace Namespace for the OOS bucket string No - -
storageId Id of the external stoarge configured in BICC console. Usually its numeric. string No - -
storageName Name of the external storage configured in BICC console string No - -
tenancyId Tenancy OCID for the OOS bucket string No - -

Spec.stagingDataAsset.stagingConnection.keyTabContent

Back to DataAsset spec

DataAssetStagingDataAssetStagingConnectionKeyTabContent defines nested fields for DataAsset.StagingDataAsset.StagingConnection.KeyTabContent.

Field Description Type Required Default Enum
secretConfig DataAssetStagingDataAssetStagingConnectionKeyTabContentSecretConfig defines nested fields for DataAsset.StagingDataAsset.StagingConnection.KeyTabContent.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.stagingDataAsset.stagingConnection.keyTabContent.secretConfig

Back to DataAsset spec

DataAssetStagingDataAssetStagingConnectionKeyTabContentSecretConfig defines nested fields for DataAsset.StagingDataAsset.StagingConnection.KeyTabContent.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.stagingDataAsset.stagingConnection.metadata

Back to DataAsset spec

DataAssetStagingDataAssetStagingConnectionMetadata defines nested fields for DataAsset.StagingDataAsset.StagingConnection.Metadata.

Field Description Type Required Default Enum
aggregator DataAssetStagingDataAssetStagingConnectionMetadataAggregator defines nested fields for DataAsset.StagingDataAsset.StagingConnection.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics DataAssetStagingDataAssetStagingConnectionMetadataCountStatistics defines nested fields for DataAsset.StagingDataAsset.StagingConnection.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Spec.stagingDataAsset.stagingConnection.metadata.aggregator

Back to DataAsset spec

DataAssetStagingDataAssetStagingConnectionMetadataAggregator defines nested fields for DataAsset.StagingDataAsset.StagingConnection.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Spec.stagingDataAsset.stagingConnection.metadata.countStatistics

Back to DataAsset spec

DataAssetStagingDataAssetStagingConnectionMetadataCountStatistics defines nested fields for DataAsset.StagingDataAsset.StagingConnection.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Spec.stagingDataAsset.stagingConnection.metadata.countStatistics.objectTypeCountList[]

Back to DataAsset spec

DataAssetStagingDataAssetStagingConnectionMetadataCountStatisticsObjectTypeCountList defines nested fields for DataAsset.StagingDataAsset.StagingConnection.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Spec.stagingDataAsset.stagingConnection.parentRef

Back to DataAsset spec

DataAssetStagingDataAssetStagingConnectionParentRef defines nested fields for DataAsset.StagingDataAsset.StagingConnection.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.stagingDataAsset.stagingConnection.passwordSecret

Back to DataAsset spec

DataAssetStagingDataAssetStagingConnectionPasswordSecret defines nested fields for DataAsset.StagingDataAsset.StagingConnection.PasswordSecret.

Field Description Type Required Default Enum
secretConfig DataAssetStagingDataAssetStagingConnectionPasswordSecretSecretConfig defines nested fields for DataAsset.StagingDataAsset.StagingConnection.PasswordSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.stagingDataAsset.stagingConnection.passwordSecret.secretConfig

Back to DataAsset spec

DataAssetStagingDataAssetStagingConnectionPasswordSecretSecretConfig defines nested fields for DataAsset.StagingDataAsset.StagingConnection.PasswordSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.stagingDataAsset.stagingConnection.primarySchema

Back to DataAsset spec

DataAssetStagingDataAssetStagingConnectionPrimarySchema defines nested fields for DataAsset.StagingDataAsset.StagingConnection.PrimarySchema.

Field Description Type Required Default Enum
defaultConnection The default connection key. string No - -
description User-defined description for the schema. string No - -
externalKey The external key for the object. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isHasContainers Specifies whether the schema has containers. boolean No - -
key The object key. string No - -
metadata DataAssetStagingDataAssetStagingConnectionPrimarySchemaMetadata defines nested fields for DataAsset.StagingDataAsset.StagingConnection.PrimarySchema.Metadata. object No - -
modelType The object's type. string No - -
modelVersion The object's model version. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef DataAssetStagingDataAssetStagingConnectionPrimarySchemaParentRef defines nested fields for DataAsset.StagingDataAsset.StagingConnection.PrimarySchema.ParentRef. object No - -
resourceName A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters. string No - -

Spec.stagingDataAsset.stagingConnection.primarySchema.metadata

Back to DataAsset spec

DataAssetStagingDataAssetStagingConnectionPrimarySchemaMetadata defines nested fields for DataAsset.StagingDataAsset.StagingConnection.PrimarySchema.Metadata.

Field Description Type Required Default Enum
aggregator DataAssetStagingDataAssetStagingConnectionPrimarySchemaMetadataAggregator defines nested fields for DataAsset.StagingDataAsset.StagingConnection.PrimarySchema.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics DataAssetStagingDataAssetStagingConnectionPrimarySchemaMetadataCountStatistics defines nested fields for DataAsset.StagingDataAsset.StagingConnection.PrimarySchema.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Spec.stagingDataAsset.stagingConnection.primarySchema.metadata.aggregator

Back to DataAsset spec

DataAssetStagingDataAssetStagingConnectionPrimarySchemaMetadataAggregator defines nested fields for DataAsset.StagingDataAsset.StagingConnection.PrimarySchema.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Spec.stagingDataAsset.stagingConnection.primarySchema.metadata.countStatistics

Back to DataAsset spec

DataAssetStagingDataAssetStagingConnectionPrimarySchemaMetadataCountStatistics defines nested fields for DataAsset.StagingDataAsset.StagingConnection.PrimarySchema.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Spec.stagingDataAsset.stagingConnection.primarySchema.metadata.countStatistics.objectTypeCountList[]

Back to DataAsset spec

DataAssetStagingDataAssetStagingConnectionPrimarySchemaMetadataCountStatisticsObjectTypeCountList defines nested fields for DataAsset.StagingDataAsset.StagingConnection.PrimarySchema.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Spec.stagingDataAsset.stagingConnection.primarySchema.parentRef

Back to DataAsset spec

DataAssetStagingDataAssetStagingConnectionPrimarySchemaParentRef defines nested fields for DataAsset.StagingDataAsset.StagingConnection.PrimarySchema.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.stagingDataAsset.stagingConnection.secretKey

Back to DataAsset spec

DataAssetStagingDataAssetStagingConnectionSecretKey defines nested fields for DataAsset.StagingDataAsset.StagingConnection.SecretKey.

Field Description Type Required Default Enum
secretConfig DataAssetStagingDataAssetStagingConnectionSecretKeySecretConfig defines nested fields for DataAsset.StagingDataAsset.StagingConnection.SecretKey.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.stagingDataAsset.stagingConnection.secretKey.secretConfig

Back to DataAsset spec

DataAssetStagingDataAssetStagingConnectionSecretKeySecretConfig defines nested fields for DataAsset.StagingDataAsset.StagingConnection.SecretKey.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.stagingDataAsset.walletPasswordSecret

Back to DataAsset spec

DataAssetStagingDataAssetWalletPasswordSecret defines nested fields for DataAsset.StagingDataAsset.WalletPasswordSecret.

Field Description Type Required Default Enum
secretConfig DataAssetStagingDataAssetWalletPasswordSecretSecretConfig defines nested fields for DataAsset.StagingDataAsset.WalletPasswordSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.stagingDataAsset.walletPasswordSecret.secretConfig

Back to DataAsset spec

DataAssetStagingDataAssetWalletPasswordSecretSecretConfig defines nested fields for DataAsset.StagingDataAsset.WalletPasswordSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.stagingDataAsset.walletSecret

Back to DataAsset spec

DataAssetStagingDataAssetWalletSecret defines nested fields for DataAsset.StagingDataAsset.WalletSecret.

Field Description Type Required Default Enum
secretConfig DataAssetStagingDataAssetWalletSecretSecretConfig defines nested fields for DataAsset.StagingDataAsset.WalletSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.stagingDataAsset.walletSecret.secretConfig

Back to DataAsset spec

DataAssetStagingDataAssetWalletSecretSecretConfig defines nested fields for DataAsset.StagingDataAsset.WalletSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.walletPasswordSecret

Back to DataAsset spec

DataAssetWalletPasswordSecret defines nested fields for DataAsset.WalletPasswordSecret.

Field Description Type Required Default Enum
secretConfig DataAssetWalletPasswordSecretSecretConfig defines nested fields for DataAsset.WalletPasswordSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.walletPasswordSecret.secretConfig

Back to DataAsset spec

DataAssetWalletPasswordSecretSecretConfig defines nested fields for DataAsset.WalletPasswordSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.walletSecret

Back to DataAsset spec

DataAssetWalletSecret defines nested fields for DataAsset.WalletSecret.

Field Description Type Required Default Enum
secretConfig DataAssetWalletSecretSecretConfig defines nested fields for DataAsset.WalletSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.walletSecret.secretConfig

Back to DataAsset spec

DataAssetWalletSecretSecretConfig defines nested fields for DataAsset.WalletSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Status

DataAssetStatus defines the observed state of DataAsset.

Field Description Type Required Default Enum
assetProperties Additional properties for the data asset. map[string, string] No - -
baseUrl The base url of the rest server. string No - -
bucketSchema DataAssetBucketSchema defines nested fields for DataAsset.BucketSchema. object No - -
credentialFileContent The credential file content from a wallet for the data asset. string No - -
dataAssetType The data asset type for the generic JDBC data asset. string No - -
defaultConnection DataAssetDefaultConnection defines nested fields for DataAsset.DefaultConnection. object No - -
description User-defined description of the data asset. string No - -
driverClass The Oracle Database driver class. string No - -
externalKey The external key for the object. string No - -
host The generic JDBC host name. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
jsonData - string No - -
key Generated key that can be used in API calls to identify data asset. string No - -
keyMap A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. map[string, string] No - -
lakeId The Lake Ocid. string No - -
lakeProxyEndpoint The lakeProxyEndpoint for the specified Lake Resource. string No - -
manifestFileContent The manifest file content of the rest APIs. string No - -
metadata DataAssetMetadata defines nested fields for DataAsset.Metadata. object No - -
metastoreId The metastoreId for the specified Lake Resource. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
namespace The namespace for the specified Oracle Object storage resource. You can find the namespace under Object Storage Settings in the Console. string No - -
nativeTypeSystem DataAssetNativeTypeSystem defines nested fields for DataAsset.NativeTypeSystem. object No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
ociRegion The Oracle Object storage Region ie. us-ashburn-1 string No - -
parentRef DataAssetParentRef defines nested fields for DataAsset.ParentRef. object No - -
port The generic JDBC port number. string No - -
protocol The HDFS Protocol name. string No - -
region The region for Amazon s3 string No - -
serviceName The Oracle Database service name. string No - -
serviceNames Array of service names that are available for selection in the serviceName property. list[string] No - -
serviceUrl The service url of the BI Server. string No - -
sid The Oracle Database SID. string No - -
stagingConnection DataAssetStagingConnectionObservedState defines nested fields for DataAsset.StagingConnection. object No - -
stagingDataAsset JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
status - object Yes - -
tenancyId The OCI tenancy OCID. string No - -
url The Oracle Object storage URL. string No - -
validateCertificate Specifies whether certificate validation is needed boolean No - -
walletPasswordSecret DataAssetWalletPasswordSecret defines nested fields for DataAsset.WalletPasswordSecret. object No - -
walletSecret DataAssetWalletSecret defines nested fields for DataAsset.WalletSecret. object No - -

Status.bucketSchema

Back to DataAsset status

DataAssetBucketSchema defines nested fields for DataAsset.BucketSchema.

Field Description Type Required Default Enum
defaultConnection The default connection key. string No - -
description User-defined description for the schema. string No - -
externalKey The external key for the object. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isHasContainers Specifies whether the schema has containers. boolean No - -
key The object key. string No - -
metadata DataAssetBucketSchemaMetadata defines nested fields for DataAsset.BucketSchema.Metadata. object No - -
modelType The object's type. string No - -
modelVersion The object's model version. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef DataAssetBucketSchemaParentRef defines nested fields for DataAsset.BucketSchema.ParentRef. object No - -
resourceName A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters. string No - -

Status.bucketSchema.metadata

Back to DataAsset status

DataAssetBucketSchemaMetadata defines nested fields for DataAsset.BucketSchema.Metadata.

Field Description Type Required Default Enum
aggregator DataAssetBucketSchemaMetadataAggregator defines nested fields for DataAsset.BucketSchema.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics DataAssetBucketSchemaMetadataCountStatistics defines nested fields for DataAsset.BucketSchema.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.bucketSchema.metadata.aggregator

Back to DataAsset status

DataAssetBucketSchemaMetadataAggregator defines nested fields for DataAsset.BucketSchema.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.bucketSchema.metadata.countStatistics

Back to DataAsset status

DataAssetBucketSchemaMetadataCountStatistics defines nested fields for DataAsset.BucketSchema.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Status.bucketSchema.metadata.countStatistics.objectTypeCountList[]

Back to DataAsset status

DataAssetBucketSchemaMetadataCountStatisticsObjectTypeCountList defines nested fields for DataAsset.BucketSchema.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.bucketSchema.parentRef

Back to DataAsset status

DataAssetBucketSchemaParentRef defines nested fields for DataAsset.BucketSchema.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.defaultConnection

Back to DataAsset status

DataAssetDefaultConnection defines nested fields for DataAsset.DefaultConnection.

Field Description Type Required Default Enum
connectionProperties The properties for the connection. list[object] No - -
dataNodePrincipal The HDFS Data Node principal. string Yes - -
description User-defined description for the connection. string No - -
hdfsPrincipal The HDFS principal. string Yes - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string Yes - -
key Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create. string No - -
keyDistributionCenter The HDFS Key Distribution Center. string No - -
keyTabContent DataAssetDefaultConnectionKeyTabContent defines nested fields for DataAsset.DefaultConnection.KeyTabContent. object No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string Yes - -
nameNodePrincipal The HDFS Name Node principal. string Yes - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef DataAssetDefaultConnectionParentRef defines nested fields for DataAsset.DefaultConnection.ParentRef. object No - -
realm HDFS Realm name. string No - -
registryMetadata DataAssetDefaultConnectionRegistryMetadata defines nested fields for DataAsset.DefaultConnection.RegistryMetadata. object No - -

Status.defaultConnection.connectionProperties[]

Back to DataAsset status

DataAssetDefaultConnectionConnectionProperty defines nested fields for DataAsset.DefaultConnection.ConnectionProperty.

Field Description Type Required Default Enum
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
value The value for the connection name property. string No - -

Status.defaultConnection.keyTabContent

Back to DataAsset status

DataAssetDefaultConnectionKeyTabContent defines nested fields for DataAsset.DefaultConnection.KeyTabContent.

Field Description Type Required Default Enum
secretConfig DataAssetDefaultConnectionKeyTabContentSecretConfig defines nested fields for DataAsset.DefaultConnection.KeyTabContent.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Status.defaultConnection.keyTabContent.secretConfig

Back to DataAsset status

DataAssetDefaultConnectionKeyTabContentSecretConfig defines nested fields for DataAsset.DefaultConnection.KeyTabContent.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Status.defaultConnection.parentRef

Back to DataAsset status

DataAssetDefaultConnectionParentRef defines nested fields for DataAsset.DefaultConnection.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.defaultConnection.registryMetadata

Back to DataAsset status

DataAssetDefaultConnectionRegistryMetadata defines nested fields for DataAsset.DefaultConnection.RegistryMetadata.

Field Description Type Required Default Enum
aggregatorKey The owning object's key for this object. string No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
key The identifying key for the object. string No - -
labels Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version. integer No - -

Status.metadata

Back to DataAsset status

DataAssetMetadata defines nested fields for DataAsset.Metadata.

Field Description Type Required Default Enum
aggregator DataAssetMetadataAggregator defines nested fields for DataAsset.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics DataAssetMetadataCountStatistics defines nested fields for DataAsset.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.metadata.aggregator

Back to DataAsset status

DataAssetMetadataAggregator defines nested fields for DataAsset.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.metadata.countStatistics

Back to DataAsset status

DataAssetMetadataCountStatistics defines nested fields for DataAsset.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] No - -

Status.metadata.countStatistics.objectTypeCountList[]

Back to DataAsset status

DataAssetMetadataCountStatisticsObjectTypeCountList defines nested fields for DataAsset.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.nativeTypeSystem

Back to DataAsset status

DataAssetNativeTypeSystem defines nested fields for DataAsset.NativeTypeSystem.

Field Description Type Required Default Enum
description A user defined description for the object. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
key The key of the object. string No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef DataAssetNativeTypeSystemParentRef defines nested fields for DataAsset.NativeTypeSystem.ParentRef. object No - -
typeMappingFrom The type system to map from. map[string, string] No - -
typeMappingTo The type system to map to. map[string, string] No - -
types An array of types. list[object] No - -

Status.nativeTypeSystem.parentRef

Back to DataAsset status

DataAssetNativeTypeSystemParentRef defines nested fields for DataAsset.NativeTypeSystem.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.nativeTypeSystem.types[]

Back to DataAsset status

DataAssetNativeTypeSystemType defines nested fields for DataAsset.NativeTypeSystem.Type.

Field Description Type Required Default Enum
configDefinition DataAssetNativeTypeSystemTypeConfigDefinition defines nested fields for DataAsset.NativeTypeSystem.Type.ConfigDefinition. object No - -
description A user defined description for the object. string No - -
dtType The data type. string No - -
key The key of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef DataAssetNativeTypeSystemTypeParentRef defines nested fields for DataAsset.NativeTypeSystem.Type.ParentRef. object No - -
typeSystemName The data type system name. string No - -

Status.nativeTypeSystem.types[].configDefinition

Back to DataAsset status

DataAssetNativeTypeSystemTypeConfigDefinition defines nested fields for DataAsset.NativeTypeSystem.Type.ConfigDefinition.

Field Description Type Required Default Enum
configParameterDefinitions The parameter configuration details. map[string, object] No - -
isContained Specifies whether the configuration is contained or not. boolean No - -
key The key of the object. string No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef DataAssetNativeTypeSystemTypeConfigDefinitionParentRef defines nested fields for DataAsset.NativeTypeSystem.Type.ConfigDefinition.ParentRef. object No - -

Status.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}

Back to DataAsset status

DataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitions defines nested fields for DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.

Field Description Type Required Default Enum
classFieldName The parameter class field name. string No - -
defaultValue The default value for the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
description A user defined description for the object. string No - -
isClassFieldValue Specifies whether the parameter is a class field or not. boolean No - -
isStatic Specifies whether the parameter is static or not. boolean No - -
parameterName This object represents the configurable properties for an object type. string No - -
parameterType DataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterType defines nested fields for DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType. object No - -

Status.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType

Back to DataAsset status

DataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterType defines nested fields for DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.

Field Description Type Required Default Enum
configDefinition JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
configValues DataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValues defines nested fields for DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues. object No - -
containsNull Defines whether null values are allowed. boolean No - -
description A user defined description for the object. string No - -
dtType The data type. string No - -
elementType Seeded type string No - -
elements An array of elements. list[string] No - -
javaTypeName The java type name. string No - -
jsonData - string No - -
key The key of the object. string No - -
keyElementType Seeded type string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef DataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeParentRef defines nested fields for DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ParentRef. object No - -
pathNames An array of path names corresponding to the elements. The path names are used when referring to the field in an expression. list[string] No - -
typeHandler DataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandler defines nested fields for DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler. object No - -
typeSystemName The data type system name. string No - -
valueElementType Seeded type string No - -
wrappedType A wrapped type, may be a string or a BaseType. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Status.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.configValues

Back to DataAsset status

DataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValues defines nested fields for DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef DataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesParentRef defines nested fields for DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ParentRef. object No - -

Status.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.configValues.configParamValues{}

Back to DataAsset status

DataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesConfigParamValues defines nested fields for DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Status.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.configValues.parentRef

Back to DataAsset status

DataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesParentRef defines nested fields for DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.parentRef

Back to DataAsset status

DataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeParentRef defines nested fields for DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler

Back to DataAsset status

DataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandler defines nested fields for DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.

Field Description Type Required Default Enum
configValues DataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValues defines nested fields for DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues. object No - -
flattenDetails Contains a key for referencing the flattenDetails information. string No - -
isOrderByRule Specifies whether it is ordered by rule. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef DataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerParentRef defines nested fields for DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ParentRef. object No - -
projectionRules The projection rules. list[object] No - -
scope Reference key for the typed object. string No - -
scopeReference DataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerScopeReference defines nested fields for DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ScopeReference. object No - -

Status.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues

Back to DataAsset status

DataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValues defines nested fields for DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef DataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesParentRef defines nested fields for DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ParentRef. object No - -

Status.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues.configParamValues{}

Back to DataAsset status

DataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesConfigParamValues defines nested fields for DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Status.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues.parentRef

Back to DataAsset status

DataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesParentRef defines nested fields for DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.parentRef

Back to DataAsset status

DataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerParentRef defines nested fields for DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[]

Back to DataAsset status

DataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRule defines nested fields for DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.

Field Description Type Required Default Enum
configValues DataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValues defines nested fields for DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues. object No - -
description A user defined description for the object. string No - -
fromName The attribute name that needs to be renamed. string No - -
isCascade Specifies whether to cascade or not. boolean No - -
isCaseSensitive Specifies if the rule is case sensitive. boolean No - -
isJavaRegexSyntax Specifies whether the rule uses a java regex syntax. boolean No - -
isSkipRemainingRulesOnMatch Specifies whether to skip remaining rules when a match is found. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
matchingStrategy The pattern matching strategy. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Name of the group. string No - -
names Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. list[string] No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef DataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleParentRef defines nested fields for DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ParentRef. object No - -
pattern The rule pattern. string No - -
ruleType The rule type. string No - -
scope Reference to a typed object. This can be either a key value to an object within the document, a shall referenced to a TypedObject, or a full TypedObject definition. Unknown nested fields are preserved. object (preserves unknown fields) No - -
toName The new attribute name. string No - -
types An arry of types. list[object (preserves unknown fields)] No - -

Status.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues

Back to DataAsset status

DataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValues defines nested fields for DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef DataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ParentRef. object No - -

Status.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues.configParamValues{}

Back to DataAsset status

DataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesConfigParamValues defines nested fields for DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Status.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues.parentRef

Back to DataAsset status

DataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].parentRef

Back to DataAsset status

DataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleParentRef defines nested fields for DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.scopeReference

Back to DataAsset status

DataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerScopeReference defines nested fields for DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ScopeReference.

Field Description Type Required Default Enum
refObjectName The referenced object name for this reference. Set to the field name if the referenceType is BOUND_ENTITY_SHAPE_FIELD, else set to null. string No - -
referenceObject A key or shallow reference to an object. For direct reference, it points to the actual scope object. For BOUND_ENTITY_SHAPE or BOUND_ENTITY_SHAPE_FIELD, it points to the source or target operator. For OCI_FUNCTION_INPUT_SHAPE or OCI_FUNCTION_OUTPUT_SHAPE, it points to the OCI Function object. string No - -
referenceType The reference type for this reference. Set to null for a direct reference, for indirect references set to a type of association such as "BOUND_ENTITY_SHAPE". Current known reference type values are "BOUND_ENTITY_SHAPE", "BOUND_ENTITY_SHAPE_FIELD", "OCI_FUNCTION_INPUT_SHAPE", "OCI_FUNCTION_OUTPUT_SHAPE" string No - -

Status.nativeTypeSystem.types[].configDefinition.parentRef

Back to DataAsset status

DataAssetNativeTypeSystemTypeConfigDefinitionParentRef defines nested fields for DataAsset.NativeTypeSystem.Type.ConfigDefinition.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.nativeTypeSystem.types[].parentRef

Back to DataAsset status

DataAssetNativeTypeSystemTypeParentRef defines nested fields for DataAsset.NativeTypeSystem.Type.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.parentRef

Back to DataAsset status

DataAssetParentRef defines nested fields for DataAsset.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.stagingConnection

Back to DataAsset status

DataAssetStagingConnectionObservedState defines nested fields for DataAsset.StagingConnection.

Field Description Type Required Default Enum
accessKey DataAssetStagingConnectionAccessKey defines nested fields for DataAsset.StagingConnection.AccessKey. object No - -
accessTokenUrl Specifies the endpoint used to exchange authentication credentials for access tokens string No - -
authHeader Optional header name if used other than default header(Authorization). string No - -
clientId Specifies the client ID key for specific application string No - -
clientSecret DataAssetStagingConnectionClientSecret defines nested fields for DataAsset.StagingConnection.ClientSecret. object No - -
connectionProperties The properties for the connection. list[object] No - -
credentialFileContent The credential file content from an Oracle Object Storage wallet. string No - -
dataNodePrincipal The HDFS Data Node principal. string No - -
defaultExternalStorage DataAssetStagingConnectionDefaultExternalStorage defines nested fields for DataAsset.StagingConnection.DefaultExternalStorage. object No - -
description User-defined description for the connection. string No - -
fingerPrint The fingerprint for the user. string No - -
grantType Specifies the OAuth2 grant mechanism. Example CLIENT_CREDENTIALS, Implicit Flow etc. string No - -
hdfsPrincipal The HDFS principal. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isDefault The default property for the connection. boolean No - -
jsonData - string No - -
key Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create. string No - -
keyDistributionCenter The HDFS Key Distribution Center. string No - -
keyMap A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. map[string, string] No - -
keyTabContent DataAssetStagingConnectionKeyTabContent defines nested fields for DataAsset.StagingConnection.KeyTabContent. object No - -
metadata DataAssetStagingConnectionMetadata defines nested fields for DataAsset.StagingConnection.Metadata. object No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
nameNodePrincipal The HDFS Name Node principal. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef DataAssetStagingConnectionParentRef defines nested fields for DataAsset.StagingConnection.ParentRef. object No - -
passPhrase The passphrase for the connection. string No - -
passwordSecret DataAssetStagingConnectionPasswordSecret defines nested fields for DataAsset.StagingConnection.PasswordSecret. object No - -
primarySchema DataAssetStagingConnectionPrimarySchema defines nested fields for DataAsset.StagingConnection.PrimarySchema. object No - -
realm HDFS Realm name. string No - -
scope Specifies the OAuth scopes that limit the permissions granted by an access token. string No - -
secretKey DataAssetStagingConnectionSecretKey defines nested fields for DataAsset.StagingConnection.SecretKey. object No - -
tnsAlias The Autonomous Data Warehouse instance service name. string No - -
tnsNames Array of service names that are available for selection in the tnsAlias property. list[string] No - -
userId The OCI user OCID for the user to connect to. string No - -
username The user name for the connection. string No - -

Status.stagingConnection.accessKey

Back to DataAsset status

DataAssetStagingConnectionAccessKey defines nested fields for DataAsset.StagingConnection.AccessKey.

Field Description Type Required Default Enum
secretConfig DataAssetStagingConnectionAccessKeySecretConfig defines nested fields for DataAsset.StagingConnection.AccessKey.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Status.stagingConnection.accessKey.secretConfig

Back to DataAsset status

DataAssetStagingConnectionAccessKeySecretConfig defines nested fields for DataAsset.StagingConnection.AccessKey.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Status.stagingConnection.clientSecret

Back to DataAsset status

DataAssetStagingConnectionClientSecret defines nested fields for DataAsset.StagingConnection.ClientSecret.

Field Description Type Required Default Enum
secretConfig DataAssetStagingConnectionClientSecretSecretConfig defines nested fields for DataAsset.StagingConnection.ClientSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Status.stagingConnection.clientSecret.secretConfig

Back to DataAsset status

DataAssetStagingConnectionClientSecretSecretConfig defines nested fields for DataAsset.StagingConnection.ClientSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Status.stagingConnection.connectionProperties[]

Back to DataAsset status

DataAssetStagingConnectionConnectionProperty defines nested fields for DataAsset.StagingConnection.ConnectionProperty.

Field Description Type Required Default Enum
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
value The value for the connection name property. string No - -

Status.stagingConnection.defaultExternalStorage

Back to DataAsset status

DataAssetStagingConnectionDefaultExternalStorage defines nested fields for DataAsset.StagingConnection.DefaultExternalStorage.

Field Description Type Required Default Enum
bucket Bucket Name where BICC extracts stores the files string No - -
host Object Storage host Url. DO not give http/https. string No - -
namespace Namespace for the OOS bucket string No - -
storageId Id of the external stoarge configured in BICC console. Usually its numeric. string No - -
storageName Name of the external storage configured in BICC console string No - -
tenancyId Tenancy OCID for the OOS bucket string No - -

Status.stagingConnection.keyTabContent

Back to DataAsset status

DataAssetStagingConnectionKeyTabContent defines nested fields for DataAsset.StagingConnection.KeyTabContent.

Field Description Type Required Default Enum
secretConfig DataAssetStagingConnectionKeyTabContentSecretConfig defines nested fields for DataAsset.StagingConnection.KeyTabContent.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Status.stagingConnection.keyTabContent.secretConfig

Back to DataAsset status

DataAssetStagingConnectionKeyTabContentSecretConfig defines nested fields for DataAsset.StagingConnection.KeyTabContent.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Status.stagingConnection.metadata

Back to DataAsset status

DataAssetStagingConnectionMetadata defines nested fields for DataAsset.StagingConnection.Metadata.

Field Description Type Required Default Enum
aggregator DataAssetStagingConnectionMetadataAggregator defines nested fields for DataAsset.StagingConnection.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics DataAssetStagingConnectionMetadataCountStatistics defines nested fields for DataAsset.StagingConnection.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.stagingConnection.metadata.aggregator

Back to DataAsset status

DataAssetStagingConnectionMetadataAggregator defines nested fields for DataAsset.StagingConnection.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.stagingConnection.metadata.countStatistics

Back to DataAsset status

DataAssetStagingConnectionMetadataCountStatistics defines nested fields for DataAsset.StagingConnection.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Status.stagingConnection.metadata.countStatistics.objectTypeCountList[]

Back to DataAsset status

DataAssetStagingConnectionMetadataCountStatisticsObjectTypeCountList defines nested fields for DataAsset.StagingConnection.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.stagingConnection.parentRef

Back to DataAsset status

DataAssetStagingConnectionParentRef defines nested fields for DataAsset.StagingConnection.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.stagingConnection.passwordSecret

Back to DataAsset status

DataAssetStagingConnectionPasswordSecret defines nested fields for DataAsset.StagingConnection.PasswordSecret.

Field Description Type Required Default Enum
secretConfig DataAssetStagingConnectionPasswordSecretSecretConfig defines nested fields for DataAsset.StagingConnection.PasswordSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Status.stagingConnection.passwordSecret.secretConfig

Back to DataAsset status

DataAssetStagingConnectionPasswordSecretSecretConfig defines nested fields for DataAsset.StagingConnection.PasswordSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Status.stagingConnection.primarySchema

Back to DataAsset status

DataAssetStagingConnectionPrimarySchema defines nested fields for DataAsset.StagingConnection.PrimarySchema.

Field Description Type Required Default Enum
defaultConnection The default connection key. string No - -
description User-defined description for the schema. string No - -
externalKey The external key for the object. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isHasContainers Specifies whether the schema has containers. boolean No - -
key The object key. string No - -
metadata DataAssetStagingConnectionPrimarySchemaMetadata defines nested fields for DataAsset.StagingConnection.PrimarySchema.Metadata. object No - -
modelType The object's type. string No - -
modelVersion The object's model version. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef DataAssetStagingConnectionPrimarySchemaParentRef defines nested fields for DataAsset.StagingConnection.PrimarySchema.ParentRef. object No - -
resourceName A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters. string No - -

Status.stagingConnection.primarySchema.metadata

Back to DataAsset status

DataAssetStagingConnectionPrimarySchemaMetadata defines nested fields for DataAsset.StagingConnection.PrimarySchema.Metadata.

Field Description Type Required Default Enum
aggregator DataAssetStagingConnectionPrimarySchemaMetadataAggregator defines nested fields for DataAsset.StagingConnection.PrimarySchema.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics DataAssetStagingConnectionPrimarySchemaMetadataCountStatistics defines nested fields for DataAsset.StagingConnection.PrimarySchema.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.stagingConnection.primarySchema.metadata.aggregator

Back to DataAsset status

DataAssetStagingConnectionPrimarySchemaMetadataAggregator defines nested fields for DataAsset.StagingConnection.PrimarySchema.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.stagingConnection.primarySchema.metadata.countStatistics

Back to DataAsset status

DataAssetStagingConnectionPrimarySchemaMetadataCountStatistics defines nested fields for DataAsset.StagingConnection.PrimarySchema.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Status.stagingConnection.primarySchema.metadata.countStatistics.objectTypeCountList[]

Back to DataAsset status

DataAssetStagingConnectionPrimarySchemaMetadataCountStatisticsObjectTypeCountList defines nested fields for DataAsset.StagingConnection.PrimarySchema.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.stagingConnection.primarySchema.parentRef

Back to DataAsset status

DataAssetStagingConnectionPrimarySchemaParentRef defines nested fields for DataAsset.StagingConnection.PrimarySchema.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.stagingConnection.secretKey

Back to DataAsset status

DataAssetStagingConnectionSecretKey defines nested fields for DataAsset.StagingConnection.SecretKey.

Field Description Type Required Default Enum
secretConfig DataAssetStagingConnectionSecretKeySecretConfig defines nested fields for DataAsset.StagingConnection.SecretKey.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Status.stagingConnection.secretKey.secretConfig

Back to DataAsset status

DataAssetStagingConnectionSecretKeySecretConfig defines nested fields for DataAsset.StagingConnection.SecretKey.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Status.status

Back to DataAsset 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

Back to DataAsset status

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

Back to DataAsset status

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[]

Back to DataAsset status

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

Status.walletPasswordSecret

Back to DataAsset status

DataAssetWalletPasswordSecret defines nested fields for DataAsset.WalletPasswordSecret.

Field Description Type Required Default Enum
secretConfig DataAssetWalletPasswordSecretSecretConfig defines nested fields for DataAsset.WalletPasswordSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Status.walletPasswordSecret.secretConfig

Back to DataAsset status

DataAssetWalletPasswordSecretSecretConfig defines nested fields for DataAsset.WalletPasswordSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Status.walletSecret

Back to DataAsset status

DataAssetWalletSecret defines nested fields for DataAsset.WalletSecret.

Field Description Type Required Default Enum
secretConfig DataAssetWalletSecretSecretConfig defines nested fields for DataAsset.WalletSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Status.walletSecret.secretConfig

Back to DataAsset status

DataAssetWalletSecretSecretConfig defines nested fields for DataAsset.WalletSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

DataFlow

DataFlow is the Schema for the dataflows API.

  • Plural: dataflows
  • Scope: Namespaced
  • APIVersion: dataintegration.oracle.com/v1beta1
  • Sample: Sample (config/samples/dataintegration_v1beta1_dataflow.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

DataFlowSpec defines the desired state of DataFlow.

Field Description Type Required Default Enum
description Detailed description for the object. string No - -
flowConfigValues JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string Yes - -
key Generated key that can be used in API calls to identify data flow. On scenarios where reference to the data flow is needed, a value can be passed in create. string No - -
modelType The type of the object. string Yes - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string Yes - -
nodes An array of nodes. list[object (preserves unknown fields)] No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer Yes - -
parameters An array of parameters. list[object (preserves unknown fields)] No - -
parentRef DataFlowParentRef defines nested fields for DataFlow.ParentRef. object No - -
registryMetadata DataFlowRegistryMetadata defines nested fields for DataFlow.RegistryMetadata. object Yes - -

Spec.parentRef

Back to DataFlow spec

DataFlowParentRef defines nested fields for DataFlow.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.registryMetadata

Back to DataFlow spec

DataFlowRegistryMetadata defines nested fields for DataFlow.RegistryMetadata.

Field Description Type Required Default Enum
aggregatorKey The owning object's key for this object. string No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
key The identifying key for the object. string No - -
labels Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version. integer No - -

Status

DataFlowStatus defines the observed state of DataFlow.

Field Description Type Required Default Enum
description Detailed description for the object. string No - -
flowConfigValues JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
key Generated key that can be used in API calls to identify data flow. On scenarios where reference to the data flow is needed, a value can be passed in create. string No - -
keyMap A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. map[string, string] No - -
metadata JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
nodes An array of nodes. list[object (preserves unknown fields)] No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parameters An array of parameters. list[object (preserves unknown fields)] No - -
parentRef DataFlowParentRef defines nested fields for DataFlow.ParentRef. object No - -
status - object Yes - -
targetFieldMapSummary A hash map that maps TypedObject keys to a field map that maps to the typed object as a target, for java sdk. map[string, object (preserves unknown fields)] No - -
typedObjectMap A hash map that maps TypedObject keys to the object itself, for java sdk. map[string, object (preserves unknown fields)] No - -

Status.parentRef

Back to DataFlow status

DataFlowParentRef defines nested fields for DataFlow.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.status

Back to DataFlow 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

Back to DataFlow status

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

Back to DataFlow status

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[]

Back to DataFlow status

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

DataFlowValidation

DataFlowValidation is the Schema for the dataflowvalidations API.

  • Plural: dataflowvalidations
  • Scope: Namespaced
  • APIVersion: dataintegration.oracle.com/v1beta1
  • Sample: Sample (config/samples/dataintegration_v1beta1_dataflowvalidation.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

DataFlowValidationSpec defines the desired state of DataFlowValidation.

Field Description Type Required Default Enum
description Detailed description for the object. string No - -
flowConfigValues JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
key Generated key that can be used in API calls to identify data flow. On scenarios where reference to the data flow is needed, a value can be passed in create. string No - -
keyMap A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. map[string, string] No - -
metadata JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
nodes An array of nodes. list[object (preserves unknown fields)] No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parameters An array of parameters. list[object (preserves unknown fields)] No - -
parentRef DataFlowValidationParentRef defines nested fields for DataFlowValidation.ParentRef. object No - -
targetFieldMapSummary A hash map that maps TypedObject keys to a field map that maps to the typed object as a target, for java sdk. map[string, object (preserves unknown fields)] No - -
typedObjectMap A hash map that maps TypedObject keys to the object itself, for java sdk. map[string, object (preserves unknown fields)] No - -

Spec.parentRef

Back to DataFlowValidation spec

DataFlowValidationParentRef defines nested fields for DataFlowValidation.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status

DataFlowValidationStatus defines the observed state of DataFlowValidation.

Field Description Type Required Default Enum
description Detailed description for the object. string No - -
errorMessageCount The total number of validation error messages. integer No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
infoMessageCount The total number of validation information messages. integer No - -
key Objects will use a 36 character key as unique ID. It is system generated and cannot be modified. string No - -
metadata DataFlowValidationMetadata defines nested fields for DataFlowValidation.Metadata. object No - -
modelType The type of the object. string No - -
modelVersion The model version of the object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef DataFlowValidationParentRef defines nested fields for DataFlowValidation.ParentRef. object No - -
status - object Yes - -
totalMessageCount The total number of validation messages. integer No - -
validationMessages The detailed information of the data flow object validation. map[string, list[object]] No - -
warnMessageCount The total number of validation warning messages. integer No - -

Status.metadata

Back to DataFlowValidation status

DataFlowValidationMetadata defines nested fields for DataFlowValidation.Metadata.

Field Description Type Required Default Enum
aggregator DataFlowValidationMetadataAggregator defines nested fields for DataFlowValidation.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics DataFlowValidationMetadataCountStatistics defines nested fields for DataFlowValidation.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.metadata.aggregator

Back to DataFlowValidation status

DataFlowValidationMetadataAggregator defines nested fields for DataFlowValidation.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.metadata.countStatistics

Back to DataFlowValidation status

DataFlowValidationMetadataCountStatistics defines nested fields for DataFlowValidation.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Status.metadata.countStatistics.objectTypeCountList[]

Back to DataFlowValidation status

DataFlowValidationMetadataCountStatisticsObjectTypeCountList defines nested fields for DataFlowValidation.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.parentRef

Back to DataFlowValidation status

DataFlowValidationParentRef defines nested fields for DataFlowValidation.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.status

Back to DataFlowValidation 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

Back to DataFlowValidation status

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

Back to DataFlowValidation status

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[]

Back to DataFlowValidation status

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

Status.validationMessages{}

Back to DataFlowValidation status

No documented fields in the checked-in CRD schema.

DisApplication

DisApplication is the Schema for the disapplications API.

  • Plural: disapplications
  • Scope: Namespaced
  • APIVersion: dataintegration.oracle.com/v1beta1
  • Sample: Sample (config/samples/dataintegration_v1beta1_disapplication.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

DisApplicationSpec defines the desired state of DisApplication.

Field Description Type Required Default Enum
applicationVersion version integer No - -
compartmentId OCID of the compartment that this resource belongs to. Defaults to compartment of the Workspace. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
description Detailed description for the object. string No - -
displayName Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
freeformTags Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string Yes - -
key Currently not used on application creation. Reserved for future. string No - -
lifecycleState The current state of the workspace. string No - -
metadata DisApplicationMetadata defines nested fields for DisApplication.Metadata. object No - -
modelType The type of the application. string No - -
modelVersion The object's model version. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string Yes - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer Yes - -
parentRef DisApplicationParentRef defines nested fields for DisApplication.ParentRef. object No - -
registryMetadata DisApplicationRegistryMetadata defines nested fields for DisApplication.RegistryMetadata. object No - -
sourceApplicationInfo DisApplicationSourceApplicationInfo defines nested fields for DisApplication.SourceApplicationInfo. object No - -

Spec.metadata

Back to DisApplication spec

DisApplicationMetadata defines nested fields for DisApplication.Metadata.

Field Description Type Required Default Enum
aggregator DisApplicationMetadataAggregator defines nested fields for DisApplication.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics DisApplicationMetadataCountStatistics defines nested fields for DisApplication.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Spec.metadata.aggregator

Back to DisApplication spec

DisApplicationMetadataAggregator defines nested fields for DisApplication.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Spec.metadata.countStatistics

Back to DisApplication spec

DisApplicationMetadataCountStatistics defines nested fields for DisApplication.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Spec.metadata.countStatistics.objectTypeCountList[]

Back to DisApplication spec

DisApplicationMetadataCountStatisticsObjectTypeCountList defines nested fields for DisApplication.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Spec.parentRef

Back to DisApplication spec

DisApplicationParentRef defines nested fields for DisApplication.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.registryMetadata

Back to DisApplication spec

DisApplicationRegistryMetadata defines nested fields for DisApplication.RegistryMetadata.

Field Description Type Required Default Enum
aggregatorKey The owning object's key for this object. string No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
key The identifying key for the object. string No - -
labels Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version. integer No - -

Spec.sourceApplicationInfo

Back to DisApplication spec

DisApplicationSourceApplicationInfo defines nested fields for DisApplication.SourceApplicationInfo.

Field Description Type Required Default Enum
applicationKey The source application key to use when creating the application. string No - -
copyType Parameter to specify the link between SOURCE and TARGET application after copying. CONNECTED - Indicate that TARGET application is conneced to SOURCE and can be synced after copy. DISCONNECTED - Indicate that TARGET application is not conneced to SOURCE and can evolve independently. string No - -
workspaceId The OCID of the workspace containing the application. This allows cross workspace deployment to publish an application from a different workspace into the current workspace specified in this operation. string No - -

Status

DisApplicationStatus defines the observed state of DisApplication.

Field Description Type Required Default Enum
applicationVersion The application's version. integer No - -
compartmentId OCID of the compartment that this resource belongs to. Defaults to compartment of the Workspace. 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 - -
dependentObjectMetadata A list of dependent objects in this patch. list[object] No - -
description Detailed description for the object. string No - -
displayName Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. 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 resource that is used to uniquely identify the application string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
key Generated key that can be used in API calls to identify application. string No - -
keyMap A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. map[string, string] No - -
lifecycleState The current state of the workspace. string No - -
metadata DisApplicationMetadata defines nested fields for DisApplication.Metadata. object No - -
modelType The object type. string No - -
modelVersion The object's model version. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef DisApplicationParentRef defines nested fields for DisApplication.ParentRef. object No - -
publishedObjectMetadata A list of objects that are published or unpublished in this patch. map[string, object] No - -
sourceApplicationInfo DisApplicationSourceApplicationInfo defines nested fields for DisApplication.SourceApplicationInfo. object No - -
status - object Yes - -
timeCreated The date and time the application was created, in the timestamp format defined by RFC3339. string No - -
timePatched The date and time the application was patched, in the timestamp format defined by RFC3339. string No - -
timeUpdated The date and time the application was updated, in the timestamp format defined by RFC3339. example: 2019-08-25T21:10:29.41Z string No - -

Status.dependentObjectMetadata[]

Back to DisApplication status

DisApplicationDependentObjectMetadata defines nested fields for DisApplication.DependentObjectMetadata.

Field Description Type Required Default Enum
action The patch action indicating if object was created, updated, or deleted. string No - -
identifier Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
key The key of the object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
namePath The fully qualified path of the published object, which would include its project and folder. string No - -
objectVersion The object version. integer No - -
type The type of the object in patch. string No - -

Status.metadata

Back to DisApplication status

DisApplicationMetadata defines nested fields for DisApplication.Metadata.

Field Description Type Required Default Enum
aggregator DisApplicationMetadataAggregator defines nested fields for DisApplication.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics DisApplicationMetadataCountStatistics defines nested fields for DisApplication.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.metadata.aggregator

Back to DisApplication status

DisApplicationMetadataAggregator defines nested fields for DisApplication.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.metadata.countStatistics

Back to DisApplication status

DisApplicationMetadataCountStatistics defines nested fields for DisApplication.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Status.metadata.countStatistics.objectTypeCountList[]

Back to DisApplication status

DisApplicationMetadataCountStatisticsObjectTypeCountList defines nested fields for DisApplication.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.parentRef

Back to DisApplication status

DisApplicationParentRef defines nested fields for DisApplication.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.publishedObjectMetadata{}

Back to DisApplication status

DisApplicationPublishedObjectMetadata defines nested fields for DisApplication.PublishedObjectMetadata.

Field Description Type Required Default Enum
action The patch action indicating if object was created, updated, or deleted. string No - -
identifier Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
key The key of the object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
namePath The fully qualified path of the published object, which would include its project and folder. string No - -
objectVersion The object version. integer No - -
type The type of the object in patch. string No - -

Status.sourceApplicationInfo

Back to DisApplication status

DisApplicationSourceApplicationInfo defines nested fields for DisApplication.SourceApplicationInfo.

Field Description Type Required Default Enum
applicationKey The source application key to use when creating the application. string No - -
copyType Parameter to specify the link between SOURCE and TARGET application after copying. CONNECTED - Indicate that TARGET application is conneced to SOURCE and can be synced after copy. DISCONNECTED - Indicate that TARGET application is not conneced to SOURCE and can evolve independently. string No - -
workspaceId The OCID of the workspace containing the application. This allows cross workspace deployment to publish an application from a different workspace into the current workspace specified in this operation. string No - -

Status.status

Back to DisApplication 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

Back to DisApplication status

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

Back to DisApplication status

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[]

Back to DisApplication status

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

DisApplicationDetailedDescription

DisApplicationDetailedDescription is the Schema for the disapplicationdetaileddescriptions API.

  • Plural: disapplicationdetaileddescriptions
  • Scope: Namespaced
  • APIVersion: dataintegration.oracle.com/v1beta1
  • Sample: Sample (config/samples/dataintegration_v1beta1_disapplicationdetaileddescription.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

DisApplicationDetailedDescriptionSpec defines the desired state of DisApplicationDetailedDescription.

Field Description Type Required Default Enum
detailedDescription Base64 encoded rich text description of the object. string No - -
logo Base64 encoded image to represent logo of the object. string No - -

Status

DisApplicationDetailedDescriptionStatus defines the observed state of DisApplicationDetailedDescription.

Field Description Type Required Default Enum
status - object Yes - -

Status.status

Back to DisApplicationDetailedDescription 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

Back to DisApplicationDetailedDescription status

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

Back to DisApplicationDetailedDescription status

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[]

Back to DisApplicationDetailedDescription status

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

ExportRequest

ExportRequest is the Schema for the exportrequests API.

  • Plural: exportrequests
  • Scope: Namespaced
  • APIVersion: dataintegration.oracle.com/v1beta1
  • Sample: Sample (config/samples/dataintegration_v1beta1_exportrequest.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

ExportRequestSpec defines the desired state of ExportRequest.

Field Description Type Required Default Enum
areReferencesIncluded This field controls if the references will be exported along with the objects boolean No - -
bucketName Name of the Object Storage bucket where the object will be exported. string Yes - -
fileName Name of the exported zip file. string No - -
filters Filters for exported objects list[string] No - -
isObjectOverwriteEnabled Flag to control whether to overwrite the object if it is already present at the provided object storage location. boolean No - -
objectKeys Field is used to specify which object keys to export list[string] No - -
objectStorageRegion Region of the object storage (if using object storage of different region) string No - -
objectStorageTenancyId Optional parameter to point to object storage tenancy (if using Object Storage of different tenancy) string No - -
status The status of the object. string No - -

Status

ExportRequestStatus defines the observed state of ExportRequest.

Field Description Type Required Default Enum
areReferencesIncluded Controls if the references will be exported along with the objects boolean No - -
bucketName The name of the Object Storage Bucket where the objects will be exported to string No - -
createdBy Name of the user who initiated export request. string No - -
errorMessages Contains key of the error map[string, string] No - -
exportedItems The array of exported object details. list[object] No - -
fileName Name of the exported zip file. string No - -
filters Export multiple objects based on filters. list[string] No - -
isObjectOverwriteEnabled Flag to control whether to overwrite the object if it is already present at the provided object storage location. boolean No - -
key Export object request key string No - -
name Name of the export request. string No - -
objectKeys The list of the objects to be exported list[string] No - -
objectStorageRegion Region of the object storage (if using object storage of different region) string No - -
objectStorageTenancyId Optional parameter to point to object storage tenancy (if using Object Storage of different tenancy) string No - -
referencedItems The array of exported referenced objects. string No - -
sdkStatus Export Objects request status. This uses a distinct JSON name so it can coexist with the OSOK status envelope. string No - -
status - object Yes - -
timeEndedInMillis Time at which the request was completely processed. integer (int64) No - -
timeStartedInMillis Time at which the request started getting processed. integer (int64) No - -
totalExportedObjectCount Number of objects that are exported. integer No - -

Status.exportedItems[]

Back to ExportRequest status

ExportRequestExportedItem defines nested fields for ExportRequest.ExportedItem.

Field Description Type Required Default Enum
aggregatorKey Aggregator key string No - -
identifier Object identifier string No - -
key Key of the object string No - -
name Name of the object string No - -
namePath Object name path string No - -
objectType Object type string No - -
objectVersion Object version string No - -
timeUpdatedInMillis time at which this object was last updated. integer (int64) No - -

Status.status

Back to ExportRequest 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

Back to ExportRequest status

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

Back to ExportRequest status

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[]

Back to ExportRequest status

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

ExternalPublication

ExternalPublication is the Schema for the externalpublications API.

  • Plural: externalpublications
  • Scope: Namespaced
  • APIVersion: dataintegration.oracle.com/v1beta1
  • Sample: Sample (config/samples/dataintegration_v1beta1_externalpublication.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

ExternalPublicationSpec defines the desired state of ExternalPublication.

Field Description Type Required Default Enum
applicationCompartmentId The OCID of the compartment where the application is created in the Oracle Cloud Infrastructure Data Flow Service. string Yes - -
applicationId The unique OCID of the identifier that is returned after creating the Oracle Cloud Infrastructure Data Flow application. string No - -
configurationDetails ExternalPublicationConfigurationDetails defines nested fields for ExternalPublication.ConfigurationDetails. object No - -
description The details of the data flow or the application. string No - -
displayName The name of the application. string Yes - -
resourceConfiguration ExternalPublicationResourceConfiguration defines nested fields for ExternalPublication.ResourceConfiguration. object No - -

Spec.configurationDetails

Back to ExternalPublication spec

ExternalPublicationConfigurationDetails defines nested fields for ExternalPublication.ConfigurationDetails.

Field Description Type Required Default Enum
compartmentId The compartment ID of the object store. string No - -
connection ExternalPublicationConfigurationDetailsConnection defines nested fields for ExternalPublication.ConfigurationDetails.Connection. object No - -
dataAsset ExternalPublicationConfigurationDetailsDataAsset defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset. object No - -
schema ExternalPublicationConfigurationDetailsSchema defines nested fields for ExternalPublication.ConfigurationDetails.Schema. object No - -

Spec.configurationDetails.connection

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsConnection defines nested fields for ExternalPublication.ConfigurationDetails.Connection.

Field Description Type Required Default Enum
accessKey ExternalPublicationConfigurationDetailsConnectionAccessKey defines nested fields for ExternalPublication.ConfigurationDetails.Connection.AccessKey. object No - -
accessTokenUrl Specifies the endpoint used to exchange authentication credentials for access tokens string No - -
authHeader Optional header name if used other than default header(Authorization). string No - -
clientId Specifies the client ID key for specific application string No - -
clientSecret ExternalPublicationConfigurationDetailsConnectionClientSecret defines nested fields for ExternalPublication.ConfigurationDetails.Connection.ClientSecret. object No - -
connectionProperties The properties for the connection. list[object] No - -
credentialFileContent The credential file content from an Oracle Object Storage wallet. string No - -
dataNodePrincipal The HDFS Data Node principal. string No - -
defaultExternalStorage ExternalPublicationConfigurationDetailsConnectionDefaultExternalStorage defines nested fields for ExternalPublication.ConfigurationDetails.Connection.DefaultExternalStorage. object No - -
description User-defined description for the connection. string No - -
fingerPrint The fingerprint for the user. string No - -
grantType Specifies the OAuth2 grant mechanism. Example CLIENT_CREDENTIALS, Implicit Flow etc. string No - -
hdfsPrincipal The HDFS principal. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isDefault The default property for the connection. boolean No - -
jsonData - string No - -
key Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create. string No - -
keyDistributionCenter The HDFS Key Distribution Center. string No - -
keyMap A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. map[string, string] No - -
keyTabContent ExternalPublicationConfigurationDetailsConnectionKeyTabContent defines nested fields for ExternalPublication.ConfigurationDetails.Connection.KeyTabContent. object No - -
metadata ExternalPublicationConfigurationDetailsConnectionMetadata defines nested fields for ExternalPublication.ConfigurationDetails.Connection.Metadata. object No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
nameNodePrincipal The HDFS Name Node principal. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef ExternalPublicationConfigurationDetailsConnectionParentRef defines nested fields for ExternalPublication.ConfigurationDetails.Connection.ParentRef. object No - -
passPhrase The passphrase for the connection. string No - -
password The password for the connection. string No - -
passwordSecret ExternalPublicationConfigurationDetailsConnectionPasswordSecret defines nested fields for ExternalPublication.ConfigurationDetails.Connection.PasswordSecret. object No - -
primarySchema ExternalPublicationConfigurationDetailsConnectionPrimarySchema defines nested fields for ExternalPublication.ConfigurationDetails.Connection.PrimarySchema. object No - -
realm HDFS Realm name. string No - -
scope Specifies the OAuth scopes that limit the permissions granted by an access token. string No - -
secretKey ExternalPublicationConfigurationDetailsConnectionSecretKey defines nested fields for ExternalPublication.ConfigurationDetails.Connection.SecretKey. object No - -
tnsAlias The Autonomous Data Warehouse instance service name. string No - -
tnsNames Array of service names that are available for selection in the tnsAlias property. list[string] No - -
userId The OCI user OCID for the user to connect to. string No - -
username The user name for the connection. string No - -

Spec.configurationDetails.connection.accessKey

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsConnectionAccessKey defines nested fields for ExternalPublication.ConfigurationDetails.Connection.AccessKey.

Field Description Type Required Default Enum
secretConfig ExternalPublicationConfigurationDetailsConnectionAccessKeySecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.Connection.AccessKey.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.configurationDetails.connection.accessKey.secretConfig

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsConnectionAccessKeySecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.Connection.AccessKey.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.configurationDetails.connection.clientSecret

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsConnectionClientSecret defines nested fields for ExternalPublication.ConfigurationDetails.Connection.ClientSecret.

Field Description Type Required Default Enum
secretConfig ExternalPublicationConfigurationDetailsConnectionClientSecretSecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.Connection.ClientSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.configurationDetails.connection.clientSecret.secretConfig

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsConnectionClientSecretSecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.Connection.ClientSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.configurationDetails.connection.connectionProperties[]

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsConnectionConnectionProperty defines nested fields for ExternalPublication.ConfigurationDetails.Connection.ConnectionProperty.

Field Description Type Required Default Enum
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
value The value for the connection name property. string No - -

Spec.configurationDetails.connection.defaultExternalStorage

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsConnectionDefaultExternalStorage defines nested fields for ExternalPublication.ConfigurationDetails.Connection.DefaultExternalStorage.

Field Description Type Required Default Enum
bucket Bucket Name where BICC extracts stores the files string No - -
host Object Storage host Url. DO not give http/https. string No - -
namespace Namespace for the OOS bucket string No - -
storageId Id of the external stoarge configured in BICC console. Usually its numeric. string No - -
storageName Name of the external storage configured in BICC console string No - -
tenancyId Tenancy OCID for the OOS bucket string No - -

Spec.configurationDetails.connection.keyTabContent

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsConnectionKeyTabContent defines nested fields for ExternalPublication.ConfigurationDetails.Connection.KeyTabContent.

Field Description Type Required Default Enum
secretConfig ExternalPublicationConfigurationDetailsConnectionKeyTabContentSecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.Connection.KeyTabContent.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.configurationDetails.connection.keyTabContent.secretConfig

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsConnectionKeyTabContentSecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.Connection.KeyTabContent.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.configurationDetails.connection.metadata

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsConnectionMetadata defines nested fields for ExternalPublication.ConfigurationDetails.Connection.Metadata.

Field Description Type Required Default Enum
aggregator ExternalPublicationConfigurationDetailsConnectionMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.Connection.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ExternalPublicationConfigurationDetailsConnectionMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.Connection.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Spec.configurationDetails.connection.metadata.aggregator

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsConnectionMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.Connection.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Spec.configurationDetails.connection.metadata.countStatistics

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsConnectionMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.Connection.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Spec.configurationDetails.connection.metadata.countStatistics.objectTypeCountList[]

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsConnectionMetadataCountStatisticsObjectTypeCountList defines nested fields for ExternalPublication.ConfigurationDetails.Connection.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Spec.configurationDetails.connection.parentRef

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsConnectionParentRef defines nested fields for ExternalPublication.ConfigurationDetails.Connection.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.configurationDetails.connection.passwordSecret

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsConnectionPasswordSecret defines nested fields for ExternalPublication.ConfigurationDetails.Connection.PasswordSecret.

Field Description Type Required Default Enum
secretConfig ExternalPublicationConfigurationDetailsConnectionPasswordSecretSecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.Connection.PasswordSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.configurationDetails.connection.passwordSecret.secretConfig

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsConnectionPasswordSecretSecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.Connection.PasswordSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.configurationDetails.connection.primarySchema

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsConnectionPrimarySchema defines nested fields for ExternalPublication.ConfigurationDetails.Connection.PrimarySchema.

Field Description Type Required Default Enum
defaultConnection The default connection key. string No - -
description User-defined description for the schema. string No - -
externalKey The external key for the object. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isHasContainers Specifies whether the schema has containers. boolean No - -
key The object key. string No - -
metadata ExternalPublicationConfigurationDetailsConnectionPrimarySchemaMetadata defines nested fields for ExternalPublication.ConfigurationDetails.Connection.PrimarySchema.Metadata. object No - -
modelType The object's type. string No - -
modelVersion The object's model version. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef ExternalPublicationConfigurationDetailsConnectionPrimarySchemaParentRef defines nested fields for ExternalPublication.ConfigurationDetails.Connection.PrimarySchema.ParentRef. object No - -
resourceName A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters. string No - -

Spec.configurationDetails.connection.primarySchema.metadata

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsConnectionPrimarySchemaMetadata defines nested fields for ExternalPublication.ConfigurationDetails.Connection.PrimarySchema.Metadata.

Field Description Type Required Default Enum
aggregator ExternalPublicationConfigurationDetailsConnectionPrimarySchemaMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.Connection.PrimarySchema.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ExternalPublicationConfigurationDetailsConnectionPrimarySchemaMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.Connection.PrimarySchema.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Spec.configurationDetails.connection.primarySchema.metadata.aggregator

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsConnectionPrimarySchemaMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.Connection.PrimarySchema.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Spec.configurationDetails.connection.primarySchema.metadata.countStatistics

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsConnectionPrimarySchemaMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.Connection.PrimarySchema.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Spec.configurationDetails.connection.primarySchema.metadata.countStatistics.objectTypeCountList[]

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsConnectionPrimarySchemaMetadataCountStatisticsObjectTypeCountList defines nested fields for ExternalPublication.ConfigurationDetails.Connection.PrimarySchema.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Spec.configurationDetails.connection.primarySchema.parentRef

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsConnectionPrimarySchemaParentRef defines nested fields for ExternalPublication.ConfigurationDetails.Connection.PrimarySchema.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.configurationDetails.connection.secretKey

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsConnectionSecretKey defines nested fields for ExternalPublication.ConfigurationDetails.Connection.SecretKey.

Field Description Type Required Default Enum
secretConfig ExternalPublicationConfigurationDetailsConnectionSecretKeySecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.Connection.SecretKey.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.configurationDetails.connection.secretKey.secretConfig

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsConnectionSecretKeySecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.Connection.SecretKey.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.configurationDetails.dataAsset

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAsset defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.

Field Description Type Required Default Enum
assetProperties Additional properties for the data asset. map[string, string] No - -
baseUrl The base url of the rest server. string No - -
bucketSchema ExternalPublicationConfigurationDetailsDataAssetBucketSchema defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.BucketSchema. object No - -
credentialFileContent The credential file content from a wallet for the data asset. string No - -
dataAssetType The data asset type for the generic JDBC data asset. string No - -
defaultConnection ExternalPublicationConfigurationDetailsDataAssetDefaultConnection defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection. object No - -
description User-defined description of the data asset. string No - -
driverClass The Oracle Database driver class. string No - -
externalKey The external key for the object. string No - -
host The generic JDBC host name. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
jsonData - string No - -
key Generated key that can be used in API calls to identify data asset. string No - -
keyMap A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. map[string, string] No - -
lakeId The Lake Ocid. string No - -
lakeProxyEndpoint The lakeProxyEndpoint for the specified Lake Resource. string No - -
manifestFileContent The manifest file content of the rest APIs. string No - -
metadata ExternalPublicationConfigurationDetailsDataAssetMetadata defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.Metadata. object No - -
metastoreId The metastoreId for the specified Lake Resource. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
namespace The namespace for the specified Oracle Object storage resource. You can find the namespace under Object Storage Settings in the Console. string No - -
nativeTypeSystem ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystem defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem. object No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
ociRegion The Oracle Object storage Region ie. us-ashburn-1 string No - -
parentRef ExternalPublicationConfigurationDetailsDataAssetParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.ParentRef. object No - -
port The generic JDBC port number. string No - -
protocol The HDFS Protocol name. string No - -
region The region for Amazon s3 string No - -
serviceName The Oracle Database service name. string No - -
serviceNames Array of service names that are available for selection in the serviceName property. list[string] No - -
serviceUrl The service url of the BI Server. string No - -
sid The Oracle Database SID. string No - -
stagingConnection ExternalPublicationConfigurationDetailsDataAssetStagingConnection defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection. object No - -
stagingDataAsset JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
tenancyId The OCI tenancy OCID. string No - -
url The Oracle Object storage URL. string No - -
validateCertificate Specifies whether certificate validation is needed boolean No - -
walletPasswordSecret ExternalPublicationConfigurationDetailsDataAssetWalletPasswordSecret defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.WalletPasswordSecret. object No - -
walletSecret ExternalPublicationConfigurationDetailsDataAssetWalletSecret defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.WalletSecret. object No - -

Spec.configurationDetails.dataAsset.bucketSchema

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetBucketSchema defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.BucketSchema.

Field Description Type Required Default Enum
defaultConnection The default connection key. string No - -
description User-defined description for the schema. string No - -
externalKey The external key for the object. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isHasContainers Specifies whether the schema has containers. boolean No - -
key The object key. string No - -
metadata ExternalPublicationConfigurationDetailsDataAssetBucketSchemaMetadata defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.BucketSchema.Metadata. object No - -
modelType The object's type. string No - -
modelVersion The object's model version. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef ExternalPublicationConfigurationDetailsDataAssetBucketSchemaParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.BucketSchema.ParentRef. object No - -
resourceName A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters. string No - -

Spec.configurationDetails.dataAsset.bucketSchema.metadata

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetBucketSchemaMetadata defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.BucketSchema.Metadata.

Field Description Type Required Default Enum
aggregator ExternalPublicationConfigurationDetailsDataAssetBucketSchemaMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.BucketSchema.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ExternalPublicationConfigurationDetailsDataAssetBucketSchemaMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.BucketSchema.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Spec.configurationDetails.dataAsset.bucketSchema.metadata.aggregator

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetBucketSchemaMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.BucketSchema.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Spec.configurationDetails.dataAsset.bucketSchema.metadata.countStatistics

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetBucketSchemaMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.BucketSchema.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Spec.configurationDetails.dataAsset.bucketSchema.metadata.countStatistics.objectTypeCountList[]

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetBucketSchemaMetadataCountStatisticsObjectTypeCountList defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.BucketSchema.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Spec.configurationDetails.dataAsset.bucketSchema.parentRef

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetBucketSchemaParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.BucketSchema.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.configurationDetails.dataAsset.defaultConnection

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetDefaultConnection defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.

Field Description Type Required Default Enum
connectionProperties The properties for the connection. list[object] No - -
description User-defined description for the connection. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isDefault The default property for the connection. boolean No - -
key Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create. string No - -
metadata ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionMetadata defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.Metadata. object No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.ParentRef. object No - -
primarySchema ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionPrimarySchema defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.PrimarySchema. object No - -
username The user name for the connection. string No - -

Spec.configurationDetails.dataAsset.defaultConnection.connectionProperties[]

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionConnectionProperty defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.ConnectionProperty.

Field Description Type Required Default Enum
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
value The value for the connection name property. string No - -

Spec.configurationDetails.dataAsset.defaultConnection.metadata

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionMetadata defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.Metadata.

Field Description Type Required Default Enum
aggregator ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Spec.configurationDetails.dataAsset.defaultConnection.metadata.aggregator

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Spec.configurationDetails.dataAsset.defaultConnection.metadata.countStatistics

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Spec.configurationDetails.dataAsset.defaultConnection.metadata.countStatistics.objectTypeCountList[]

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionMetadataCountStatisticsObjectTypeCountList defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Spec.configurationDetails.dataAsset.defaultConnection.parentRef

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.configurationDetails.dataAsset.defaultConnection.primarySchema

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionPrimarySchema defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.PrimarySchema.

Field Description Type Required Default Enum
defaultConnection The default connection key. string No - -
description User-defined description for the schema. string No - -
externalKey The external key for the object. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isHasContainers Specifies whether the schema has containers. boolean No - -
key The object key. string No - -
metadata ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionPrimarySchemaMetadata defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.PrimarySchema.Metadata. object No - -
modelType The object's type. string No - -
modelVersion The object's model version. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionPrimarySchemaParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.PrimarySchema.ParentRef. object No - -
resourceName A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters. string No - -

Spec.configurationDetails.dataAsset.defaultConnection.primarySchema.metadata

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionPrimarySchemaMetadata defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.PrimarySchema.Metadata.

Field Description Type Required Default Enum
aggregator ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionPrimarySchemaMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.PrimarySchema.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionPrimarySchemaMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.PrimarySchema.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Spec.configurationDetails.dataAsset.defaultConnection.primarySchema.metadata.aggregator

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionPrimarySchemaMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.PrimarySchema.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Spec.configurationDetails.dataAsset.defaultConnection.primarySchema.metadata.countStatistics

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionPrimarySchemaMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.PrimarySchema.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Spec.configurationDetails.dataAsset.defaultConnection.primarySchema.metadata.countStatistics.objectTypeCountList[]

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionPrimarySchemaMetadataCountStatisticsObjectTypeCountList defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.PrimarySchema.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Spec.configurationDetails.dataAsset.defaultConnection.primarySchema.parentRef

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionPrimarySchemaParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.PrimarySchema.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.configurationDetails.dataAsset.metadata

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetMetadata defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.Metadata.

Field Description Type Required Default Enum
aggregator ExternalPublicationConfigurationDetailsDataAssetMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ExternalPublicationConfigurationDetailsDataAssetMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Spec.configurationDetails.dataAsset.metadata.aggregator

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Spec.configurationDetails.dataAsset.metadata.countStatistics

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Spec.configurationDetails.dataAsset.metadata.countStatistics.objectTypeCountList[]

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetMetadataCountStatisticsObjectTypeCountList defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Spec.configurationDetails.dataAsset.nativeTypeSystem

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystem defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.

Field Description Type Required Default Enum
description A user defined description for the object. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
key The key of the object. string No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.ParentRef. object No - -
typeMappingFrom The type system to map from. map[string, string] No - -
typeMappingTo The type system to map to. map[string, string] No - -
types An array of types. list[object] No - -

Spec.configurationDetails.dataAsset.nativeTypeSystem.parentRef

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.configurationDetails.dataAsset.nativeTypeSystem.types[]

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemType defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.

Field Description Type Required Default Enum
configDefinition ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinition defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition. object No - -
description A user defined description for the object. string No - -
dtType The data type. string No - -
key The key of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ParentRef. object No - -
typeSystemName The data type system name. string No - -

Spec.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinition defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.

Field Description Type Required Default Enum
configParameterDefinitions The parameter configuration details. map[string, object] No - -
isContained Specifies whether the configuration is contained or not. boolean No - -
key The key of the object. string No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ParentRef. object No - -

Spec.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitions defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.

Field Description Type Required Default Enum
classFieldName The parameter class field name. string No - -
defaultValue The default value for the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
description A user defined description for the object. string No - -
isClassFieldValue Specifies whether the parameter is a class field or not. boolean No - -
isStatic Specifies whether the parameter is static or not. boolean No - -
parameterName This object represents the configurable properties for an object type. string No - -
parameterType ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterType defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType. object No - -

Spec.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterType defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.

Field Description Type Required Default Enum
configDefinition JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
configValues ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValues defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues. object No - -
containsNull Defines whether null values are allowed. boolean No - -
description A user defined description for the object. string No - -
dtType The data type. string No - -
elementType Seeded type string No - -
elements An array of elements. list[string] No - -
javaTypeName The java type name. string No - -
jsonData - string No - -
key The key of the object. string No - -
keyElementType Seeded type string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ParentRef. object No - -
pathNames An array of path names corresponding to the elements. The path names are used when referring to the field in an expression. list[string] No - -
typeHandler ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandler defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler. object No - -
typeSystemName The data type system name. string No - -
valueElementType Seeded type string No - -
wrappedType A wrapped type, may be a string or a BaseType. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Spec.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.configValues

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValues defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ParentRef. object No - -

Spec.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.configValues.configParamValues{}

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesConfigParamValues defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.configValues.parentRef

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.parentRef

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandler defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.

Field Description Type Required Default Enum
configValues ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValues defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues. object No - -
flattenDetails Contains a key for referencing the flattenDetails information. string No - -
isOrderByRule Specifies whether it is ordered by rule. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ParentRef. object No - -
projectionRules The projection rules. list[object] No - -
scope Reference key for the typed object. string No - -
scopeReference ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerScopeReference defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ScopeReference. object No - -

Spec.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValues defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ParentRef. object No - -

Spec.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues.configParamValues{}

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesConfigParamValues defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues.parentRef

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.parentRef

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[]

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRule defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.

Field Description Type Required Default Enum
configValues ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValues defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues. object No - -
description A user defined description for the object. string No - -
fromName The attribute name that needs to be renamed. string No - -
isCascade Specifies whether to cascade or not. boolean No - -
isCaseSensitive Specifies if the rule is case sensitive. boolean No - -
isJavaRegexSyntax Specifies whether the rule uses a java regex syntax. boolean No - -
isSkipRemainingRulesOnMatch Specifies whether to skip remaining rules when a match is found. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
matchingStrategy The pattern matching strategy. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Name of the group. string No - -
names Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. list[string] No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ParentRef. object No - -
pattern The rule pattern. string No - -
ruleType The rule type. string No - -
scope Reference to a typed object. This can be either a key value to an object within the document, a shall referenced to a TypedObject, or a full TypedObject definition. Unknown nested fields are preserved. object (preserves unknown fields) No - -
toName The new attribute name. string No - -
types An arry of types. list[object (preserves unknown fields)] No - -

Spec.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValues defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ParentRef. object No - -

Spec.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues.configParamValues{}

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesConfigParamValues defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues.parentRef

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].parentRef

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.scopeReference

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerScopeReference defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ScopeReference.

Field Description Type Required Default Enum
refObjectName The referenced object name for this reference. Set to the field name if the referenceType is BOUND_ENTITY_SHAPE_FIELD, else set to null. string No - -
referenceObject A key or shallow reference to an object. For direct reference, it points to the actual scope object. For BOUND_ENTITY_SHAPE or BOUND_ENTITY_SHAPE_FIELD, it points to the source or target operator. For OCI_FUNCTION_INPUT_SHAPE or OCI_FUNCTION_OUTPUT_SHAPE, it points to the OCI Function object. string Yes - -
referenceType The reference type for this reference. Set to null for a direct reference, for indirect references set to a type of association such as "BOUND_ENTITY_SHAPE". Current known reference type values are "BOUND_ENTITY_SHAPE", "BOUND_ENTITY_SHAPE_FIELD", "OCI_FUNCTION_INPUT_SHAPE", "OCI_FUNCTION_OUTPUT_SHAPE" string No - -

Spec.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.parentRef

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.configurationDetails.dataAsset.nativeTypeSystem.types[].parentRef

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.configurationDetails.dataAsset.parentRef

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.configurationDetails.dataAsset.stagingConnection

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetStagingConnection defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.

Field Description Type Required Default Enum
accessKey ExternalPublicationConfigurationDetailsDataAssetStagingConnectionAccessKey defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.AccessKey. object No - -
accessTokenUrl Specifies the endpoint used to exchange authentication credentials for access tokens string No - -
authHeader Optional header name if used other than default header(Authorization). string No - -
clientId Specifies the client ID key for specific application string No - -
clientSecret ExternalPublicationConfigurationDetailsDataAssetStagingConnectionClientSecret defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.ClientSecret. object No - -
connectionProperties The properties for the connection. list[object] No - -
credentialFileContent The credential file content from an Oracle Object Storage wallet. string No - -
dataNodePrincipal The HDFS Data Node principal. string No - -
defaultExternalStorage ExternalPublicationConfigurationDetailsDataAssetStagingConnectionDefaultExternalStorage defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.DefaultExternalStorage. object No - -
description User-defined description for the connection. string No - -
fingerPrint The fingerprint for the user. string No - -
grantType Specifies the OAuth2 grant mechanism. Example CLIENT_CREDENTIALS, Implicit Flow etc. string No - -
hdfsPrincipal The HDFS principal. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isDefault The default property for the connection. boolean No - -
jsonData - string No - -
key Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create. string No - -
keyDistributionCenter The HDFS Key Distribution Center. string No - -
keyMap A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. map[string, string] No - -
keyTabContent ExternalPublicationConfigurationDetailsDataAssetStagingConnectionKeyTabContent defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.KeyTabContent. object No - -
metadata ExternalPublicationConfigurationDetailsDataAssetStagingConnectionMetadata defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.Metadata. object No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
nameNodePrincipal The HDFS Name Node principal. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef ExternalPublicationConfigurationDetailsDataAssetStagingConnectionParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.ParentRef. object No - -
passPhrase The passphrase for the connection. string No - -
password The password for the connection. string No - -
passwordSecret ExternalPublicationConfigurationDetailsDataAssetStagingConnectionPasswordSecret defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.PasswordSecret. object No - -
primarySchema ExternalPublicationConfigurationDetailsDataAssetStagingConnectionPrimarySchema defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.PrimarySchema. object No - -
realm HDFS Realm name. string No - -
scope Specifies the OAuth scopes that limit the permissions granted by an access token. string No - -
secretKey ExternalPublicationConfigurationDetailsDataAssetStagingConnectionSecretKey defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.SecretKey. object No - -
tnsAlias The Autonomous Data Warehouse instance service name. string No - -
tnsNames Array of service names that are available for selection in the tnsAlias property. list[string] No - -
userId The OCI user OCID for the user to connect to. string No - -
username The user name for the connection. string No - -

Spec.configurationDetails.dataAsset.stagingConnection.accessKey

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionAccessKey defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.AccessKey.

Field Description Type Required Default Enum
secretConfig ExternalPublicationConfigurationDetailsDataAssetStagingConnectionAccessKeySecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.AccessKey.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.configurationDetails.dataAsset.stagingConnection.accessKey.secretConfig

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionAccessKeySecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.AccessKey.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.configurationDetails.dataAsset.stagingConnection.clientSecret

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionClientSecret defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.ClientSecret.

Field Description Type Required Default Enum
secretConfig ExternalPublicationConfigurationDetailsDataAssetStagingConnectionClientSecretSecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.ClientSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.configurationDetails.dataAsset.stagingConnection.clientSecret.secretConfig

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionClientSecretSecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.ClientSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.configurationDetails.dataAsset.stagingConnection.connectionProperties[]

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionConnectionProperty defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.ConnectionProperty.

Field Description Type Required Default Enum
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
value The value for the connection name property. string No - -

Spec.configurationDetails.dataAsset.stagingConnection.defaultExternalStorage

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionDefaultExternalStorage defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.DefaultExternalStorage.

Field Description Type Required Default Enum
bucket Bucket Name where BICC extracts stores the files string No - -
host Object Storage host Url. DO not give http/https. string No - -
namespace Namespace for the OOS bucket string No - -
storageId Id of the external stoarge configured in BICC console. Usually its numeric. string No - -
storageName Name of the external storage configured in BICC console string No - -
tenancyId Tenancy OCID for the OOS bucket string No - -

Spec.configurationDetails.dataAsset.stagingConnection.keyTabContent

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionKeyTabContent defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.KeyTabContent.

Field Description Type Required Default Enum
secretConfig ExternalPublicationConfigurationDetailsDataAssetStagingConnectionKeyTabContentSecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.KeyTabContent.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.configurationDetails.dataAsset.stagingConnection.keyTabContent.secretConfig

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionKeyTabContentSecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.KeyTabContent.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.configurationDetails.dataAsset.stagingConnection.metadata

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionMetadata defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.Metadata.

Field Description Type Required Default Enum
aggregator ExternalPublicationConfigurationDetailsDataAssetStagingConnectionMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ExternalPublicationConfigurationDetailsDataAssetStagingConnectionMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Spec.configurationDetails.dataAsset.stagingConnection.metadata.aggregator

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Spec.configurationDetails.dataAsset.stagingConnection.metadata.countStatistics

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Spec.configurationDetails.dataAsset.stagingConnection.metadata.countStatistics.objectTypeCountList[]

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionMetadataCountStatisticsObjectTypeCountList defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Spec.configurationDetails.dataAsset.stagingConnection.parentRef

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.configurationDetails.dataAsset.stagingConnection.passwordSecret

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionPasswordSecret defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.PasswordSecret.

Field Description Type Required Default Enum
secretConfig ExternalPublicationConfigurationDetailsDataAssetStagingConnectionPasswordSecretSecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.PasswordSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.configurationDetails.dataAsset.stagingConnection.passwordSecret.secretConfig

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionPasswordSecretSecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.PasswordSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.configurationDetails.dataAsset.stagingConnection.primarySchema

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionPrimarySchema defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.PrimarySchema.

Field Description Type Required Default Enum
defaultConnection The default connection key. string No - -
description User-defined description for the schema. string No - -
externalKey The external key for the object. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isHasContainers Specifies whether the schema has containers. boolean No - -
key The object key. string No - -
metadata ExternalPublicationConfigurationDetailsDataAssetStagingConnectionPrimarySchemaMetadata defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.PrimarySchema.Metadata. object No - -
modelType The object's type. string No - -
modelVersion The object's model version. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef ExternalPublicationConfigurationDetailsDataAssetStagingConnectionPrimarySchemaParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.PrimarySchema.ParentRef. object No - -
resourceName A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters. string No - -

Spec.configurationDetails.dataAsset.stagingConnection.primarySchema.metadata

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionPrimarySchemaMetadata defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.PrimarySchema.Metadata.

Field Description Type Required Default Enum
aggregator ExternalPublicationConfigurationDetailsDataAssetStagingConnectionPrimarySchemaMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.PrimarySchema.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ExternalPublicationConfigurationDetailsDataAssetStagingConnectionPrimarySchemaMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.PrimarySchema.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Spec.configurationDetails.dataAsset.stagingConnection.primarySchema.metadata.aggregator

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionPrimarySchemaMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.PrimarySchema.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Spec.configurationDetails.dataAsset.stagingConnection.primarySchema.metadata.countStatistics

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionPrimarySchemaMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.PrimarySchema.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Spec.configurationDetails.dataAsset.stagingConnection.primarySchema.metadata.countStatistics.objectTypeCountList[]

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionPrimarySchemaMetadataCountStatisticsObjectTypeCountList defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.PrimarySchema.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Spec.configurationDetails.dataAsset.stagingConnection.primarySchema.parentRef

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionPrimarySchemaParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.PrimarySchema.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.configurationDetails.dataAsset.stagingConnection.secretKey

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionSecretKey defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.SecretKey.

Field Description Type Required Default Enum
secretConfig ExternalPublicationConfigurationDetailsDataAssetStagingConnectionSecretKeySecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.SecretKey.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.configurationDetails.dataAsset.stagingConnection.secretKey.secretConfig

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionSecretKeySecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.SecretKey.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.configurationDetails.dataAsset.walletPasswordSecret

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetWalletPasswordSecret defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.WalletPasswordSecret.

Field Description Type Required Default Enum
secretConfig ExternalPublicationConfigurationDetailsDataAssetWalletPasswordSecretSecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.WalletPasswordSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.configurationDetails.dataAsset.walletPasswordSecret.secretConfig

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetWalletPasswordSecretSecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.WalletPasswordSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.configurationDetails.dataAsset.walletSecret

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetWalletSecret defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.WalletSecret.

Field Description Type Required Default Enum
secretConfig ExternalPublicationConfigurationDetailsDataAssetWalletSecretSecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.WalletSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Spec.configurationDetails.dataAsset.walletSecret.secretConfig

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsDataAssetWalletSecretSecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.WalletSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Spec.configurationDetails.schema

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsSchema defines nested fields for ExternalPublication.ConfigurationDetails.Schema.

Field Description Type Required Default Enum
defaultConnection The default connection key. string No - -
description User-defined description for the schema. string No - -
externalKey The external key for the object. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isHasContainers Specifies whether the schema has containers. boolean No - -
key The object key. string No - -
metadata ExternalPublicationConfigurationDetailsSchemaMetadata defines nested fields for ExternalPublication.ConfigurationDetails.Schema.Metadata. object No - -
modelType The object's type. string No - -
modelVersion The object's model version. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef ExternalPublicationConfigurationDetailsSchemaParentRef defines nested fields for ExternalPublication.ConfigurationDetails.Schema.ParentRef. object No - -
resourceName A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters. string No - -

Spec.configurationDetails.schema.metadata

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsSchemaMetadata defines nested fields for ExternalPublication.ConfigurationDetails.Schema.Metadata.

Field Description Type Required Default Enum
aggregator ExternalPublicationConfigurationDetailsSchemaMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.Schema.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ExternalPublicationConfigurationDetailsSchemaMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.Schema.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Spec.configurationDetails.schema.metadata.aggregator

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsSchemaMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.Schema.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Spec.configurationDetails.schema.metadata.countStatistics

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsSchemaMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.Schema.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Spec.configurationDetails.schema.metadata.countStatistics.objectTypeCountList[]

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsSchemaMetadataCountStatisticsObjectTypeCountList defines nested fields for ExternalPublication.ConfigurationDetails.Schema.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Spec.configurationDetails.schema.parentRef

Back to ExternalPublication spec

ExternalPublicationConfigurationDetailsSchemaParentRef defines nested fields for ExternalPublication.ConfigurationDetails.Schema.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.resourceConfiguration

Back to ExternalPublication spec

ExternalPublicationResourceConfiguration defines nested fields for ExternalPublication.ResourceConfiguration.

Field Description Type Required Default Enum
driverShape The VM shape of the driver used while creating an Oracle Cloud Infrastructure Data Flow application. It sets the driver cores and memory. string Yes - -
executorShape The shape of the executor used while creating an Oracle Cloud Infrastructure Data Flow application. It sets the executor cores and memory. string Yes - -
sparkVersion The version of the spark used while creating an Oracle Cloud Infrastructure Data Flow application. string Yes - -
totalExecutors Number of executor VMs requested while creating an Oracle Cloud Infrastructure Data Flow application. integer Yes - -

Status

ExternalPublicationStatus defines the observed state of ExternalPublication.

Field Description Type Required Default Enum
applicationCompartmentId The OCID of the compartment where the application is created in the Oracle Cloud Infrastructure Data Flow Service. string No - -
applicationId The unique OCID of the identifier that is returned after creating the Oracle Cloud Infrastructure Data Flow application. string No - -
configurationDetails ExternalPublicationConfigurationDetailsObservedState defines nested fields for ExternalPublication.ConfigurationDetails. object No - -
description Detailed description for the object. string No - -
displayName The name of the application. string No - -
errorMessage The error of the published object in the application. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
key The object key. string No - -
keyMap A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. map[string, string] No - -
metadata ExternalPublicationMetadata defines nested fields for ExternalPublication.Metadata. object No - -
modelType The object type. string No - -
modelVersion This is a version number that is used by the service to upgrade objects if needed through releases of the service. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects. Other values are reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef ExternalPublicationParentRef defines nested fields for ExternalPublication.ParentRef. object No - -
resourceConfiguration ExternalPublicationResourceConfiguration defines nested fields for ExternalPublication.ResourceConfiguration. object No - -
sdkStatus The status of the publishing action to Oracle Cloud Infrastructure Data Flow. This uses a distinct JSON name so it can coexist with the OSOK status envelope. string No - -
status - object Yes - -

Status.configurationDetails

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsObservedState defines nested fields for ExternalPublication.ConfigurationDetails.

Field Description Type Required Default Enum
compartmentId The compartment ID of the object store. string No - -
connection ExternalPublicationConfigurationDetailsConnectionObservedState defines nested fields for ExternalPublication.ConfigurationDetails.Connection. object No - -
dataAsset ExternalPublicationConfigurationDetailsDataAssetObservedState defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset. object No - -
schema ExternalPublicationConfigurationDetailsSchema defines nested fields for ExternalPublication.ConfigurationDetails.Schema. object No - -

Status.configurationDetails.connection

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsConnectionObservedState defines nested fields for ExternalPublication.ConfigurationDetails.Connection.

Field Description Type Required Default Enum
accessKey ExternalPublicationConfigurationDetailsConnectionAccessKey defines nested fields for ExternalPublication.ConfigurationDetails.Connection.AccessKey. object No - -
accessTokenUrl Specifies the endpoint used to exchange authentication credentials for access tokens string No - -
authHeader Optional header name if used other than default header(Authorization). string No - -
clientId Specifies the client ID key for specific application string No - -
clientSecret ExternalPublicationConfigurationDetailsConnectionClientSecret defines nested fields for ExternalPublication.ConfigurationDetails.Connection.ClientSecret. object No - -
connectionProperties The properties for the connection. list[object] No - -
credentialFileContent The credential file content from an Oracle Object Storage wallet. string No - -
dataNodePrincipal The HDFS Data Node principal. string No - -
defaultExternalStorage ExternalPublicationConfigurationDetailsConnectionDefaultExternalStorage defines nested fields for ExternalPublication.ConfigurationDetails.Connection.DefaultExternalStorage. object No - -
description User-defined description for the connection. string No - -
fingerPrint The fingerprint for the user. string No - -
grantType Specifies the OAuth2 grant mechanism. Example CLIENT_CREDENTIALS, Implicit Flow etc. string No - -
hdfsPrincipal The HDFS principal. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isDefault The default property for the connection. boolean No - -
jsonData - string No - -
key Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create. string No - -
keyDistributionCenter The HDFS Key Distribution Center. string No - -
keyMap A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. map[string, string] No - -
keyTabContent ExternalPublicationConfigurationDetailsConnectionKeyTabContent defines nested fields for ExternalPublication.ConfigurationDetails.Connection.KeyTabContent. object No - -
metadata ExternalPublicationConfigurationDetailsConnectionMetadata defines nested fields for ExternalPublication.ConfigurationDetails.Connection.Metadata. object No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
nameNodePrincipal The HDFS Name Node principal. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef ExternalPublicationConfigurationDetailsConnectionParentRef defines nested fields for ExternalPublication.ConfigurationDetails.Connection.ParentRef. object No - -
passPhrase The passphrase for the connection. string No - -
passwordSecret ExternalPublicationConfigurationDetailsConnectionPasswordSecret defines nested fields for ExternalPublication.ConfigurationDetails.Connection.PasswordSecret. object No - -
primarySchema ExternalPublicationConfigurationDetailsConnectionPrimarySchema defines nested fields for ExternalPublication.ConfigurationDetails.Connection.PrimarySchema. object No - -
realm HDFS Realm name. string No - -
scope Specifies the OAuth scopes that limit the permissions granted by an access token. string No - -
secretKey ExternalPublicationConfigurationDetailsConnectionSecretKey defines nested fields for ExternalPublication.ConfigurationDetails.Connection.SecretKey. object No - -
tnsAlias The Autonomous Data Warehouse instance service name. string No - -
tnsNames Array of service names that are available for selection in the tnsAlias property. list[string] No - -
userId The OCI user OCID for the user to connect to. string No - -
username The user name for the connection. string No - -

Status.configurationDetails.connection.accessKey

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsConnectionAccessKey defines nested fields for ExternalPublication.ConfigurationDetails.Connection.AccessKey.

Field Description Type Required Default Enum
secretConfig ExternalPublicationConfigurationDetailsConnectionAccessKeySecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.Connection.AccessKey.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Status.configurationDetails.connection.accessKey.secretConfig

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsConnectionAccessKeySecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.Connection.AccessKey.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Status.configurationDetails.connection.clientSecret

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsConnectionClientSecret defines nested fields for ExternalPublication.ConfigurationDetails.Connection.ClientSecret.

Field Description Type Required Default Enum
secretConfig ExternalPublicationConfigurationDetailsConnectionClientSecretSecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.Connection.ClientSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Status.configurationDetails.connection.clientSecret.secretConfig

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsConnectionClientSecretSecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.Connection.ClientSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Status.configurationDetails.connection.connectionProperties[]

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsConnectionConnectionProperty defines nested fields for ExternalPublication.ConfigurationDetails.Connection.ConnectionProperty.

Field Description Type Required Default Enum
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
value The value for the connection name property. string No - -

Status.configurationDetails.connection.defaultExternalStorage

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsConnectionDefaultExternalStorage defines nested fields for ExternalPublication.ConfigurationDetails.Connection.DefaultExternalStorage.

Field Description Type Required Default Enum
bucket Bucket Name where BICC extracts stores the files string No - -
host Object Storage host Url. DO not give http/https. string No - -
namespace Namespace for the OOS bucket string No - -
storageId Id of the external stoarge configured in BICC console. Usually its numeric. string No - -
storageName Name of the external storage configured in BICC console string No - -
tenancyId Tenancy OCID for the OOS bucket string No - -

Status.configurationDetails.connection.keyTabContent

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsConnectionKeyTabContent defines nested fields for ExternalPublication.ConfigurationDetails.Connection.KeyTabContent.

Field Description Type Required Default Enum
secretConfig ExternalPublicationConfigurationDetailsConnectionKeyTabContentSecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.Connection.KeyTabContent.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Status.configurationDetails.connection.keyTabContent.secretConfig

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsConnectionKeyTabContentSecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.Connection.KeyTabContent.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Status.configurationDetails.connection.metadata

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsConnectionMetadata defines nested fields for ExternalPublication.ConfigurationDetails.Connection.Metadata.

Field Description Type Required Default Enum
aggregator ExternalPublicationConfigurationDetailsConnectionMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.Connection.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ExternalPublicationConfigurationDetailsConnectionMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.Connection.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.configurationDetails.connection.metadata.aggregator

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsConnectionMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.Connection.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.configurationDetails.connection.metadata.countStatistics

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsConnectionMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.Connection.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Status.configurationDetails.connection.metadata.countStatistics.objectTypeCountList[]

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsConnectionMetadataCountStatisticsObjectTypeCountList defines nested fields for ExternalPublication.ConfigurationDetails.Connection.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.configurationDetails.connection.parentRef

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsConnectionParentRef defines nested fields for ExternalPublication.ConfigurationDetails.Connection.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.configurationDetails.connection.passwordSecret

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsConnectionPasswordSecret defines nested fields for ExternalPublication.ConfigurationDetails.Connection.PasswordSecret.

Field Description Type Required Default Enum
secretConfig ExternalPublicationConfigurationDetailsConnectionPasswordSecretSecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.Connection.PasswordSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Status.configurationDetails.connection.passwordSecret.secretConfig

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsConnectionPasswordSecretSecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.Connection.PasswordSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Status.configurationDetails.connection.primarySchema

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsConnectionPrimarySchema defines nested fields for ExternalPublication.ConfigurationDetails.Connection.PrimarySchema.

Field Description Type Required Default Enum
defaultConnection The default connection key. string No - -
description User-defined description for the schema. string No - -
externalKey The external key for the object. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isHasContainers Specifies whether the schema has containers. boolean No - -
key The object key. string No - -
metadata ExternalPublicationConfigurationDetailsConnectionPrimarySchemaMetadata defines nested fields for ExternalPublication.ConfigurationDetails.Connection.PrimarySchema.Metadata. object No - -
modelType The object's type. string No - -
modelVersion The object's model version. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef ExternalPublicationConfigurationDetailsConnectionPrimarySchemaParentRef defines nested fields for ExternalPublication.ConfigurationDetails.Connection.PrimarySchema.ParentRef. object No - -
resourceName A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters. string No - -

Status.configurationDetails.connection.primarySchema.metadata

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsConnectionPrimarySchemaMetadata defines nested fields for ExternalPublication.ConfigurationDetails.Connection.PrimarySchema.Metadata.

Field Description Type Required Default Enum
aggregator ExternalPublicationConfigurationDetailsConnectionPrimarySchemaMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.Connection.PrimarySchema.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ExternalPublicationConfigurationDetailsConnectionPrimarySchemaMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.Connection.PrimarySchema.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.configurationDetails.connection.primarySchema.metadata.aggregator

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsConnectionPrimarySchemaMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.Connection.PrimarySchema.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.configurationDetails.connection.primarySchema.metadata.countStatistics

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsConnectionPrimarySchemaMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.Connection.PrimarySchema.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Status.configurationDetails.connection.primarySchema.metadata.countStatistics.objectTypeCountList[]

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsConnectionPrimarySchemaMetadataCountStatisticsObjectTypeCountList defines nested fields for ExternalPublication.ConfigurationDetails.Connection.PrimarySchema.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.configurationDetails.connection.primarySchema.parentRef

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsConnectionPrimarySchemaParentRef defines nested fields for ExternalPublication.ConfigurationDetails.Connection.PrimarySchema.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.configurationDetails.connection.secretKey

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsConnectionSecretKey defines nested fields for ExternalPublication.ConfigurationDetails.Connection.SecretKey.

Field Description Type Required Default Enum
secretConfig ExternalPublicationConfigurationDetailsConnectionSecretKeySecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.Connection.SecretKey.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Status.configurationDetails.connection.secretKey.secretConfig

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsConnectionSecretKeySecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.Connection.SecretKey.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Status.configurationDetails.dataAsset

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetObservedState defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.

Field Description Type Required Default Enum
assetProperties Additional properties for the data asset. map[string, string] No - -
baseUrl The base url of the rest server. string No - -
bucketSchema ExternalPublicationConfigurationDetailsDataAssetBucketSchema defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.BucketSchema. object No - -
credentialFileContent The credential file content from a wallet for the data asset. string No - -
dataAssetType The data asset type for the generic JDBC data asset. string No - -
defaultConnection ExternalPublicationConfigurationDetailsDataAssetDefaultConnection defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection. object No - -
description User-defined description of the data asset. string No - -
driverClass The Oracle Database driver class. string No - -
externalKey The external key for the object. string No - -
host The generic JDBC host name. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
jsonData - string No - -
key Generated key that can be used in API calls to identify data asset. string No - -
keyMap A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. map[string, string] No - -
lakeId The Lake Ocid. string No - -
lakeProxyEndpoint The lakeProxyEndpoint for the specified Lake Resource. string No - -
manifestFileContent The manifest file content of the rest APIs. string No - -
metadata ExternalPublicationConfigurationDetailsDataAssetMetadata defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.Metadata. object No - -
metastoreId The metastoreId for the specified Lake Resource. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
namespace The namespace for the specified Oracle Object storage resource. You can find the namespace under Object Storage Settings in the Console. string No - -
nativeTypeSystem ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystem defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem. object No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
ociRegion The Oracle Object storage Region ie. us-ashburn-1 string No - -
parentRef ExternalPublicationConfigurationDetailsDataAssetParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.ParentRef. object No - -
port The generic JDBC port number. string No - -
protocol The HDFS Protocol name. string No - -
region The region for Amazon s3 string No - -
serviceName The Oracle Database service name. string No - -
serviceNames Array of service names that are available for selection in the serviceName property. list[string] No - -
serviceUrl The service url of the BI Server. string No - -
sid The Oracle Database SID. string No - -
stagingConnection ExternalPublicationConfigurationDetailsDataAssetStagingConnectionObservedState defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection. object No - -
stagingDataAsset JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
tenancyId The OCI tenancy OCID. string No - -
url The Oracle Object storage URL. string No - -
validateCertificate Specifies whether certificate validation is needed boolean No - -
walletPasswordSecret ExternalPublicationConfigurationDetailsDataAssetWalletPasswordSecret defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.WalletPasswordSecret. object No - -
walletSecret ExternalPublicationConfigurationDetailsDataAssetWalletSecret defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.WalletSecret. object No - -

Status.configurationDetails.dataAsset.bucketSchema

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetBucketSchema defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.BucketSchema.

Field Description Type Required Default Enum
defaultConnection The default connection key. string No - -
description User-defined description for the schema. string No - -
externalKey The external key for the object. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isHasContainers Specifies whether the schema has containers. boolean No - -
key The object key. string No - -
metadata ExternalPublicationConfigurationDetailsDataAssetBucketSchemaMetadata defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.BucketSchema.Metadata. object No - -
modelType The object's type. string No - -
modelVersion The object's model version. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef ExternalPublicationConfigurationDetailsDataAssetBucketSchemaParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.BucketSchema.ParentRef. object No - -
resourceName A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters. string No - -

Status.configurationDetails.dataAsset.bucketSchema.metadata

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetBucketSchemaMetadata defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.BucketSchema.Metadata.

Field Description Type Required Default Enum
aggregator ExternalPublicationConfigurationDetailsDataAssetBucketSchemaMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.BucketSchema.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ExternalPublicationConfigurationDetailsDataAssetBucketSchemaMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.BucketSchema.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.configurationDetails.dataAsset.bucketSchema.metadata.aggregator

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetBucketSchemaMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.BucketSchema.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.configurationDetails.dataAsset.bucketSchema.metadata.countStatistics

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetBucketSchemaMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.BucketSchema.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Status.configurationDetails.dataAsset.bucketSchema.metadata.countStatistics.objectTypeCountList[]

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetBucketSchemaMetadataCountStatisticsObjectTypeCountList defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.BucketSchema.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.configurationDetails.dataAsset.bucketSchema.parentRef

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetBucketSchemaParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.BucketSchema.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.configurationDetails.dataAsset.defaultConnection

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetDefaultConnection defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.

Field Description Type Required Default Enum
connectionProperties The properties for the connection. list[object] No - -
description User-defined description for the connection. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isDefault The default property for the connection. boolean No - -
key Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create. string No - -
metadata ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionMetadata defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.Metadata. object No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.ParentRef. object No - -
primarySchema ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionPrimarySchema defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.PrimarySchema. object No - -
username The user name for the connection. string No - -

Status.configurationDetails.dataAsset.defaultConnection.connectionProperties[]

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionConnectionProperty defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.ConnectionProperty.

Field Description Type Required Default Enum
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
value The value for the connection name property. string No - -

Status.configurationDetails.dataAsset.defaultConnection.metadata

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionMetadata defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.Metadata.

Field Description Type Required Default Enum
aggregator ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.configurationDetails.dataAsset.defaultConnection.metadata.aggregator

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.configurationDetails.dataAsset.defaultConnection.metadata.countStatistics

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Status.configurationDetails.dataAsset.defaultConnection.metadata.countStatistics.objectTypeCountList[]

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionMetadataCountStatisticsObjectTypeCountList defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.configurationDetails.dataAsset.defaultConnection.parentRef

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.configurationDetails.dataAsset.defaultConnection.primarySchema

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionPrimarySchema defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.PrimarySchema.

Field Description Type Required Default Enum
defaultConnection The default connection key. string No - -
description User-defined description for the schema. string No - -
externalKey The external key for the object. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isHasContainers Specifies whether the schema has containers. boolean No - -
key The object key. string No - -
metadata ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionPrimarySchemaMetadata defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.PrimarySchema.Metadata. object No - -
modelType The object's type. string No - -
modelVersion The object's model version. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionPrimarySchemaParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.PrimarySchema.ParentRef. object No - -
resourceName A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters. string No - -

Status.configurationDetails.dataAsset.defaultConnection.primarySchema.metadata

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionPrimarySchemaMetadata defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.PrimarySchema.Metadata.

Field Description Type Required Default Enum
aggregator ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionPrimarySchemaMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.PrimarySchema.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionPrimarySchemaMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.PrimarySchema.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.configurationDetails.dataAsset.defaultConnection.primarySchema.metadata.aggregator

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionPrimarySchemaMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.PrimarySchema.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.configurationDetails.dataAsset.defaultConnection.primarySchema.metadata.countStatistics

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionPrimarySchemaMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.PrimarySchema.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Status.configurationDetails.dataAsset.defaultConnection.primarySchema.metadata.countStatistics.objectTypeCountList[]

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionPrimarySchemaMetadataCountStatisticsObjectTypeCountList defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.PrimarySchema.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.configurationDetails.dataAsset.defaultConnection.primarySchema.parentRef

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetDefaultConnectionPrimarySchemaParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.DefaultConnection.PrimarySchema.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.configurationDetails.dataAsset.metadata

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetMetadata defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.Metadata.

Field Description Type Required Default Enum
aggregator ExternalPublicationConfigurationDetailsDataAssetMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ExternalPublicationConfigurationDetailsDataAssetMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.configurationDetails.dataAsset.metadata.aggregator

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.configurationDetails.dataAsset.metadata.countStatistics

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Status.configurationDetails.dataAsset.metadata.countStatistics.objectTypeCountList[]

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetMetadataCountStatisticsObjectTypeCountList defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.configurationDetails.dataAsset.nativeTypeSystem

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystem defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.

Field Description Type Required Default Enum
description A user defined description for the object. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
key The key of the object. string No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.ParentRef. object No - -
typeMappingFrom The type system to map from. map[string, string] No - -
typeMappingTo The type system to map to. map[string, string] No - -
types An array of types. list[object] No - -

Status.configurationDetails.dataAsset.nativeTypeSystem.parentRef

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.configurationDetails.dataAsset.nativeTypeSystem.types[]

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemType defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.

Field Description Type Required Default Enum
configDefinition ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinition defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition. object No - -
description A user defined description for the object. string No - -
dtType The data type. string No - -
key The key of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ParentRef. object No - -
typeSystemName The data type system name. string No - -

Status.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinition defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.

Field Description Type Required Default Enum
configParameterDefinitions The parameter configuration details. map[string, object] No - -
isContained Specifies whether the configuration is contained or not. boolean No - -
key The key of the object. string No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ParentRef. object No - -

Status.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitions defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.

Field Description Type Required Default Enum
classFieldName The parameter class field name. string No - -
defaultValue The default value for the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
description A user defined description for the object. string No - -
isClassFieldValue Specifies whether the parameter is a class field or not. boolean No - -
isStatic Specifies whether the parameter is static or not. boolean No - -
parameterName This object represents the configurable properties for an object type. string No - -
parameterType ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterType defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType. object No - -

Status.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterType defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.

Field Description Type Required Default Enum
configDefinition JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
configValues ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValues defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues. object No - -
containsNull Defines whether null values are allowed. boolean No - -
description A user defined description for the object. string No - -
dtType The data type. string No - -
elementType Seeded type string No - -
elements An array of elements. list[string] No - -
javaTypeName The java type name. string No - -
jsonData - string No - -
key The key of the object. string No - -
keyElementType Seeded type string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ParentRef. object No - -
pathNames An array of path names corresponding to the elements. The path names are used when referring to the field in an expression. list[string] No - -
typeHandler ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandler defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler. object No - -
typeSystemName The data type system name. string No - -
valueElementType Seeded type string No - -
wrappedType A wrapped type, may be a string or a BaseType. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Status.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.configValues

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValues defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ParentRef. object No - -

Status.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.configValues.configParamValues{}

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesConfigParamValues defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Status.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.configValues.parentRef

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.parentRef

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandler defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.

Field Description Type Required Default Enum
configValues ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValues defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues. object No - -
flattenDetails Contains a key for referencing the flattenDetails information. string No - -
isOrderByRule Specifies whether it is ordered by rule. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ParentRef. object No - -
projectionRules The projection rules. list[object] No - -
scope Reference key for the typed object. string No - -
scopeReference ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerScopeReference defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ScopeReference. object No - -

Status.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValues defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ParentRef. object No - -

Status.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues.configParamValues{}

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesConfigParamValues defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Status.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues.parentRef

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.parentRef

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[]

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRule defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.

Field Description Type Required Default Enum
configValues ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValues defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues. object No - -
description A user defined description for the object. string No - -
fromName The attribute name that needs to be renamed. string No - -
isCascade Specifies whether to cascade or not. boolean No - -
isCaseSensitive Specifies if the rule is case sensitive. boolean No - -
isJavaRegexSyntax Specifies whether the rule uses a java regex syntax. boolean No - -
isSkipRemainingRulesOnMatch Specifies whether to skip remaining rules when a match is found. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
matchingStrategy The pattern matching strategy. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Name of the group. string No - -
names Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. list[string] No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ParentRef. object No - -
pattern The rule pattern. string No - -
ruleType The rule type. string No - -
scope Reference to a typed object. This can be either a key value to an object within the document, a shall referenced to a TypedObject, or a full TypedObject definition. Unknown nested fields are preserved. object (preserves unknown fields) No - -
toName The new attribute name. string No - -
types An arry of types. list[object (preserves unknown fields)] No - -

Status.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValues defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ParentRef. object No - -

Status.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues.configParamValues{}

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesConfigParamValues defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Status.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues.parentRef

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].parentRef

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.configParameterDefinitions{}.parameterType.typeHandler.scopeReference

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerScopeReference defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ScopeReference.

Field Description Type Required Default Enum
refObjectName The referenced object name for this reference. Set to the field name if the referenceType is BOUND_ENTITY_SHAPE_FIELD, else set to null. string No - -
referenceObject A key or shallow reference to an object. For direct reference, it points to the actual scope object. For BOUND_ENTITY_SHAPE or BOUND_ENTITY_SHAPE_FIELD, it points to the source or target operator. For OCI_FUNCTION_INPUT_SHAPE or OCI_FUNCTION_OUTPUT_SHAPE, it points to the OCI Function object. string Yes - -
referenceType The reference type for this reference. Set to null for a direct reference, for indirect references set to a type of association such as "BOUND_ENTITY_SHAPE". Current known reference type values are "BOUND_ENTITY_SHAPE", "BOUND_ENTITY_SHAPE_FIELD", "OCI_FUNCTION_INPUT_SHAPE", "OCI_FUNCTION_OUTPUT_SHAPE" string No - -

Status.configurationDetails.dataAsset.nativeTypeSystem.types[].configDefinition.parentRef

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeConfigDefinitionParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ConfigDefinition.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.configurationDetails.dataAsset.nativeTypeSystem.types[].parentRef

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetNativeTypeSystemTypeParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.NativeTypeSystem.Type.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.configurationDetails.dataAsset.parentRef

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.configurationDetails.dataAsset.stagingConnection

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionObservedState defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.

Field Description Type Required Default Enum
accessKey ExternalPublicationConfigurationDetailsDataAssetStagingConnectionAccessKey defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.AccessKey. object No - -
accessTokenUrl Specifies the endpoint used to exchange authentication credentials for access tokens string No - -
authHeader Optional header name if used other than default header(Authorization). string No - -
clientId Specifies the client ID key for specific application string No - -
clientSecret ExternalPublicationConfigurationDetailsDataAssetStagingConnectionClientSecret defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.ClientSecret. object No - -
connectionProperties The properties for the connection. list[object] No - -
credentialFileContent The credential file content from an Oracle Object Storage wallet. string No - -
dataNodePrincipal The HDFS Data Node principal. string No - -
defaultExternalStorage ExternalPublicationConfigurationDetailsDataAssetStagingConnectionDefaultExternalStorage defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.DefaultExternalStorage. object No - -
description User-defined description for the connection. string No - -
fingerPrint The fingerprint for the user. string No - -
grantType Specifies the OAuth2 grant mechanism. Example CLIENT_CREDENTIALS, Implicit Flow etc. string No - -
hdfsPrincipal The HDFS principal. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isDefault The default property for the connection. boolean No - -
jsonData - string No - -
key Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create. string No - -
keyDistributionCenter The HDFS Key Distribution Center. string No - -
keyMap A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. map[string, string] No - -
keyTabContent ExternalPublicationConfigurationDetailsDataAssetStagingConnectionKeyTabContent defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.KeyTabContent. object No - -
metadata ExternalPublicationConfigurationDetailsDataAssetStagingConnectionMetadata defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.Metadata. object No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
nameNodePrincipal The HDFS Name Node principal. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef ExternalPublicationConfigurationDetailsDataAssetStagingConnectionParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.ParentRef. object No - -
passPhrase The passphrase for the connection. string No - -
passwordSecret ExternalPublicationConfigurationDetailsDataAssetStagingConnectionPasswordSecret defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.PasswordSecret. object No - -
primarySchema ExternalPublicationConfigurationDetailsDataAssetStagingConnectionPrimarySchema defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.PrimarySchema. object No - -
realm HDFS Realm name. string No - -
scope Specifies the OAuth scopes that limit the permissions granted by an access token. string No - -
secretKey ExternalPublicationConfigurationDetailsDataAssetStagingConnectionSecretKey defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.SecretKey. object No - -
tnsAlias The Autonomous Data Warehouse instance service name. string No - -
tnsNames Array of service names that are available for selection in the tnsAlias property. list[string] No - -
userId The OCI user OCID for the user to connect to. string No - -
username The user name for the connection. string No - -

Status.configurationDetails.dataAsset.stagingConnection.accessKey

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionAccessKey defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.AccessKey.

Field Description Type Required Default Enum
secretConfig ExternalPublicationConfigurationDetailsDataAssetStagingConnectionAccessKeySecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.AccessKey.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Status.configurationDetails.dataAsset.stagingConnection.accessKey.secretConfig

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionAccessKeySecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.AccessKey.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Status.configurationDetails.dataAsset.stagingConnection.clientSecret

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionClientSecret defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.ClientSecret.

Field Description Type Required Default Enum
secretConfig ExternalPublicationConfigurationDetailsDataAssetStagingConnectionClientSecretSecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.ClientSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Status.configurationDetails.dataAsset.stagingConnection.clientSecret.secretConfig

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionClientSecretSecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.ClientSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Status.configurationDetails.dataAsset.stagingConnection.connectionProperties[]

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionConnectionProperty defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.ConnectionProperty.

Field Description Type Required Default Enum
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
value The value for the connection name property. string No - -

Status.configurationDetails.dataAsset.stagingConnection.defaultExternalStorage

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionDefaultExternalStorage defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.DefaultExternalStorage.

Field Description Type Required Default Enum
bucket Bucket Name where BICC extracts stores the files string No - -
host Object Storage host Url. DO not give http/https. string No - -
namespace Namespace for the OOS bucket string No - -
storageId Id of the external stoarge configured in BICC console. Usually its numeric. string No - -
storageName Name of the external storage configured in BICC console string No - -
tenancyId Tenancy OCID for the OOS bucket string No - -

Status.configurationDetails.dataAsset.stagingConnection.keyTabContent

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionKeyTabContent defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.KeyTabContent.

Field Description Type Required Default Enum
secretConfig ExternalPublicationConfigurationDetailsDataAssetStagingConnectionKeyTabContentSecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.KeyTabContent.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Status.configurationDetails.dataAsset.stagingConnection.keyTabContent.secretConfig

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionKeyTabContentSecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.KeyTabContent.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Status.configurationDetails.dataAsset.stagingConnection.metadata

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionMetadata defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.Metadata.

Field Description Type Required Default Enum
aggregator ExternalPublicationConfigurationDetailsDataAssetStagingConnectionMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ExternalPublicationConfigurationDetailsDataAssetStagingConnectionMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.configurationDetails.dataAsset.stagingConnection.metadata.aggregator

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.configurationDetails.dataAsset.stagingConnection.metadata.countStatistics

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Status.configurationDetails.dataAsset.stagingConnection.metadata.countStatistics.objectTypeCountList[]

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionMetadataCountStatisticsObjectTypeCountList defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.configurationDetails.dataAsset.stagingConnection.parentRef

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.configurationDetails.dataAsset.stagingConnection.passwordSecret

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionPasswordSecret defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.PasswordSecret.

Field Description Type Required Default Enum
secretConfig ExternalPublicationConfigurationDetailsDataAssetStagingConnectionPasswordSecretSecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.PasswordSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Status.configurationDetails.dataAsset.stagingConnection.passwordSecret.secretConfig

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionPasswordSecretSecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.PasswordSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Status.configurationDetails.dataAsset.stagingConnection.primarySchema

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionPrimarySchema defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.PrimarySchema.

Field Description Type Required Default Enum
defaultConnection The default connection key. string No - -
description User-defined description for the schema. string No - -
externalKey The external key for the object. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isHasContainers Specifies whether the schema has containers. boolean No - -
key The object key. string No - -
metadata ExternalPublicationConfigurationDetailsDataAssetStagingConnectionPrimarySchemaMetadata defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.PrimarySchema.Metadata. object No - -
modelType The object's type. string No - -
modelVersion The object's model version. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef ExternalPublicationConfigurationDetailsDataAssetStagingConnectionPrimarySchemaParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.PrimarySchema.ParentRef. object No - -
resourceName A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters. string No - -

Status.configurationDetails.dataAsset.stagingConnection.primarySchema.metadata

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionPrimarySchemaMetadata defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.PrimarySchema.Metadata.

Field Description Type Required Default Enum
aggregator ExternalPublicationConfigurationDetailsDataAssetStagingConnectionPrimarySchemaMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.PrimarySchema.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ExternalPublicationConfigurationDetailsDataAssetStagingConnectionPrimarySchemaMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.PrimarySchema.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.configurationDetails.dataAsset.stagingConnection.primarySchema.metadata.aggregator

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionPrimarySchemaMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.PrimarySchema.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.configurationDetails.dataAsset.stagingConnection.primarySchema.metadata.countStatistics

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionPrimarySchemaMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.PrimarySchema.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Status.configurationDetails.dataAsset.stagingConnection.primarySchema.metadata.countStatistics.objectTypeCountList[]

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionPrimarySchemaMetadataCountStatisticsObjectTypeCountList defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.PrimarySchema.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.configurationDetails.dataAsset.stagingConnection.primarySchema.parentRef

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionPrimarySchemaParentRef defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.PrimarySchema.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.configurationDetails.dataAsset.stagingConnection.secretKey

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionSecretKey defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.SecretKey.

Field Description Type Required Default Enum
secretConfig ExternalPublicationConfigurationDetailsDataAssetStagingConnectionSecretKeySecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.SecretKey.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Status.configurationDetails.dataAsset.stagingConnection.secretKey.secretConfig

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetStagingConnectionSecretKeySecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.StagingConnection.SecretKey.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Status.configurationDetails.dataAsset.walletPasswordSecret

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetWalletPasswordSecret defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.WalletPasswordSecret.

Field Description Type Required Default Enum
secretConfig ExternalPublicationConfigurationDetailsDataAssetWalletPasswordSecretSecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.WalletPasswordSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Status.configurationDetails.dataAsset.walletPasswordSecret.secretConfig

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetWalletPasswordSecretSecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.WalletPasswordSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Status.configurationDetails.dataAsset.walletSecret

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetWalletSecret defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.WalletSecret.

Field Description Type Required Default Enum
secretConfig ExternalPublicationConfigurationDetailsDataAssetWalletSecretSecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.WalletSecret.SecretConfig. object No - -
value Attribute to provide sensitive content. string No - -

Status.configurationDetails.dataAsset.walletSecret.secretConfig

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsDataAssetWalletSecretSecretConfig defines nested fields for ExternalPublication.ConfigurationDetails.DataAsset.WalletSecret.SecretConfig.

Field Description Type Required Default Enum
jsonData - string No - -
modelType - string No - -
secretId OCID of the OCI vault secret string No - -

Status.configurationDetails.schema

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsSchema defines nested fields for ExternalPublication.ConfigurationDetails.Schema.

Field Description Type Required Default Enum
defaultConnection The default connection key. string No - -
description User-defined description for the schema. string No - -
externalKey The external key for the object. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isHasContainers Specifies whether the schema has containers. boolean No - -
key The object key. string No - -
metadata ExternalPublicationConfigurationDetailsSchemaMetadata defines nested fields for ExternalPublication.ConfigurationDetails.Schema.Metadata. object No - -
modelType The object's type. string No - -
modelVersion The object's model version. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef ExternalPublicationConfigurationDetailsSchemaParentRef defines nested fields for ExternalPublication.ConfigurationDetails.Schema.ParentRef. object No - -
resourceName A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters. string No - -

Status.configurationDetails.schema.metadata

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsSchemaMetadata defines nested fields for ExternalPublication.ConfigurationDetails.Schema.Metadata.

Field Description Type Required Default Enum
aggregator ExternalPublicationConfigurationDetailsSchemaMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.Schema.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ExternalPublicationConfigurationDetailsSchemaMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.Schema.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.configurationDetails.schema.metadata.aggregator

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsSchemaMetadataAggregator defines nested fields for ExternalPublication.ConfigurationDetails.Schema.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.configurationDetails.schema.metadata.countStatistics

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsSchemaMetadataCountStatistics defines nested fields for ExternalPublication.ConfigurationDetails.Schema.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Status.configurationDetails.schema.metadata.countStatistics.objectTypeCountList[]

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsSchemaMetadataCountStatisticsObjectTypeCountList defines nested fields for ExternalPublication.ConfigurationDetails.Schema.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.configurationDetails.schema.parentRef

Back to ExternalPublication status

ExternalPublicationConfigurationDetailsSchemaParentRef defines nested fields for ExternalPublication.ConfigurationDetails.Schema.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.metadata

Back to ExternalPublication status

ExternalPublicationMetadata defines nested fields for ExternalPublication.Metadata.

Field Description Type Required Default Enum
aggregator ExternalPublicationMetadataAggregator defines nested fields for ExternalPublication.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ExternalPublicationMetadataCountStatistics defines nested fields for ExternalPublication.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.metadata.aggregator

Back to ExternalPublication status

ExternalPublicationMetadataAggregator defines nested fields for ExternalPublication.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.metadata.countStatistics

Back to ExternalPublication status

ExternalPublicationMetadataCountStatistics defines nested fields for ExternalPublication.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] No - -

Status.metadata.countStatistics.objectTypeCountList[]

Back to ExternalPublication status

ExternalPublicationMetadataCountStatisticsObjectTypeCountList defines nested fields for ExternalPublication.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.parentRef

Back to ExternalPublication status

ExternalPublicationParentRef defines nested fields for ExternalPublication.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.resourceConfiguration

Back to ExternalPublication status

ExternalPublicationResourceConfiguration defines nested fields for ExternalPublication.ResourceConfiguration.

Field Description Type Required Default Enum
driverShape The VM shape of the driver used while creating an Oracle Cloud Infrastructure Data Flow application. It sets the driver cores and memory. string Yes - -
executorShape The shape of the executor used while creating an Oracle Cloud Infrastructure Data Flow application. It sets the executor cores and memory. string Yes - -
sparkVersion The version of the spark used while creating an Oracle Cloud Infrastructure Data Flow application. string Yes - -
totalExecutors Number of executor VMs requested while creating an Oracle Cloud Infrastructure Data Flow application. integer Yes - -

Status.status

Back to ExternalPublication 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

Back to ExternalPublication status

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

Back to ExternalPublication status

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[]

Back to ExternalPublication status

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

ExternalPublicationValidation

ExternalPublicationValidation is the Schema for the externalpublicationvalidations API.

  • Plural: externalpublicationvalidations
  • Scope: Namespaced
  • APIVersion: dataintegration.oracle.com/v1beta1
  • Sample: Sample (config/samples/dataintegration_v1beta1_externalpublicationvalidation.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

ExternalPublicationValidationSpec defines the desired state of ExternalPublicationValidation.

Field Description Type Required Default Enum
key Generated key that can be used in API calls to identify the task. On scenarios where reference to the task is needed, a value can be passed in the create operation. string No - -

Status

ExternalPublicationValidationStatus defines the observed state of ExternalPublicationValidation.

Field Description Type Required Default Enum
errorMessageCount Total number of validation error messages. integer No - -
infoMessageCount Total number of validation information messages. integer No - -
key Objects use a 36 character key as unique ID. It is system generated and cannot be modified. string No - -
status - object Yes - -
totalMessageCount Total number of validation messages. integer No - -
validationMessages Detailed information of the data flow object validation. map[string, list[object]] No - -
warnMessageCount Total number of validation warning messages. integer No - -

Status.status

Back to ExternalPublicationValidation 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

Back to ExternalPublicationValidation status

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

Back to ExternalPublicationValidation status

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[]

Back to ExternalPublicationValidation status

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

Status.validationMessages{}

Back to ExternalPublicationValidation status

No documented fields in the checked-in CRD schema.

Folder

Folder is the Schema for the folders API.

  • Plural: folders
  • Scope: Namespaced
  • APIVersion: dataintegration.oracle.com/v1beta1
  • Sample: Sample (config/samples/dataintegration_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
categoryName The category name. string No - -
description A user defined description for the folder. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string Yes - -
key Currently not used on folder creation. Reserved for future. string No - -
modelType The type of the object. string Yes - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string Yes - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer Yes - -
parentRef FolderParentRef defines nested fields for Folder.ParentRef. object No - -
registryMetadata FolderRegistryMetadata defines nested fields for Folder.RegistryMetadata. object Yes - -

Spec.parentRef

Back to Folder spec

FolderParentRef defines nested fields for Folder.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.registryMetadata

Back to Folder spec

FolderRegistryMetadata defines nested fields for Folder.RegistryMetadata.

Field Description Type Required Default Enum
aggregatorKey The owning object's key for this object. string No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
key The identifying key for the object. string No - -
labels Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version. integer No - -

Status

FolderStatus defines the observed state of Folder.

Field Description Type Required Default Enum
categoryName The category name. string No - -
description A user defined description for the folder. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
key Generated key that can be used in API calls to identify folder. string No - -
keyMap A key map. If provided, the key is replaced with generated key. This structure provides mapping between user provided key and generated key. map[string, string] No - -
metadata FolderMetadata defines nested fields for Folder.Metadata. object No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef FolderParentRef defines nested fields for Folder.ParentRef. object No - -
status - object Yes - -

Status.metadata

Back to Folder status

FolderMetadata defines nested fields for Folder.Metadata.

Field Description Type Required Default Enum
aggregator FolderMetadataAggregator defines nested fields for Folder.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics FolderMetadataCountStatistics defines nested fields for Folder.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.metadata.aggregator

Back to Folder status

FolderMetadataAggregator defines nested fields for Folder.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.metadata.countStatistics

Back to Folder status

FolderMetadataCountStatistics defines nested fields for Folder.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] No - -

Status.metadata.countStatistics.objectTypeCountList[]

Back to Folder status

FolderMetadataCountStatisticsObjectTypeCountList defines nested fields for Folder.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.parentRef

Back to Folder status

FolderParentRef defines nested fields for Folder.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.status

Back to Folder 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

Back to Folder status

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

Back to Folder status

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[]

Back to Folder status

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

FunctionLibrary

FunctionLibrary is the Schema for the functionlibraries API.

  • Plural: functionlibraries
  • Scope: Namespaced
  • APIVersion: dataintegration.oracle.com/v1beta1
  • Sample: Sample (config/samples/dataintegration_v1beta1_functionlibrary.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

FunctionLibrarySpec defines the desired state of FunctionLibrary.

Field Description Type Required Default Enum
categoryName The category name. string No - -
description A user defined description for the FunctionLibrary. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string Yes - -
key Currently not used on FunctionLibrary creation. Reserved for future. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string Yes - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
registryMetadata FunctionLibraryRegistryMetadata defines nested fields for FunctionLibrary.RegistryMetadata. object Yes - -

Spec.registryMetadata

Back to FunctionLibrary spec

FunctionLibraryRegistryMetadata defines nested fields for FunctionLibrary.RegistryMetadata.

Field Description Type Required Default Enum
aggregatorKey The owning object's key for this object. string No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
key The identifying key for the object. string No - -
labels Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version. integer No - -

Status

FunctionLibraryStatus defines the observed state of FunctionLibrary.

Field Description Type Required Default Enum
categoryName The category name. string No - -
description A user defined description for the Function Library. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
key Generated key that can be used in API calls to identify FunctionLibrary. string No - -
keyMap A key map. If provided, the key is replaced with generated key. This structure provides mapping between user provided key and generated key. map[string, string] No - -
metadata FunctionLibraryMetadata defines nested fields for FunctionLibrary.Metadata. object No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef FunctionLibraryParentRef defines nested fields for FunctionLibrary.ParentRef. object No - -
status - object Yes - -

Status.metadata

Back to FunctionLibrary status

FunctionLibraryMetadata defines nested fields for FunctionLibrary.Metadata.

Field Description Type Required Default Enum
aggregator FunctionLibraryMetadataAggregator defines nested fields for FunctionLibrary.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics FunctionLibraryMetadataCountStatistics defines nested fields for FunctionLibrary.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.metadata.aggregator

Back to FunctionLibrary status

FunctionLibraryMetadataAggregator defines nested fields for FunctionLibrary.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.metadata.countStatistics

Back to FunctionLibrary status

FunctionLibraryMetadataCountStatistics defines nested fields for FunctionLibrary.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] No - -

Status.metadata.countStatistics.objectTypeCountList[]

Back to FunctionLibrary status

FunctionLibraryMetadataCountStatisticsObjectTypeCountList defines nested fields for FunctionLibrary.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.parentRef

Back to FunctionLibrary status

FunctionLibraryParentRef defines nested fields for FunctionLibrary.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.status

Back to FunctionLibrary 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

Back to FunctionLibrary status

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

Back to FunctionLibrary status

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[]

Back to FunctionLibrary status

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

ImportRequest

ImportRequest is the Schema for the importrequests API.

  • Plural: importrequests
  • Scope: Namespaced
  • APIVersion: dataintegration.oracle.com/v1beta1
  • Sample: Sample (config/samples/dataintegration_v1beta1_importrequest.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

ImportRequestSpec defines the desired state of ImportRequest.

Field Description Type Required Default Enum
areDataAssetReferencesIncluded This field controls if the data asset references will be included during import. boolean No - -
bucketName Name of the Object Storage bucket where the object will be imported from. string Yes - -
fileName Name of the zip file to be imported. string Yes - -
importConflictResolution ImportRequestImportConflictResolution defines nested fields for ImportRequest.ImportConflictResolution. object No - -
objectKeyForImport Key of the object inside which all the objects will be imported string No - -
objectStorageRegion Region of the object storage (if using object storage of different region) string No - -
objectStorageTenancyId Optional parameter to point to object storage tenancy (if using Object Storage of different tenancy) string No - -
status The status of the object. string No - -

Spec.importConflictResolution

Back to ImportRequest spec

ImportRequestImportConflictResolution defines nested fields for ImportRequest.ImportConflictResolution.

Field Description Type Required Default Enum
duplicatePrefix In case of DUPLICATE mode, prefix will be used to disambiguate the object. string No - -
duplicateSuffix In case of DUPLICATE mode, suffix will be used to disambiguate the object. string No - -
importConflictResolutionType Import Objects Conflict resolution Type (RETAIN/DUPLICATE/REPLACE). string Yes - -

Status

ImportRequestStatus defines the observed state of ImportRequest.

Field Description Type Required Default Enum
areDataAssetReferencesIncluded This field controls if the data asset references will be included during import. boolean No - -
bucketName The name of the Object Storage Bucket where the objects will be imported from string No - -
createdBy Name of the user who initiated import request. string No - -
errorMessages Contains key of the error map[string, string] No - -
fileName Name of the zip file from which objects will be imported. string No - -
importConflictResolution ImportRequestImportConflictResolution defines nested fields for ImportRequest.ImportConflictResolution. object No - -
importedObjects The array of imported object details. list[object] No - -
key Import object request key string No - -
name Name of the import request. string No - -
objectKeyForImport Key of the object inside which all the objects will be imported string No - -
objectStorageRegion Region of the object storage (if using object storage of different region) string No - -
objectStorageTenancyId Optional parameter to point to object storage tenancy (if using Object Storage of different tenancy) string No - -
sdkStatus Import Objects request status. This uses a distinct JSON name so it can coexist with the OSOK status envelope. string No - -
status - object Yes - -
timeEndedInMillis Time at which the request was completely processed. integer (int64) No - -
timeStartedInMillis Time at which the request started getting processed. integer (int64) No - -
totalImportedObjectCount Number of objects that are imported. integer No - -

Status.importConflictResolution

Back to ImportRequest status

ImportRequestImportConflictResolution defines nested fields for ImportRequest.ImportConflictResolution.

Field Description Type Required Default Enum
duplicatePrefix In case of DUPLICATE mode, prefix will be used to disambiguate the object. string No - -
duplicateSuffix In case of DUPLICATE mode, suffix will be used to disambiguate the object. string No - -
importConflictResolutionType Import Objects Conflict resolution Type (RETAIN/DUPLICATE/REPLACE). string Yes - -

Status.importedObjects[]

Back to ImportRequest status

ImportRequestImportedObject defines nested fields for ImportRequest.ImportedObject.

Field Description Type Required Default Enum
aggregatorKey Aggregator key string No - -
identifier Object identifier string No - -
name Name of the object string No - -
namePath Object name path string No - -
newKey New key of the object string No - -
objectType Object type string No - -
objectVersion Object version string No - -
oldKey Old key of the object string No - -
resolutionAction Object resolution action string No - -
timeUpdatedInMillis time at which this object was last updated. integer (int64) No - -

Status.status

Back to ImportRequest 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

Back to ImportRequest status

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

Back to ImportRequest status

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[]

Back to ImportRequest status

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

Patch

Patch is the Schema for the patches API.

  • Plural: patches
  • Scope: Namespaced
  • APIVersion: dataintegration.oracle.com/v1beta1
  • Sample: Sample (config/samples/dataintegration_v1beta1_patch.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

PatchSpec defines the desired state of Patch.

Field Description Type Required Default Enum
description Detailed description for the object. string No - -
identifier Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. string Yes - -
key The object's key. string No - -
modelVersion The object's model version. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string Yes - -
objectKeys The array of object keys to publish into application. list[string] Yes - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
patchType The type of the patch applied or being applied on the application. string Yes - -
registryMetadata PatchRegistryMetadata defines nested fields for Patch.RegistryMetadata. object No - -

Spec.registryMetadata

Back to Patch spec

PatchRegistryMetadata defines nested fields for Patch.RegistryMetadata.

Field Description Type Required Default Enum
aggregatorKey The owning object's key for this object. string No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
key The identifying key for the object. string No - -
labels Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version. integer No - -

Status

PatchStatus defines the observed state of Patch.

Field Description Type Required Default Enum
applicationVersion The application version of the patch. integer No - -
dependentObjectMetadata List of dependent objects in this patch. list[object] No - -
description Detailed description for the object. string No - -
errorMessages The errors encountered while applying the patch, if any. map[string, string] No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
key The object key. string No - -
keyMap A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. map[string, string] No - -
metadata PatchMetadata defines nested fields for Patch.Metadata. object No - -
modelType The object type. string No - -
modelVersion The object's model version. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef PatchParentRef defines nested fields for Patch.ParentRef. object No - -
patchObjectMetadata List of objects that are published or unpublished in this patch. list[object] No - -
patchStatus Status of the patch applied or being applied on the application string No - -
patchType The type of the patch applied or being applied on the application. string No - -
status - object Yes - -
timePatched The date and time the patch was applied, in the timestamp format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). string No - -

Status.dependentObjectMetadata[]

Back to Patch status

PatchDependentObjectMetadata defines nested fields for Patch.DependentObjectMetadata.

Field Description Type Required Default Enum
action The patch action indicating if object was created, updated, or deleted. string No - -
identifier Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
key The key of the object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
namePath The fully qualified path of the published object, which would include its project and folder. string No - -
objectVersion The object version. integer No - -
type The type of the object in patch. string No - -

Status.metadata

Back to Patch status

PatchMetadata defines nested fields for Patch.Metadata.

Field Description Type Required Default Enum
aggregator PatchMetadataAggregator defines nested fields for Patch.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics PatchMetadataCountStatistics defines nested fields for Patch.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.metadata.aggregator

Back to Patch status

PatchMetadataAggregator defines nested fields for Patch.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.metadata.countStatistics

Back to Patch status

PatchMetadataCountStatistics defines nested fields for Patch.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] No - -

Status.metadata.countStatistics.objectTypeCountList[]

Back to Patch status

PatchMetadataCountStatisticsObjectTypeCountList defines nested fields for Patch.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.parentRef

Back to Patch status

PatchParentRef defines nested fields for Patch.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.patchObjectMetadata[]

Back to Patch status

PatchObjectMetadata defines nested fields for Patch.PatchObjectMetadata.

Field Description Type Required Default Enum
action The patch action indicating if object was created, updated, or deleted. string No - -
identifier Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
key The key of the object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
namePath The fully qualified path of the published object, which would include its project and folder. string No - -
objectVersion The object version. integer No - -
type The type of the object in patch. string No - -

Status.status

Back to Patch 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

Back to Patch status

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

Back to Patch status

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[]

Back to Patch status

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

Pipeline

Pipeline is the Schema for the pipelines API.

  • Plural: pipelines
  • Scope: Namespaced
  • APIVersion: dataintegration.oracle.com/v1beta1
  • Sample: Sample (config/samples/dataintegration_v1beta1_pipeline.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

PipelineSpec defines the desired state of Pipeline.

Field Description Type Required Default Enum
description Detailed description for the object. string No - -
flowConfigValues JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string Yes - -
key Generated key that can be used in API calls to identify pipeline. On scenarios where reference to the pipeline is needed, a value can be passed in create. string No - -
modelType The type of the object. string No - -
modelVersion This is a version number that is used by the service to upgrade objects if needed through releases of the service. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string Yes - -
nodes A list of nodes attached to the pipeline list[object (preserves unknown fields)] No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. integer No - -
parameters A list of additional parameters required in pipeline. list[object (preserves unknown fields)] No - -
parentRef PipelineParentRef defines nested fields for Pipeline.ParentRef. object No - -
registryMetadata PipelineRegistryMetadata defines nested fields for Pipeline.RegistryMetadata. object Yes - -
variables The list of variables required in pipeline. list[object (preserves unknown fields)] No - -

Spec.parentRef

Back to Pipeline spec

PipelineParentRef defines nested fields for Pipeline.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.registryMetadata

Back to Pipeline spec

PipelineRegistryMetadata defines nested fields for Pipeline.RegistryMetadata.

Field Description Type Required Default Enum
aggregatorKey The owning object's key for this object. string No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
key The identifying key for the object. string No - -
labels Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version. integer No - -

Status

PipelineStatus defines the observed state of Pipeline.

Field Description Type Required Default Enum
description Detailed description for the object. string No - -
flowConfigValues JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
key Generated key that can be used in API calls to identify pipeline. On scenarios where reference to the pipeline is needed, a value can be passed in create. string No - -
metadata JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
modelType The type of the object. string No - -
modelVersion This is a version number that is used by the service to upgrade objects if needed through releases of the service. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
nodes A list of nodes attached to the pipeline. list[object (preserves unknown fields)] No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. integer No - -
parameters A list of parameters for the pipeline, this allows certain aspects of the pipeline to be configured when the pipeline is executed. list[object (preserves unknown fields)] No - -
parentRef PipelineParentRef defines nested fields for Pipeline.ParentRef. object No - -
status - object Yes - -
variables The list of variables required in pipeline, variables can be used to store values that can be used as inputs to tasks in the pipeline. list[object (preserves unknown fields)] No - -

Status.parentRef

Back to Pipeline status

PipelineParentRef defines nested fields for Pipeline.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.status

Back to Pipeline 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

Back to Pipeline status

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

Back to Pipeline status

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[]

Back to Pipeline status

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

PipelineValidation

PipelineValidation is the Schema for the pipelinevalidations API.

  • Plural: pipelinevalidations
  • Scope: Namespaced
  • APIVersion: dataintegration.oracle.com/v1beta1
  • Sample: Sample (config/samples/dataintegration_v1beta1_pipelinevalidation.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

PipelineValidationSpec defines the desired state of PipelineValidation.

Field Description Type Required Default Enum
description Detailed description for the object. string No - -
flowConfigValues JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
key Generated key that can be used in API calls to identify pipeline. On scenarios where reference to the pipeline is needed, a value can be passed in create. string No - -
metadata JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
modelType The type of the object. string No - -
modelVersion This is a version number that is used by the service to upgrade objects if needed through releases of the service. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
nodes A list of nodes attached to the pipeline. list[object (preserves unknown fields)] No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. integer No - -
parameters A list of parameters for the pipeline, this allows certain aspects of the pipeline to be configured when the pipeline is executed. list[object (preserves unknown fields)] No - -
parentRef PipelineValidationParentRef defines nested fields for PipelineValidation.ParentRef. object No - -
variables The list of variables required in pipeline, variables can be used to store values that can be used as inputs to tasks in the pipeline. list[object (preserves unknown fields)] No - -

Spec.parentRef

Back to PipelineValidation spec

PipelineValidationParentRef defines nested fields for PipelineValidation.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status

PipelineValidationStatus defines the observed state of PipelineValidation.

Field Description Type Required Default Enum
description Detailed description for the object. string No - -
errorMessageCount The total number of validation error messages. integer No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
infoMessageCount The total number of validation information messages. integer No - -
key Objects will use a 36 character key as unique ID. It is system generated and cannot be modified. string No - -
metadata PipelineValidationMetadata defines nested fields for PipelineValidation.Metadata. object No - -
modelType The type of the object. string No - -
modelVersion This is a version number that is used by the service to upgrade objects if needed through releases of the service. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. integer No - -
parentRef PipelineValidationParentRef defines nested fields for PipelineValidation.ParentRef. object No - -
status - object Yes - -
totalMessageCount The total number of validation messages. integer No - -
validationMessages The detailed information of the pipeline object validation. map[string, list[object]] No - -
warnMessageCount The total number of validation warning messages. integer No - -

Status.metadata

Back to PipelineValidation status

PipelineValidationMetadata defines nested fields for PipelineValidation.Metadata.

Field Description Type Required Default Enum
aggregator PipelineValidationMetadataAggregator defines nested fields for PipelineValidation.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics PipelineValidationMetadataCountStatistics defines nested fields for PipelineValidation.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.metadata.aggregator

Back to PipelineValidation status

PipelineValidationMetadataAggregator defines nested fields for PipelineValidation.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.metadata.countStatistics

Back to PipelineValidation status

PipelineValidationMetadataCountStatistics defines nested fields for PipelineValidation.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Status.metadata.countStatistics.objectTypeCountList[]

Back to PipelineValidation status

PipelineValidationMetadataCountStatisticsObjectTypeCountList defines nested fields for PipelineValidation.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.parentRef

Back to PipelineValidation status

PipelineValidationParentRef defines nested fields for PipelineValidation.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.status

Back to PipelineValidation 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

Back to PipelineValidation status

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

Back to PipelineValidation status

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[]

Back to PipelineValidation status

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

Status.validationMessages{}

Back to PipelineValidation status

No documented fields in the checked-in CRD schema.

Project

Project is the Schema for the projects API.

  • Plural: projects
  • Scope: Namespaced
  • APIVersion: dataintegration.oracle.com/v1beta1
  • Sample: Sample (config/samples/dataintegration_v1beta1_project.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

ProjectSpec defines the desired state of Project.

Field Description Type Required Default Enum
description A user defined description for the project. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string Yes - -
key Generated key that can be used in API calls to identify project. string No - -
modelType The type of the object. string Yes - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string Yes - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer Yes - -
parentRef ProjectParentRef defines nested fields for Project.ParentRef. object No - -
registryMetadata ProjectRegistryMetadata defines nested fields for Project.RegistryMetadata. object No - -

Spec.parentRef

Back to Project spec

ProjectParentRef defines nested fields for Project.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.registryMetadata

Back to Project spec

ProjectRegistryMetadata defines nested fields for Project.RegistryMetadata.

Field Description Type Required Default Enum
aggregatorKey The owning object's key for this object. string No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
key The identifying key for the object. string No - -
labels Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version. integer No - -

Status

ProjectStatus defines the observed state of Project.

Field Description Type Required Default Enum
description A user defined description for the project. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
key Generated key that can be used in API calls to identify project. string No - -
keyMap A key map. If provided, the key is replaced with generated key. This structure provides mapping between user provided key and generated key. map[string, string] No - -
metadata ProjectMetadata defines nested fields for Project.Metadata. object No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef ProjectParentRef defines nested fields for Project.ParentRef. object No - -
status - object Yes - -

Status.metadata

Back to Project status

ProjectMetadata defines nested fields for Project.Metadata.

Field Description Type Required Default Enum
aggregator ProjectMetadataAggregator defines nested fields for Project.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ProjectMetadataCountStatistics defines nested fields for Project.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.metadata.aggregator

Back to Project status

ProjectMetadataAggregator defines nested fields for Project.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.metadata.countStatistics

Back to Project status

ProjectMetadataCountStatistics defines nested fields for Project.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] No - -

Status.metadata.countStatistics.objectTypeCountList[]

Back to Project status

ProjectMetadataCountStatisticsObjectTypeCountList defines nested fields for Project.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.parentRef

Back to Project status

ProjectParentRef defines nested fields for Project.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.status

Back to Project 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

Back to Project status

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

Back to Project status

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[]

Back to Project status

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

Schedule

Schedule is the Schema for the schedules API.

  • Plural: schedules
  • Scope: Namespaced
  • APIVersion: dataintegration.oracle.com/v1beta1
  • Sample: Sample (config/samples/dataintegration_v1beta1_schedule.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

ScheduleSpec defines the desired state of Schedule.

Field Description Type Required Default Enum
description Detailed description for the object. string No - -
frequencyDetails ScheduleFrequencyDetails defines nested fields for Schedule.FrequencyDetails. object No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string Yes - -
isDaylightAdjustmentEnabled A flag to indicate whether daylight adjustment should be considered or not. boolean No - -
key Generated key that can be used in API calls to identify schedule. On scenarios where reference to the schedule is needed, a value can be passed in create. string No - -
modelType The type of the object. string No - -
modelVersion This is a version number that is used by the service to upgrade objects if needed through releases of the service. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string Yes - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. integer No - -
parentRef ScheduleParentRef defines nested fields for Schedule.ParentRef. object No - -
registryMetadata ScheduleRegistryMetadata defines nested fields for Schedule.RegistryMetadata. object No - -
timezone The timezone for the schedule. string No - -

Spec.frequencyDetails

Back to Schedule spec

ScheduleFrequencyDetails defines nested fields for Schedule.FrequencyDetails.

Field Description Type Required Default Enum
customExpression This holds the complete cron expression for this schedule, for example, 10 0/5 * * * ? that fires every 5 minutes, at 10 seconds after the minute (i.e. 10:00:10 am, 10:05:10 am, etc.) string No - -
dayOfWeek This holds the day of the week on which the schedule should be triggered. string No - -
days A list of days of the month to be scheduled. i.e. excute every 2nd,3rd, 10th of the month. list[integer] No - -
frequency the frequency of the schedule. string No - -
interval This hold the repeatability aspect of a schedule. i.e. in a monhtly frequency, a task can be scheduled for every month, once in two months, once in tree months etc. integer No - -
jsonData - string No - -
modelType - string No - -
time ScheduleFrequencyDetailsTime defines nested fields for Schedule.FrequencyDetails.Time. object No - -
weekOfMonth This holds the week of the month in which the schedule should be triggered. string No - -

Spec.frequencyDetails.time

Back to Schedule spec

ScheduleFrequencyDetailsTime defines nested fields for Schedule.FrequencyDetails.Time.

Field Description Type Required Default Enum
hour The hour value. integer No - -
minute The minute value. integer No - -
second The second value. integer No - -

Spec.parentRef

Back to Schedule spec

ScheduleParentRef defines nested fields for Schedule.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.registryMetadata

Back to Schedule spec

ScheduleRegistryMetadata defines nested fields for Schedule.RegistryMetadata.

Field Description Type Required Default Enum
aggregatorKey The owning object's key for this object. string No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
key The identifying key for the object. string No - -
labels Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version. integer No - -

Status

ScheduleStatus defines the observed state of Schedule.

Field Description Type Required Default Enum
description Detailed description for the object. string No - -
frequencyDetails ScheduleFrequencyDetails defines nested fields for Schedule.FrequencyDetails. object No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isDaylightAdjustmentEnabled A flag to indicate daylight saving. boolean No - -
key Generated key that can be used in API calls to identify schedule. On scenarios where reference to the schedule is needed, a value can be passed in create. string No - -
metadata ScheduleMetadata defines nested fields for Schedule.Metadata. object No - -
modelType The type of the object. string No - -
modelVersion This is a version number that is used by the service to upgrade objects if needed through releases of the service. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. integer No - -
parentRef ScheduleParentRef defines nested fields for Schedule.ParentRef. object No - -
status - object Yes - -
timezone The timezone for the schedule. string No - -

Status.frequencyDetails

Back to Schedule status

ScheduleFrequencyDetails defines nested fields for Schedule.FrequencyDetails.

Field Description Type Required Default Enum
customExpression This holds the complete cron expression for this schedule, for example, 10 0/5 * * * ? that fires every 5 minutes, at 10 seconds after the minute (i.e. 10:00:10 am, 10:05:10 am, etc.) string No - -
dayOfWeek This holds the day of the week on which the schedule should be triggered. string No - -
days A list of days of the month to be scheduled. i.e. excute every 2nd,3rd, 10th of the month. list[integer] No - -
frequency the frequency of the schedule. string No - -
interval This hold the repeatability aspect of a schedule. i.e. in a monhtly frequency, a task can be scheduled for every month, once in two months, once in tree months etc. integer No - -
jsonData - string No - -
modelType - string No - -
time ScheduleFrequencyDetailsTime defines nested fields for Schedule.FrequencyDetails.Time. object No - -
weekOfMonth This holds the week of the month in which the schedule should be triggered. string No - -

Status.frequencyDetails.time

Back to Schedule status

ScheduleFrequencyDetailsTime defines nested fields for Schedule.FrequencyDetails.Time.

Field Description Type Required Default Enum
hour The hour value. integer No - -
minute The minute value. integer No - -
second The second value. integer No - -

Status.metadata

Back to Schedule status

ScheduleMetadata defines nested fields for Schedule.Metadata.

Field Description Type Required Default Enum
aggregator ScheduleMetadataAggregator defines nested fields for Schedule.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics ScheduleMetadataCountStatistics defines nested fields for Schedule.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.metadata.aggregator

Back to Schedule status

ScheduleMetadataAggregator defines nested fields for Schedule.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.metadata.countStatistics

Back to Schedule status

ScheduleMetadataCountStatistics defines nested fields for Schedule.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] No - -

Status.metadata.countStatistics.objectTypeCountList[]

Back to Schedule status

ScheduleMetadataCountStatisticsObjectTypeCountList defines nested fields for Schedule.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.parentRef

Back to Schedule status

ScheduleParentRef defines nested fields for Schedule.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.status

Back to Schedule 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

Back to Schedule status

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

Back to Schedule status

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[]

Back to Schedule status

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

Task

Task is the Schema for the tasks API.

  • Plural: tasks
  • Scope: Namespaced
  • APIVersion: dataintegration.oracle.com/v1beta1
  • Sample: Sample (config/samples/dataintegration_v1beta1_task.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

TaskSpec defines the desired state of Task.

Field Description Type Required Default Enum
additionalProperties Header value. string No - -
apiCallMode The REST invocation pattern to use. ASYNC_OCI_WORKREQUEST is being deprecated as well as cancelEndpoint/MethodType. string No - -
authConfig JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
authDetails JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
cancelEndpoint JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
cancelMethodType The REST method to use for canceling the original request. string No - -
cancelRestCallConfig JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
conditionalCompositeFieldMap JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
configProviderDelegate JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
dataFlow JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
dataflowApplication JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
description Detailed description for the object. string No - -
driverShapeDetails JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
endpoint JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
executeRestCallConfig JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
executorShapeDetails JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
headers Headers data for the request. Unknown nested fields are preserved. object (preserves unknown fields) No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string Yes - -
inputPorts An array of input ports. list[object (preserves unknown fields)] No - -
isConcurrentAllowed Whether the same task can be executed concurrently. boolean No - -
isSingleLoad Defines whether Data Loader task is used for single load or multiple boolean No - -
jsonData - string No - -
key Generated key that can be used in API calls to identify task. On scenarios where reference to the task is needed, a value can be passed in create. string No - -
methodType The REST method to use. This property is deprecated, use ExecuteRestCallConfig's methodType property instead. string No - -
modelType - string No - -
modelVersion The object's model version. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string Yes - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer Yes - -
opConfigValues JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
operation Describes the shape of the execution result Unknown nested fields are preserved. object (preserves unknown fields) No - -
outputPorts An array of output ports. list[object (preserves unknown fields)] No - -
parallelLoadLimit Defines the number of entities being loaded in parallel at a time for a Data Loader task integer No - -
parameters An array of parameters. list[object (preserves unknown fields)] No - -
parentRef TaskParentRef defines nested fields for Task.ParentRef. object No - -
pipeline JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
pollRestCallConfig JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
registryMetadata JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) Yes - -
script JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
sqlScriptType Indicates whether the task is invoking a custom SQL script or stored procedure. string No - -
typedExpressions List of typed expressions. list[object (preserves unknown fields)] No - -

Spec.parentRef

Back to Task spec

TaskParentRef defines nested fields for Task.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status

TaskStatus defines the observed state of Task.

Field Description Type Required Default Enum
apiCallMode The REST invocation pattern to use. ASYNC_OCI_WORKREQUEST is being deprecated as well as cancelEndpoint/MethodType. string No - -
authConfig JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
authDetails JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
cancelEndpoint JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
cancelMethodType The REST method to use for canceling the original request. string No - -
cancelRestCallConfig JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
conditionalCompositeFieldMap JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
configProviderDelegate JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
dataFlow JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
dataflowApplication JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
description Detailed description for the object. string No - -
driverShapeDetails JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
endpoint JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
executeRestCallConfig JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
executorShapeDetails JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
headers The headers for the REST call. This property is deprecated, use ExecuteRestCallConfig's headers property instead. Unknown nested fields are preserved. object (preserves unknown fields) No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
inputPorts An array of input ports. list[object (preserves unknown fields)] No - -
isConcurrentAllowed Whether the same task can be executed concurrently. boolean No - -
isSingleLoad Defines whether Data Loader task is used for single load or multiple boolean No - -
jsonData - string No - -
key Generated key that can be used in API calls to identify task. On scenarios where reference to the task is needed, a value can be passed in create. string No - -
keyMap A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. map[string, string] No - -
metadata JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
methodType The REST method to use. This property is deprecated, use ExecuteRestCallConfig's methodType property instead. string No - -
modelType - string No - -
modelVersion The object's model version. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
opConfigValues JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
operation Describes the shape of the execution result Unknown nested fields are preserved. object (preserves unknown fields) No - -
outputPorts An array of output ports. list[object (preserves unknown fields)] No - -
parallelLoadLimit Defines the number of entities being loaded in parallel at a time for a Data Loader task integer No - -
parameters An array of parameters. list[object (preserves unknown fields)] No - -
parentRef TaskParentRef defines nested fields for Task.ParentRef. object No - -
pipeline JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
pollRestCallConfig JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
registryMetadata JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
script JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
sqlScriptType Indicates whether the task is invoking a custom SQL script or stored procedure. string No - -
status - object Yes - -
typedExpressions List of typed expressions. list[object (preserves unknown fields)] No - -

Status.parentRef

Back to Task status

TaskParentRef defines nested fields for Task.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.status

Back to Task 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

Back to Task status

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

Back to Task status

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[]

Back to Task status

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

TaskRun

TaskRun is the Schema for the taskruns API.

  • Plural: taskruns
  • Scope: Namespaced
  • APIVersion: dataintegration.oracle.com/v1beta1
  • Sample: Sample (config/samples/dataintegration_v1beta1_taskrun.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

TaskRunSpec defines the desired state of TaskRun.

Field Description Type Required Default Enum
configProvider TaskRunConfigProvider defines nested fields for TaskRun.ConfigProvider. object No - -
description Detailed description for the object. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
key The key of the object. string No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
reRunType Supported re-run types string No - -
refTaskRunId Reference Task Run Id to be used for re-run string No - -
registryMetadata TaskRunRegistryMetadata defines nested fields for TaskRun.RegistryMetadata. object No - -
status The status of the object. string No - -
stepId Step Id for running from a certain step. string No - -
taskScheduleKey Optional task schedule key reference. string No - -

Spec.configProvider

Back to TaskRun spec

TaskRunConfigProvider defines nested fields for TaskRun.ConfigProvider.

Field Description Type Required Default Enum
bindings bindings map[string, object] No - -

Spec.configProvider.bindings{}

Back to TaskRun spec

TaskRunConfigProviderBindings defines nested fields for TaskRun.ConfigProvider.Bindings.

Field Description Type Required Default Enum
rootObjectValue This can be any object such as a file entity, a schema, or a table. Unknown nested fields are preserved. object (preserves unknown fields) No - -
simpleValue A simple value for the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Spec.registryMetadata

Back to TaskRun spec

TaskRunRegistryMetadata defines nested fields for TaskRun.RegistryMetadata.

Field Description Type Required Default Enum
aggregatorKey The owning object's key for this object. string No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
key The identifying key for the object. string No - -
labels Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version. integer No - -

Status

TaskRunStatus defines the observed state of TaskRun.

Field Description Type Required Default Enum
authMode The autorization mode for when the task was executed. string No - -
bytesProcessed The number of bytes processed in the task run. integer (int64) No - -
configProvider TaskRunConfigProvider defines nested fields for TaskRun.ConfigProvider. object No - -
description Detailed description for the object. string No - -
endTimeMillis The end time. integer (int64) No - -
errorMessage Contains an error message if status is ERROR. string No - -
executionErrors An array of execution errors from the run. list[string] No - -
expectedDuration The expected duration for the task run. number No - -
expectedDurationUnit The expected duration unit of measure. string No - -
externalId The external identifier for the task run. string No - -
identifier Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
inputs A map of the configuration provider input bindings of the run. map[string, object] No - -
isLogProcessingInProgress This field tells the user if there is any logs being fetched in backend for failure. Applicable only for failed pipeline tasks. boolean No - -
key The key of the object. string No - -
keyMap A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. map[string, string] No - -
lastUpdated The date and time the object was last updated. integer (int64) No - -
metadata TaskRunMetadata defines nested fields for TaskRun.Metadata. object No - -
metrics A map of metrics for the run. map[string, number] No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
opcRequestId The OPC request ID of execution of the task run. string No - -
outputs A map of the outputs of the run. map[string, object] No - -
parentRef TaskRunParentRef defines nested fields for TaskRun.ParentRef. object No - -
reRunType Supported re-run types string No - -
recordsWritten The number of records processed in the task run. integer (int64) No - -
refTaskRunId Reference Task Run Id to be used for re-run string No - -
retryAttempt Holds the particular attempt number. integer No - -
sdkStatus The status of the task run. This uses a distinct JSON name so it can coexist with the OSOK status envelope. string No - -
startTimeMillis The start time. integer (int64) No - -
status - object Yes - -
stepId Step Id for running from a certain step. string No - -
taskKey Task Key of the task for which TaskRun is being created. If not specified, the AggregatorKey in RegistryMetadata will be assumed to be the TaskKey string No - -
taskSchedule TaskRunTaskSchedule defines nested fields for TaskRun.TaskSchedule. object No - -
taskType The type of task run. string No - -
terminationErrors An array of termination errors from the run. list[string] No - -

Status.configProvider

Back to TaskRun status

TaskRunConfigProvider defines nested fields for TaskRun.ConfigProvider.

Field Description Type Required Default Enum
bindings bindings map[string, object] No - -

Status.configProvider.bindings{}

Back to TaskRun status

TaskRunConfigProviderBindings defines nested fields for TaskRun.ConfigProvider.Bindings.

Field Description Type Required Default Enum
rootObjectValue This can be any object such as a file entity, a schema, or a table. Unknown nested fields are preserved. object (preserves unknown fields) No - -
simpleValue A simple value for the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Status.inputs{}

Back to TaskRun status

TaskRunInputs defines nested fields for TaskRun.Inputs.

Field Description Type Required Default Enum
rootObjectValue This can be any object such as a file entity, a schema, or a table. Unknown nested fields are preserved. object (preserves unknown fields) No - -
simpleValue A simple value for the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Status.metadata

Back to TaskRun status

TaskRunMetadata defines nested fields for TaskRun.Metadata.

Field Description Type Required Default Enum
aggregator TaskRunMetadataAggregator defines nested fields for TaskRun.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics TaskRunMetadataCountStatistics defines nested fields for TaskRun.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.metadata.aggregator

Back to TaskRun status

TaskRunMetadataAggregator defines nested fields for TaskRun.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.metadata.countStatistics

Back to TaskRun status

TaskRunMetadataCountStatistics defines nested fields for TaskRun.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] No - -

Status.metadata.countStatistics.objectTypeCountList[]

Back to TaskRun status

TaskRunMetadataCountStatisticsObjectTypeCountList defines nested fields for TaskRun.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.outputs{}

Back to TaskRun status

TaskRunOutputs defines nested fields for TaskRun.Outputs.

Field Description Type Required Default Enum
rootObjectValue This can be any object such as a file entity, a schema, or a table. Unknown nested fields are preserved. object (preserves unknown fields) No - -
simpleValue A simple value for the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Status.parentRef

Back to TaskRun status

TaskRunParentRef defines nested fields for TaskRun.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.status

Back to TaskRun 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

Back to TaskRun status

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

Back to TaskRun status

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[]

Back to TaskRun status

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

Status.taskSchedule

Back to TaskRun status

TaskRunTaskSchedule defines nested fields for TaskRun.TaskSchedule.

Field Description Type Required Default Enum
authMode The authorization mode for the task. string No - -
configProviderDelegate TaskRunTaskScheduleConfigProviderDelegate defines nested fields for TaskRun.TaskSchedule.ConfigProviderDelegate. object No - -
description Detailed description for the object. string No - -
endTimeMillis The end time in milliseconds. integer (int64) No - -
expectedDuration The expected duration of the task execution. number No - -
expectedDurationUnit The expected duration unit of the task execution. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isBackfillEnabled Whether the backfill is enabled boolean No - -
isConcurrentAllowed Whether the same task can be executed concurrently. boolean No - -
isEnabled Whether the schedule is enabled. boolean No - -
key Generated key that can be used in API calls to identify taskSchedule. On scenarios where reference to the taskSchedule is needed, a value can be passed in create. string No - -
lastRunDetails TaskRunTaskScheduleLastRunDetails defines nested fields for TaskRun.TaskSchedule.LastRunDetails. object No - -
metadata TaskRunTaskScheduleMetadata defines nested fields for TaskRun.TaskSchedule.Metadata. object No - -
modelType The type of the object. string No - -
modelVersion This is a version number that is used by the service to upgrade objects if needed through releases of the service. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. integer No - -
parentRef TaskRunTaskScheduleParentRef defines nested fields for TaskRun.TaskSchedule.ParentRef. object No - -
retryAttempts The number of retry attempts. integer No - -
retryDelay The retry delay, the unit for measurement is in the property retry delay unit. number No - -
retryDelayUnit The unit for the retry delay. string No - -
scheduleRef TaskRunTaskScheduleScheduleRef defines nested fields for TaskRun.TaskSchedule.ScheduleRef. object No - -
startTimeMillis The start time in milliseconds. integer (int64) No - -

Status.taskSchedule.configProviderDelegate

Back to TaskRun status

TaskRunTaskScheduleConfigProviderDelegate defines nested fields for TaskRun.TaskSchedule.ConfigProviderDelegate.

Field Description Type Required Default Enum
bindings The configuration provider bindings. map[string, object] No - -

Status.taskSchedule.configProviderDelegate.bindings{}

Back to TaskRun status

TaskRunTaskScheduleConfigProviderDelegateBindings defines nested fields for TaskRun.TaskSchedule.ConfigProviderDelegate.Bindings.

Field Description Type Required Default Enum
rootObjectValue This can be any object such as a file entity, a schema, or a table. Unknown nested fields are preserved. object (preserves unknown fields) No - -
simpleValue A simple value for the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Status.taskSchedule.lastRunDetails

Back to TaskRun status

TaskRunTaskScheduleLastRunDetails defines nested fields for TaskRun.TaskSchedule.LastRunDetails.

Field Description Type Required Default Enum
description Detailed description for the object. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
key Generated key that can be used in API calls to identify Last run details of a task schedule. On scenarios where reference to the lastRunDetails is needed, a value can be passed in create. string No - -
lastRunTimeMillis Time in milliseconds for the pervious schedule. integer (int64) No - -
modelType The type of the object. string No - -
modelVersion This is a version number that is used by the service to upgrade objects if needed through releases of the service. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. integer No - -
parentRef TaskRunTaskScheduleLastRunDetailsParentRef defines nested fields for TaskRun.TaskSchedule.LastRunDetails.ParentRef. object No - -

Status.taskSchedule.lastRunDetails.parentRef

Back to TaskRun status

TaskRunTaskScheduleLastRunDetailsParentRef defines nested fields for TaskRun.TaskSchedule.LastRunDetails.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.taskSchedule.metadata

Back to TaskRun status

TaskRunTaskScheduleMetadata defines nested fields for TaskRun.TaskSchedule.Metadata.

Field Description Type Required Default Enum
aggregator TaskRunTaskScheduleMetadataAggregator defines nested fields for TaskRun.TaskSchedule.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics TaskRunTaskScheduleMetadataCountStatistics defines nested fields for TaskRun.TaskSchedule.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.taskSchedule.metadata.aggregator

Back to TaskRun status

TaskRunTaskScheduleMetadataAggregator defines nested fields for TaskRun.TaskSchedule.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.taskSchedule.metadata.countStatistics

Back to TaskRun status

TaskRunTaskScheduleMetadataCountStatistics defines nested fields for TaskRun.TaskSchedule.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] No - -

Status.taskSchedule.metadata.countStatistics.objectTypeCountList[]

Back to TaskRun status

TaskRunTaskScheduleMetadataCountStatisticsObjectTypeCountList defines nested fields for TaskRun.TaskSchedule.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.taskSchedule.parentRef

Back to TaskRun status

TaskRunTaskScheduleParentRef defines nested fields for TaskRun.TaskSchedule.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.taskSchedule.scheduleRef

Back to TaskRun status

TaskRunTaskScheduleScheduleRef defines nested fields for TaskRun.TaskSchedule.ScheduleRef.

Field Description Type Required Default Enum
description Detailed description for the object. string No - -
frequencyDetails TaskRunTaskScheduleScheduleRefFrequencyDetails defines nested fields for TaskRun.TaskSchedule.ScheduleRef.FrequencyDetails. object No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isDaylightAdjustmentEnabled A flag to indicate daylight saving. boolean No - -
key Generated key that can be used in API calls to identify schedule. On scenarios where reference to the schedule is needed, a value can be passed in create. string No - -
metadata TaskRunTaskScheduleScheduleRefMetadata defines nested fields for TaskRun.TaskSchedule.ScheduleRef.Metadata. object No - -
modelType The type of the object. string No - -
modelVersion This is a version number that is used by the service to upgrade objects if needed through releases of the service. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. integer No - -
parentRef TaskRunTaskScheduleScheduleRefParentRef defines nested fields for TaskRun.TaskSchedule.ScheduleRef.ParentRef. object No - -
timezone The timezone for the schedule. string No - -

Status.taskSchedule.scheduleRef.frequencyDetails

Back to TaskRun status

TaskRunTaskScheduleScheduleRefFrequencyDetails defines nested fields for TaskRun.TaskSchedule.ScheduleRef.FrequencyDetails.

Field Description Type Required Default Enum
customExpression This holds the complete cron expression for this schedule, for example, 10 0/5 * * * ? that fires every 5 minutes, at 10 seconds after the minute (i.e. 10:00:10 am, 10:05:10 am, etc.) string No - -
dayOfWeek This holds the day of the week on which the schedule should be triggered. string No - -
days A list of days of the month to be scheduled. i.e. excute every 2nd,3rd, 10th of the month. list[integer] No - -
frequency the frequency of the schedule. string No - -
interval This hold the repeatability aspect of a schedule. i.e. in a monhtly frequency, a task can be scheduled for every month, once in two months, once in tree months etc. integer No - -
jsonData - string No - -
modelType - string No - -
time TaskRunTaskScheduleScheduleRefFrequencyDetailsTime defines nested fields for TaskRun.TaskSchedule.ScheduleRef.FrequencyDetails.Time. object No - -
weekOfMonth This holds the week of the month in which the schedule should be triggered. string No - -

Status.taskSchedule.scheduleRef.frequencyDetails.time

Back to TaskRun status

TaskRunTaskScheduleScheduleRefFrequencyDetailsTime defines nested fields for TaskRun.TaskSchedule.ScheduleRef.FrequencyDetails.Time.

Field Description Type Required Default Enum
hour The hour value. integer No - -
minute The minute value. integer No - -
second The second value. integer No - -

Status.taskSchedule.scheduleRef.metadata

Back to TaskRun status

TaskRunTaskScheduleScheduleRefMetadata defines nested fields for TaskRun.TaskSchedule.ScheduleRef.Metadata.

Field Description Type Required Default Enum
aggregator TaskRunTaskScheduleScheduleRefMetadataAggregator defines nested fields for TaskRun.TaskSchedule.ScheduleRef.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics TaskRunTaskScheduleScheduleRefMetadataCountStatistics defines nested fields for TaskRun.TaskSchedule.ScheduleRef.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.taskSchedule.scheduleRef.metadata.aggregator

Back to TaskRun status

TaskRunTaskScheduleScheduleRefMetadataAggregator defines nested fields for TaskRun.TaskSchedule.ScheduleRef.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.taskSchedule.scheduleRef.metadata.countStatistics

Back to TaskRun status

TaskRunTaskScheduleScheduleRefMetadataCountStatistics defines nested fields for TaskRun.TaskSchedule.ScheduleRef.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] No - -

Status.taskSchedule.scheduleRef.metadata.countStatistics.objectTypeCountList[]

Back to TaskRun status

TaskRunTaskScheduleScheduleRefMetadataCountStatisticsObjectTypeCountList defines nested fields for TaskRun.TaskSchedule.ScheduleRef.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.taskSchedule.scheduleRef.parentRef

Back to TaskRun status

TaskRunTaskScheduleScheduleRefParentRef defines nested fields for TaskRun.TaskSchedule.ScheduleRef.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

TaskSchedule

TaskSchedule is the Schema for the taskschedules API.

  • Plural: taskschedules
  • Scope: Namespaced
  • APIVersion: dataintegration.oracle.com/v1beta1
  • Sample: Sample (config/samples/dataintegration_v1beta1_taskschedule.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

TaskScheduleSpec defines the desired state of TaskSchedule.

Field Description Type Required Default Enum
authMode The authorization mode for the task. string No - -
configProviderDelegate TaskScheduleConfigProviderDelegate defines nested fields for TaskSchedule.ConfigProviderDelegate. object No - -
description Detailed description for the object. string No - -
endTimeMillis The end time in milliseconds. integer (int64) No - -
expectedDuration The expected duration of the task execution. number No - -
expectedDurationUnit The expected duration unit of the task execution. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string Yes - -
isBackfillEnabled Whether the backfill is enabled. boolean No - -
isConcurrentAllowed Whether the same task can be executed concurrently. boolean No - -
isEnabled Whether the task schedule is enabled. boolean No - -
key Generated key that can be used in API calls to identify taskSchedule. On scenarios where reference to the taskSchedule is needed, a value can be passed in create. string No - -
modelType The type of the object. string No - -
modelVersion This is a version number that is used by the service to upgrade objects if needed through releases of the service. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string Yes - -
numberOfRetries The number of retries. integer No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. integer No - -
parentRef TaskScheduleParentRef defines nested fields for TaskSchedule.ParentRef. object No - -
registryMetadata TaskScheduleRegistryMetadata defines nested fields for TaskSchedule.RegistryMetadata. object No - -
retryDelay The retry delay, the unit for measurement is in the property retry delay unit. number No - -
retryDelayUnit The unit for the retry delay. string No - -
scheduleRef TaskScheduleScheduleRef defines nested fields for TaskSchedule.ScheduleRef. object No - -
startTimeMillis The start time in milliseconds. integer (int64) No - -

Spec.configProviderDelegate

Back to TaskSchedule spec

TaskScheduleConfigProviderDelegate defines nested fields for TaskSchedule.ConfigProviderDelegate.

Field Description Type Required Default Enum
bindings The configuration provider bindings. map[string, object] No - -

Spec.configProviderDelegate.bindings{}

Back to TaskSchedule spec

TaskScheduleConfigProviderDelegateBindings defines nested fields for TaskSchedule.ConfigProviderDelegate.Bindings.

Field Description Type Required Default Enum
rootObjectValue This can be any object such as a file entity, a schema, or a table. Unknown nested fields are preserved. object (preserves unknown fields) No - -
simpleValue A simple value for the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Spec.parentRef

Back to TaskSchedule spec

TaskScheduleParentRef defines nested fields for TaskSchedule.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.registryMetadata

Back to TaskSchedule spec

TaskScheduleRegistryMetadata defines nested fields for TaskSchedule.RegistryMetadata.

Field Description Type Required Default Enum
aggregatorKey The owning object's key for this object. string No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
key The identifying key for the object. string No - -
labels Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version. integer No - -

Spec.scheduleRef

Back to TaskSchedule spec

TaskScheduleScheduleRef defines nested fields for TaskSchedule.ScheduleRef.

Field Description Type Required Default Enum
description Detailed description for the object. string No - -
frequencyDetails TaskScheduleScheduleRefFrequencyDetails defines nested fields for TaskSchedule.ScheduleRef.FrequencyDetails. object No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isDaylightAdjustmentEnabled A flag to indicate daylight saving. boolean No - -
key Generated key that can be used in API calls to identify schedule. On scenarios where reference to the schedule is needed, a value can be passed in create. string No - -
metadata TaskScheduleScheduleRefMetadata defines nested fields for TaskSchedule.ScheduleRef.Metadata. object No - -
modelType The type of the object. string No - -
modelVersion This is a version number that is used by the service to upgrade objects if needed through releases of the service. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. integer No - -
parentRef TaskScheduleScheduleRefParentRef defines nested fields for TaskSchedule.ScheduleRef.ParentRef. object No - -
timezone The timezone for the schedule. string No - -

Spec.scheduleRef.frequencyDetails

Back to TaskSchedule spec

TaskScheduleScheduleRefFrequencyDetails defines nested fields for TaskSchedule.ScheduleRef.FrequencyDetails.

Field Description Type Required Default Enum
customExpression This holds the complete cron expression for this schedule, for example, 10 0/5 * * * ? that fires every 5 minutes, at 10 seconds after the minute (i.e. 10:00:10 am, 10:05:10 am, etc.) string No - -
dayOfWeek This holds the day of the week on which the schedule should be triggered. string No - -
days A list of days of the month to be scheduled. i.e. excute every 2nd,3rd, 10th of the month. list[integer] No - -
frequency the frequency of the schedule. string No - -
interval This hold the repeatability aspect of a schedule. i.e. in a monhtly frequency, a task can be scheduled for every month, once in two months, once in tree months etc. integer No - -
jsonData - string No - -
modelType - string No - -
time TaskScheduleScheduleRefFrequencyDetailsTime defines nested fields for TaskSchedule.ScheduleRef.FrequencyDetails.Time. object No - -
weekOfMonth This holds the week of the month in which the schedule should be triggered. string No - -

Spec.scheduleRef.frequencyDetails.time

Back to TaskSchedule spec

TaskScheduleScheduleRefFrequencyDetailsTime defines nested fields for TaskSchedule.ScheduleRef.FrequencyDetails.Time.

Field Description Type Required Default Enum
hour The hour value. integer No - -
minute The minute value. integer No - -
second The second value. integer No - -

Spec.scheduleRef.metadata

Back to TaskSchedule spec

TaskScheduleScheduleRefMetadata defines nested fields for TaskSchedule.ScheduleRef.Metadata.

Field Description Type Required Default Enum
aggregator TaskScheduleScheduleRefMetadataAggregator defines nested fields for TaskSchedule.ScheduleRef.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics TaskScheduleScheduleRefMetadataCountStatistics defines nested fields for TaskSchedule.ScheduleRef.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Spec.scheduleRef.metadata.aggregator

Back to TaskSchedule spec

TaskScheduleScheduleRefMetadataAggregator defines nested fields for TaskSchedule.ScheduleRef.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Spec.scheduleRef.metadata.countStatistics

Back to TaskSchedule spec

TaskScheduleScheduleRefMetadataCountStatistics defines nested fields for TaskSchedule.ScheduleRef.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Spec.scheduleRef.metadata.countStatistics.objectTypeCountList[]

Back to TaskSchedule spec

TaskScheduleScheduleRefMetadataCountStatisticsObjectTypeCountList defines nested fields for TaskSchedule.ScheduleRef.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Spec.scheduleRef.parentRef

Back to TaskSchedule spec

TaskScheduleScheduleRefParentRef defines nested fields for TaskSchedule.ScheduleRef.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status

TaskScheduleStatus defines the observed state of TaskSchedule.

Field Description Type Required Default Enum
authMode The authorization mode for the task. string No - -
configProviderDelegate TaskScheduleConfigProviderDelegate defines nested fields for TaskSchedule.ConfigProviderDelegate. object No - -
description Detailed description for the object. string No - -
endTimeMillis The end time in milliseconds. integer (int64) No - -
expectedDuration The expected duration of the task execution. number No - -
expectedDurationUnit The expected duration unit of the task execution. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isBackfillEnabled Whether the backfill is enabled boolean No - -
isConcurrentAllowed Whether the same task can be executed concurrently. boolean No - -
isEnabled Whether the schedule is enabled. boolean No - -
key Generated key that can be used in API calls to identify taskSchedule. On scenarios where reference to the taskSchedule is needed, a value can be passed in create. string No - -
lastRunDetails TaskScheduleLastRunDetails defines nested fields for TaskSchedule.LastRunDetails. object No - -
metadata TaskScheduleMetadata defines nested fields for TaskSchedule.Metadata. object No - -
modelType The type of the object. string No - -
modelVersion This is a version number that is used by the service to upgrade objects if needed through releases of the service. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
nextRunTimeMillis The time for next run in milliseconds. integer (int64) No - -
numberOfRetries The number of retries. integer No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. integer No - -
parentRef TaskScheduleParentRef defines nested fields for TaskSchedule.ParentRef. object No - -
retryAttempts The number of retry attempts. integer No - -
retryDelay The retry delay, the unit for measurement is in the property retry delay unit. number No - -
retryDelayUnit The unit for the retry delay. string No - -
scheduleRef TaskScheduleScheduleRef defines nested fields for TaskSchedule.ScheduleRef. object No - -
startTimeMillis The start time in milliseconds. integer (int64) No - -
status - object Yes - -

Status.configProviderDelegate

Back to TaskSchedule status

TaskScheduleConfigProviderDelegate defines nested fields for TaskSchedule.ConfigProviderDelegate.

Field Description Type Required Default Enum
bindings The configuration provider bindings. map[string, object] No - -

Status.configProviderDelegate.bindings{}

Back to TaskSchedule status

TaskScheduleConfigProviderDelegateBindings defines nested fields for TaskSchedule.ConfigProviderDelegate.Bindings.

Field Description Type Required Default Enum
rootObjectValue This can be any object such as a file entity, a schema, or a table. Unknown nested fields are preserved. object (preserves unknown fields) No - -
simpleValue A simple value for the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Status.lastRunDetails

Back to TaskSchedule status

TaskScheduleLastRunDetails defines nested fields for TaskSchedule.LastRunDetails.

Field Description Type Required Default Enum
description Detailed description for the object. string No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
key Generated key that can be used in API calls to identify Last run details of a task schedule. On scenarios where reference to the lastRunDetails is needed, a value can be passed in create. string No - -
lastRunTimeMillis Time in milliseconds for the pervious schedule. integer (int64) No - -
modelType The type of the object. string No - -
modelVersion This is a version number that is used by the service to upgrade objects if needed through releases of the service. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. integer No - -
parentRef TaskScheduleLastRunDetailsParentRef defines nested fields for TaskSchedule.LastRunDetails.ParentRef. object No - -

Status.lastRunDetails.parentRef

Back to TaskSchedule status

TaskScheduleLastRunDetailsParentRef defines nested fields for TaskSchedule.LastRunDetails.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.metadata

Back to TaskSchedule status

TaskScheduleMetadata defines nested fields for TaskSchedule.Metadata.

Field Description Type Required Default Enum
aggregator TaskScheduleMetadataAggregator defines nested fields for TaskSchedule.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics TaskScheduleMetadataCountStatistics defines nested fields for TaskSchedule.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.metadata.aggregator

Back to TaskSchedule status

TaskScheduleMetadataAggregator defines nested fields for TaskSchedule.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.metadata.countStatistics

Back to TaskSchedule status

TaskScheduleMetadataCountStatistics defines nested fields for TaskSchedule.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] No - -

Status.metadata.countStatistics.objectTypeCountList[]

Back to TaskSchedule status

TaskScheduleMetadataCountStatisticsObjectTypeCountList defines nested fields for TaskSchedule.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.parentRef

Back to TaskSchedule status

TaskScheduleParentRef defines nested fields for TaskSchedule.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.scheduleRef

Back to TaskSchedule status

TaskScheduleScheduleRef defines nested fields for TaskSchedule.ScheduleRef.

Field Description Type Required Default Enum
description Detailed description for the object. string No - -
frequencyDetails TaskScheduleScheduleRefFrequencyDetails defines nested fields for TaskSchedule.ScheduleRef.FrequencyDetails. object No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
isDaylightAdjustmentEnabled A flag to indicate daylight saving. boolean No - -
key Generated key that can be used in API calls to identify schedule. On scenarios where reference to the schedule is needed, a value can be passed in create. string No - -
metadata TaskScheduleScheduleRefMetadata defines nested fields for TaskSchedule.ScheduleRef.Metadata. object No - -
modelType The type of the object. string No - -
modelVersion This is a version number that is used by the service to upgrade objects if needed through releases of the service. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. integer No - -
parentRef TaskScheduleScheduleRefParentRef defines nested fields for TaskSchedule.ScheduleRef.ParentRef. object No - -
timezone The timezone for the schedule. string No - -

Status.scheduleRef.frequencyDetails

Back to TaskSchedule status

TaskScheduleScheduleRefFrequencyDetails defines nested fields for TaskSchedule.ScheduleRef.FrequencyDetails.

Field Description Type Required Default Enum
customExpression This holds the complete cron expression for this schedule, for example, 10 0/5 * * * ? that fires every 5 minutes, at 10 seconds after the minute (i.e. 10:00:10 am, 10:05:10 am, etc.) string No - -
dayOfWeek This holds the day of the week on which the schedule should be triggered. string No - -
days A list of days of the month to be scheduled. i.e. excute every 2nd,3rd, 10th of the month. list[integer] No - -
frequency the frequency of the schedule. string No - -
interval This hold the repeatability aspect of a schedule. i.e. in a monhtly frequency, a task can be scheduled for every month, once in two months, once in tree months etc. integer No - -
jsonData - string No - -
modelType - string No - -
time TaskScheduleScheduleRefFrequencyDetailsTime defines nested fields for TaskSchedule.ScheduleRef.FrequencyDetails.Time. object No - -
weekOfMonth This holds the week of the month in which the schedule should be triggered. string No - -

Status.scheduleRef.frequencyDetails.time

Back to TaskSchedule status

TaskScheduleScheduleRefFrequencyDetailsTime defines nested fields for TaskSchedule.ScheduleRef.FrequencyDetails.Time.

Field Description Type Required Default Enum
hour The hour value. integer No - -
minute The minute value. integer No - -
second The second value. integer No - -

Status.scheduleRef.metadata

Back to TaskSchedule status

TaskScheduleScheduleRefMetadata defines nested fields for TaskSchedule.ScheduleRef.Metadata.

Field Description Type Required Default Enum
aggregator TaskScheduleScheduleRefMetadataAggregator defines nested fields for TaskSchedule.ScheduleRef.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics TaskScheduleScheduleRefMetadataCountStatistics defines nested fields for TaskSchedule.ScheduleRef.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.scheduleRef.metadata.aggregator

Back to TaskSchedule status

TaskScheduleScheduleRefMetadataAggregator defines nested fields for TaskSchedule.ScheduleRef.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.scheduleRef.metadata.countStatistics

Back to TaskSchedule status

TaskScheduleScheduleRefMetadataCountStatistics defines nested fields for TaskSchedule.ScheduleRef.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Status.scheduleRef.metadata.countStatistics.objectTypeCountList[]

Back to TaskSchedule status

TaskScheduleScheduleRefMetadataCountStatisticsObjectTypeCountList defines nested fields for TaskSchedule.ScheduleRef.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.scheduleRef.parentRef

Back to TaskSchedule status

TaskScheduleScheduleRefParentRef defines nested fields for TaskSchedule.ScheduleRef.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.status

Back to TaskSchedule 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

Back to TaskSchedule status

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

Back to TaskSchedule status

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[]

Back to TaskSchedule status

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

TaskValidation

TaskValidation is the Schema for the taskvalidations API.

  • Plural: taskvalidations
  • Scope: Namespaced
  • APIVersion: dataintegration.oracle.com/v1beta1
  • Sample: Sample (config/samples/dataintegration_v1beta1_taskvalidation.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

TaskValidationSpec defines the desired state of TaskValidation.

Field Description Type Required Default Enum
configProviderDelegate TaskValidationConfigProviderDelegate defines nested fields for TaskValidation.ConfigProviderDelegate. object No - -
dataFlow JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
description Detailed description for the object. string No - -
identifier Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
inputPorts An array of input ports. list[object] No - -
jsonData - string No - -
key Generated key that can be used in API calls to identify task. On scenarios where reference to the task is needed, a value can be passed in the create operation. string No - -
metadata TaskValidationMetadata defines nested fields for TaskValidation.Metadata. object No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
opConfigValues TaskValidationOpConfigValues defines nested fields for TaskValidation.OpConfigValues. object No - -
outputPorts An array of output ports. list[object] No - -
parameters An array of parameters. list[object] No - -
parentRef TaskValidationParentRef defines nested fields for TaskValidation.ParentRef. object No - -
pipeline JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Spec.configProviderDelegate

Back to TaskValidation spec

TaskValidationConfigProviderDelegate defines nested fields for TaskValidation.ConfigProviderDelegate.

Field Description Type Required Default Enum
bindings The configuration provider bindings. map[string, object] No - -

Spec.configProviderDelegate.bindings{}

Back to TaskValidation spec

TaskValidationConfigProviderDelegateBindings defines nested fields for TaskValidation.ConfigProviderDelegate.Bindings.

Field Description Type Required Default Enum
rootObjectValue This can be any object such as a file entity, a schema, or a table. Unknown nested fields are preserved. object (preserves unknown fields) No - -
simpleValue A simple value for the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Spec.inputPorts[]

Back to TaskValidation spec

TaskValidationInputPort defines nested fields for TaskValidation.InputPort.

Field Description Type Required Default Enum
configValues TaskValidationInputPortConfigValues defines nested fields for TaskValidation.InputPort.ConfigValues. object No - -
description Detailed description for the object. string No - -
fields An array of fields. list[object] No - -
key The key of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef TaskValidationInputPortParentRef defines nested fields for TaskValidation.InputPort.ParentRef. object No - -
portType The port details for the data asset.Type. string No - -

Spec.inputPorts[].configValues

Back to TaskValidation spec

TaskValidationInputPortConfigValues defines nested fields for TaskValidation.InputPort.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef TaskValidationInputPortConfigValuesParentRef defines nested fields for TaskValidation.InputPort.ConfigValues.ParentRef. object No - -

Spec.inputPorts[].configValues.configParamValues{}

Back to TaskValidation spec

TaskValidationInputPortConfigValuesConfigParamValues defines nested fields for TaskValidation.InputPort.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.inputPorts[].configValues.parentRef

Back to TaskValidation spec

TaskValidationInputPortConfigValuesParentRef defines nested fields for TaskValidation.InputPort.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.inputPorts[].fields[]

Back to TaskValidation spec

TaskValidationInputPortField defines nested fields for TaskValidation.InputPort.Field.

Field Description Type Required Default Enum
columnNamePattern column name pattern can be used to generate the name structure of the generated columns. By default column names are of %PIVOT_KEY_VALUE% or %MACRO_INPUT%%PIVOT_KEY_VALUE%, but we can change it something by passing something like MY_PREFIX%PIVOT_KEY_VALUE%MY_SUFFIX or MY_PREFIX%MACRO_INPUT%%PIVOT_KEY_VALUE%MY_SUFFIX which will add custom prefix and suffix to the column name. string No - -
configValues TaskValidationInputPortFieldConfigValues defines nested fields for TaskValidation.InputPort.Field.ConfigValues. object No - -
decisionOutputPortType The port based on what decision expression evaluates to. string No - -
defaultValue The default value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
description Detailed description for the object. string No - -
expr TaskValidationInputPortFieldExpr defines nested fields for TaskValidation.InputPort.Field.Expr. object No - -
expression The expression string for the object. string No - -
fields An array of fields. list[object (preserves unknown fields)] No - -
isInput Specifies whether the parameter is input value. boolean No - -
isOutput Specifies whether the parameter is output value. boolean No - -
isUseInferredType Specifies whether to use inferred expression output type as output type of the derived field. Default value of this flag is false. boolean No - -
isUseSourceType Specifies whether the type of macro fields is inferred from an expression or useType (false) or the source field (true). boolean No - -
jsonData - string No - -
key The key of the object. string No - -
labels Labels are keywords or labels that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
nativeShapeField TaskValidationInputPortFieldNativeShapeField defines nested fields for TaskValidation.InputPort.Field.NativeShapeField. object No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
outputAggregationType The output aggregation type. string No - -
parentRef TaskValidationInputPortFieldParentRef defines nested fields for TaskValidation.InputPort.Field.ParentRef. object No - -
portType The port details for the data asset.Type. string No - -
rootObjectDefaultValue The default value of the parameter which can be an object in DIS, such as a data entity. Unknown nested fields are preserved. object (preserves unknown fields) No - -
scope Reference key value to an object within the document. string No - -
scopeReference TaskValidationInputPortFieldScopeReference defines nested fields for TaskValidation.InputPort.Field.ScopeReference. object No - -
splitCondition TaskValidationInputPortFieldSplitCondition defines nested fields for TaskValidation.InputPort.Field.SplitCondition. object No - -
type TaskValidationInputPortFieldType defines nested fields for TaskValidation.InputPort.Field.Type. object No - -
typeName The type of value the parameter was created for. string No - -
useType TaskValidationInputPortFieldUseType defines nested fields for TaskValidation.InputPort.Field.UseType. object No - -
usedFor The param name for which parameter is created for for eg. driver Shape, Operation etc. string No - -

Spec.inputPorts[].fields[].configValues

Back to TaskValidation spec

TaskValidationInputPortFieldConfigValues defines nested fields for TaskValidation.InputPort.Field.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef TaskValidationInputPortFieldConfigValuesParentRef defines nested fields for TaskValidation.InputPort.Field.ConfigValues.ParentRef. object No - -

Spec.inputPorts[].fields[].configValues.configParamValues{}

Back to TaskValidation spec

TaskValidationInputPortFieldConfigValuesConfigParamValues defines nested fields for TaskValidation.InputPort.Field.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.inputPorts[].fields[].configValues.parentRef

Back to TaskValidation spec

TaskValidationInputPortFieldConfigValuesParentRef defines nested fields for TaskValidation.InputPort.Field.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.inputPorts[].fields[].expr

Back to TaskValidation spec

TaskValidationInputPortFieldExpr defines nested fields for TaskValidation.InputPort.Field.Expr.

Field Description Type Required Default Enum
configValues TaskValidationInputPortFieldExprConfigValues defines nested fields for TaskValidation.InputPort.Field.Expr.ConfigValues. object No - -
exprString The expression string for the object. string No - -
key The object key. string No - -
modelType The object type. string No - -
modelVersion The object's model version. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef TaskValidationInputPortFieldExprParentRef defines nested fields for TaskValidation.InputPort.Field.Expr.ParentRef. object No - -

Spec.inputPorts[].fields[].expr.configValues

Back to TaskValidation spec

TaskValidationInputPortFieldExprConfigValues defines nested fields for TaskValidation.InputPort.Field.Expr.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef TaskValidationInputPortFieldExprConfigValuesParentRef defines nested fields for TaskValidation.InputPort.Field.Expr.ConfigValues.ParentRef. object No - -

Spec.inputPorts[].fields[].expr.configValues.configParamValues{}

Back to TaskValidation spec

TaskValidationInputPortFieldExprConfigValuesConfigParamValues defines nested fields for TaskValidation.InputPort.Field.Expr.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.inputPorts[].fields[].expr.configValues.parentRef

Back to TaskValidation spec

TaskValidationInputPortFieldExprConfigValuesParentRef defines nested fields for TaskValidation.InputPort.Field.Expr.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.inputPorts[].fields[].expr.parentRef

Back to TaskValidation spec

TaskValidationInputPortFieldExprParentRef defines nested fields for TaskValidation.InputPort.Field.Expr.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.inputPorts[].fields[].nativeShapeField

Back to TaskValidation spec

TaskValidationInputPortFieldNativeShapeField defines nested fields for TaskValidation.InputPort.Field.NativeShapeField.

Field Description Type Required Default Enum
configValues TaskValidationInputPortFieldNativeShapeFieldConfigValues defines nested fields for TaskValidation.InputPort.Field.NativeShapeField.ConfigValues. object No - -
defaultValueString The default value. string No - -
isMandatory Specifies whether the field is mandatory. boolean No - -
modelType The model type reference. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
position The position of the attribute. integer No - -
type The type reference. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Spec.inputPorts[].fields[].nativeShapeField.configValues

Back to TaskValidation spec

TaskValidationInputPortFieldNativeShapeFieldConfigValues defines nested fields for TaskValidation.InputPort.Field.NativeShapeField.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef TaskValidationInputPortFieldNativeShapeFieldConfigValuesParentRef defines nested fields for TaskValidation.InputPort.Field.NativeShapeField.ConfigValues.ParentRef. object No - -

Spec.inputPorts[].fields[].nativeShapeField.configValues.configParamValues{}

Back to TaskValidation spec

TaskValidationInputPortFieldNativeShapeFieldConfigValuesConfigParamValues defines nested fields for TaskValidation.InputPort.Field.NativeShapeField.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.inputPorts[].fields[].nativeShapeField.configValues.parentRef

Back to TaskValidation spec

TaskValidationInputPortFieldNativeShapeFieldConfigValuesParentRef defines nested fields for TaskValidation.InputPort.Field.NativeShapeField.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.inputPorts[].fields[].parentRef

Back to TaskValidation spec

TaskValidationInputPortFieldParentRef defines nested fields for TaskValidation.InputPort.Field.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.inputPorts[].fields[].scopeReference

Back to TaskValidation spec

TaskValidationInputPortFieldScopeReference defines nested fields for TaskValidation.InputPort.Field.ScopeReference.

Field Description Type Required Default Enum
refObjectName The referenced object name for this reference. Set to the field name if the referenceType is BOUND_ENTITY_SHAPE_FIELD, else set to null. string No - -
referenceObject A key or shallow reference to an object. For direct reference, it points to the actual scope object. For BOUND_ENTITY_SHAPE or BOUND_ENTITY_SHAPE_FIELD, it points to the source or target operator. For OCI_FUNCTION_INPUT_SHAPE or OCI_FUNCTION_OUTPUT_SHAPE, it points to the OCI Function object. string Yes - -
referenceType The reference type for this reference. Set to null for a direct reference, for indirect references set to a type of association such as "BOUND_ENTITY_SHAPE". Current known reference type values are "BOUND_ENTITY_SHAPE", "BOUND_ENTITY_SHAPE_FIELD", "OCI_FUNCTION_INPUT_SHAPE", "OCI_FUNCTION_OUTPUT_SHAPE" string No - -

Spec.inputPorts[].fields[].splitCondition

Back to TaskValidation spec

TaskValidationInputPortFieldSplitCondition defines nested fields for TaskValidation.InputPort.Field.SplitCondition.

Field Description Type Required Default Enum
configValues TaskValidationInputPortFieldSplitConditionConfigValues defines nested fields for TaskValidation.InputPort.Field.SplitCondition.ConfigValues. object No - -
exprString The expression string for the object. string No - -
key The object key. string No - -
modelType The object type. string No - -
modelVersion The object's model version. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef TaskValidationInputPortFieldSplitConditionParentRef defines nested fields for TaskValidation.InputPort.Field.SplitCondition.ParentRef. object No - -

Spec.inputPorts[].fields[].splitCondition.configValues

Back to TaskValidation spec

TaskValidationInputPortFieldSplitConditionConfigValues defines nested fields for TaskValidation.InputPort.Field.SplitCondition.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef TaskValidationInputPortFieldSplitConditionConfigValuesParentRef defines nested fields for TaskValidation.InputPort.Field.SplitCondition.ConfigValues.ParentRef. object No - -

Spec.inputPorts[].fields[].splitCondition.configValues.configParamValues{}

Back to TaskValidation spec

TaskValidationInputPortFieldSplitConditionConfigValuesConfigParamValues defines nested fields for TaskValidation.InputPort.Field.SplitCondition.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.inputPorts[].fields[].splitCondition.configValues.parentRef

Back to TaskValidation spec

TaskValidationInputPortFieldSplitConditionConfigValuesParentRef defines nested fields for TaskValidation.InputPort.Field.SplitCondition.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.inputPorts[].fields[].splitCondition.parentRef

Back to TaskValidation spec

TaskValidationInputPortFieldSplitConditionParentRef defines nested fields for TaskValidation.InputPort.Field.SplitCondition.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.inputPorts[].fields[].type

Back to TaskValidation spec

TaskValidationInputPortFieldType defines nested fields for TaskValidation.InputPort.Field.Type.

Field Description Type Required Default Enum
configDefinition TaskValidationInputPortFieldTypeConfigDefinition defines nested fields for TaskValidation.InputPort.Field.Type.ConfigDefinition. object No - -
configValues TaskValidationInputPortFieldTypeConfigValues defines nested fields for TaskValidation.InputPort.Field.Type.ConfigValues. object No - -
containsNull Defines whether null values are allowed. boolean No - -
description A user defined description for the object. string No - -
dtType The data type. string No - -
elementType Seeded type string No - -
elements An array of elements. list[string] No - -
javaTypeName The java type name. string No - -
jsonData - string No - -
key The key of the object. string No - -
keyElementType Seeded type string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef TaskValidationInputPortFieldTypeParentRef defines nested fields for TaskValidation.InputPort.Field.Type.ParentRef. object No - -
pathNames An array of path names corresponding to the elements. The path names are used when referring to the field in an expression. list[string] No - -
typeHandler TaskValidationInputPortFieldTypeTypeHandler defines nested fields for TaskValidation.InputPort.Field.Type.TypeHandler. object No - -
typeSystemName The data type system name. string No - -
valueElementType Seeded type string No - -
wrappedType A wrapped type, may be a string or a BaseType. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Spec.inputPorts[].fields[].type.configDefinition

Back to TaskValidation spec

TaskValidationInputPortFieldTypeConfigDefinition defines nested fields for TaskValidation.InputPort.Field.Type.ConfigDefinition.

Field Description Type Required Default Enum
configParameterDefinitions The parameter configuration details. map[string, object] No - -
isContained Specifies whether the configuration is contained or not. boolean No - -
key The key of the object. string No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef TaskValidationInputPortFieldTypeConfigDefinitionParentRef defines nested fields for TaskValidation.InputPort.Field.Type.ConfigDefinition.ParentRef. object No - -

Spec.inputPorts[].fields[].type.configDefinition.configParameterDefinitions{}

Back to TaskValidation spec

TaskValidationInputPortFieldTypeConfigDefinitionConfigParameterDefinitions defines nested fields for TaskValidation.InputPort.Field.Type.ConfigDefinition.ConfigParameterDefinitions.

Field Description Type Required Default Enum
classFieldName The parameter class field name. string No - -
defaultValue The default value for the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
description A user defined description for the object. string No - -
isClassFieldValue Specifies whether the parameter is a class field or not. boolean No - -
isStatic Specifies whether the parameter is static or not. boolean No - -
parameterName This object represents the configurable properties for an object type. string No - -
parameterType JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Spec.inputPorts[].fields[].type.configDefinition.parentRef

Back to TaskValidation spec

TaskValidationInputPortFieldTypeConfigDefinitionParentRef defines nested fields for TaskValidation.InputPort.Field.Type.ConfigDefinition.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.inputPorts[].fields[].type.configValues

Back to TaskValidation spec

TaskValidationInputPortFieldTypeConfigValues defines nested fields for TaskValidation.InputPort.Field.Type.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef TaskValidationInputPortFieldTypeConfigValuesParentRef defines nested fields for TaskValidation.InputPort.Field.Type.ConfigValues.ParentRef. object No - -

Spec.inputPorts[].fields[].type.configValues.configParamValues{}

Back to TaskValidation spec

TaskValidationInputPortFieldTypeConfigValuesConfigParamValues defines nested fields for TaskValidation.InputPort.Field.Type.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.inputPorts[].fields[].type.configValues.parentRef

Back to TaskValidation spec

TaskValidationInputPortFieldTypeConfigValuesParentRef defines nested fields for TaskValidation.InputPort.Field.Type.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.inputPorts[].fields[].type.parentRef

Back to TaskValidation spec

TaskValidationInputPortFieldTypeParentRef defines nested fields for TaskValidation.InputPort.Field.Type.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.inputPorts[].fields[].type.typeHandler

Back to TaskValidation spec

TaskValidationInputPortFieldTypeTypeHandler defines nested fields for TaskValidation.InputPort.Field.Type.TypeHandler.

Field Description Type Required Default Enum
configValues TaskValidationInputPortFieldTypeTypeHandlerConfigValues defines nested fields for TaskValidation.InputPort.Field.Type.TypeHandler.ConfigValues. object No - -
flattenDetails Contains a key for referencing the flattenDetails information. string No - -
isOrderByRule Specifies whether it is ordered by rule. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef TaskValidationInputPortFieldTypeTypeHandlerParentRef defines nested fields for TaskValidation.InputPort.Field.Type.TypeHandler.ParentRef. object No - -
projectionRules The projection rules. list[object] No - -
scope Reference key for the typed object. string No - -
scopeReference TaskValidationInputPortFieldTypeTypeHandlerScopeReference defines nested fields for TaskValidation.InputPort.Field.Type.TypeHandler.ScopeReference. object No - -

Spec.inputPorts[].fields[].type.typeHandler.configValues

Back to TaskValidation spec

TaskValidationInputPortFieldTypeTypeHandlerConfigValues defines nested fields for TaskValidation.InputPort.Field.Type.TypeHandler.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef TaskValidationInputPortFieldTypeTypeHandlerConfigValuesParentRef defines nested fields for TaskValidation.InputPort.Field.Type.TypeHandler.ConfigValues.ParentRef. object No - -

Spec.inputPorts[].fields[].type.typeHandler.configValues.configParamValues{}

Back to TaskValidation spec

TaskValidationInputPortFieldTypeTypeHandlerConfigValuesConfigParamValues defines nested fields for TaskValidation.InputPort.Field.Type.TypeHandler.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.inputPorts[].fields[].type.typeHandler.configValues.parentRef

Back to TaskValidation spec

TaskValidationInputPortFieldTypeTypeHandlerConfigValuesParentRef defines nested fields for TaskValidation.InputPort.Field.Type.TypeHandler.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.inputPorts[].fields[].type.typeHandler.parentRef

Back to TaskValidation spec

TaskValidationInputPortFieldTypeTypeHandlerParentRef defines nested fields for TaskValidation.InputPort.Field.Type.TypeHandler.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.inputPorts[].fields[].type.typeHandler.projectionRules[]

Back to TaskValidation spec

TaskValidationInputPortFieldTypeTypeHandlerProjectionRule defines nested fields for TaskValidation.InputPort.Field.Type.TypeHandler.ProjectionRule.

Field Description Type Required Default Enum
configValues TaskValidationInputPortFieldTypeTypeHandlerProjectionRuleConfigValues defines nested fields for TaskValidation.InputPort.Field.Type.TypeHandler.ProjectionRule.ConfigValues. object No - -
description A user defined description for the object. string No - -
fromName The attribute name that needs to be renamed. string No - -
isCascade Specifies whether to cascade or not. boolean No - -
isCaseSensitive Specifies if the rule is case sensitive. boolean No - -
isJavaRegexSyntax Specifies whether the rule uses a java regex syntax. boolean No - -
isSkipRemainingRulesOnMatch Specifies whether to skip remaining rules when a match is found. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
matchingStrategy The pattern matching strategy. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Name of the group. string No - -
names Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. list[string] No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef TaskValidationInputPortFieldTypeTypeHandlerProjectionRuleParentRef defines nested fields for TaskValidation.InputPort.Field.Type.TypeHandler.ProjectionRule.ParentRef. object No - -
pattern The rule pattern. string No - -
ruleType The rule type. string No - -
scope Reference to a typed object. This can be either a key value to an object within the document, a shall referenced to a TypedObject, or a full TypedObject definition. Unknown nested fields are preserved. object (preserves unknown fields) No - -
toName The new attribute name. string No - -
types An arry of types. list[object (preserves unknown fields)] No - -

Spec.inputPorts[].fields[].type.typeHandler.projectionRules[].configValues

Back to TaskValidation spec

TaskValidationInputPortFieldTypeTypeHandlerProjectionRuleConfigValues defines nested fields for TaskValidation.InputPort.Field.Type.TypeHandler.ProjectionRule.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef TaskValidationInputPortFieldTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for TaskValidation.InputPort.Field.Type.TypeHandler.ProjectionRule.ConfigValues.ParentRef. object No - -

Spec.inputPorts[].fields[].type.typeHandler.projectionRules[].configValues.configParamValues{}

Back to TaskValidation spec

TaskValidationInputPortFieldTypeTypeHandlerProjectionRuleConfigValuesConfigParamValues defines nested fields for TaskValidation.InputPort.Field.Type.TypeHandler.ProjectionRule.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.inputPorts[].fields[].type.typeHandler.projectionRules[].configValues.parentRef

Back to TaskValidation spec

TaskValidationInputPortFieldTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for TaskValidation.InputPort.Field.Type.TypeHandler.ProjectionRule.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.inputPorts[].fields[].type.typeHandler.projectionRules[].parentRef

Back to TaskValidation spec

TaskValidationInputPortFieldTypeTypeHandlerProjectionRuleParentRef defines nested fields for TaskValidation.InputPort.Field.Type.TypeHandler.ProjectionRule.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.inputPorts[].fields[].type.typeHandler.scopeReference

Back to TaskValidation spec

TaskValidationInputPortFieldTypeTypeHandlerScopeReference defines nested fields for TaskValidation.InputPort.Field.Type.TypeHandler.ScopeReference.

Field Description Type Required Default Enum
refObjectName The referenced object name for this reference. Set to the field name if the referenceType is BOUND_ENTITY_SHAPE_FIELD, else set to null. string No - -
referenceObject A key or shallow reference to an object. For direct reference, it points to the actual scope object. For BOUND_ENTITY_SHAPE or BOUND_ENTITY_SHAPE_FIELD, it points to the source or target operator. For OCI_FUNCTION_INPUT_SHAPE or OCI_FUNCTION_OUTPUT_SHAPE, it points to the OCI Function object. string Yes - -
referenceType The reference type for this reference. Set to null for a direct reference, for indirect references set to a type of association such as "BOUND_ENTITY_SHAPE". Current known reference type values are "BOUND_ENTITY_SHAPE", "BOUND_ENTITY_SHAPE_FIELD", "OCI_FUNCTION_INPUT_SHAPE", "OCI_FUNCTION_OUTPUT_SHAPE" string No - -

Spec.inputPorts[].fields[].useType

Back to TaskValidation spec

TaskValidationInputPortFieldUseType defines nested fields for TaskValidation.InputPort.Field.UseType.

Field Description Type Required Default Enum
configDefinition TaskValidationInputPortFieldUseTypeConfigDefinition defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigDefinition. object No - -
configValues TaskValidationInputPortFieldUseTypeConfigValues defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigValues. object No - -
description A user defined description for the object. string No - -
key The key of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef TaskValidationInputPortFieldUseTypeParentRef defines nested fields for TaskValidation.InputPort.Field.UseType.ParentRef. object No - -
wrappedType A wrapped type, may be a string or a BaseType. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Spec.inputPorts[].fields[].useType.configDefinition

Back to TaskValidation spec

TaskValidationInputPortFieldUseTypeConfigDefinition defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigDefinition.

Field Description Type Required Default Enum
configParameterDefinitions The parameter configuration details. map[string, object] No - -
isContained Specifies whether the configuration is contained or not. boolean No - -
key The key of the object. string No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef TaskValidationInputPortFieldUseTypeConfigDefinitionParentRef defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigDefinition.ParentRef. object No - -

Spec.inputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}

Back to TaskValidation spec

TaskValidationInputPortFieldUseTypeConfigDefinitionConfigParameterDefinitions defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.

Field Description Type Required Default Enum
classFieldName The parameter class field name. string No - -
defaultValue The default value for the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
description A user defined description for the object. string No - -
isClassFieldValue Specifies whether the parameter is a class field or not. boolean No - -
isStatic Specifies whether the parameter is static or not. boolean No - -
parameterName This object represents the configurable properties for an object type. string No - -
parameterType TaskValidationInputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterType defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType. object No - -

Spec.inputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}.parameterType

Back to TaskValidation spec

TaskValidationInputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterType defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.

Field Description Type Required Default Enum
configDefinition JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
configValues TaskValidationInputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValues defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues. object No - -
containsNull Defines whether null values are allowed. boolean No - -
description A user defined description for the object. string No - -
dtType The data type. string No - -
elementType Seeded type string No - -
elements An array of elements. list[string] No - -
javaTypeName The java type name. string No - -
jsonData - string No - -
key The key of the object. string No - -
keyElementType Seeded type string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef TaskValidationInputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeParentRef defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ParentRef. object No - -
pathNames An array of path names corresponding to the elements. The path names are used when referring to the field in an expression. list[string] No - -
typeHandler TaskValidationInputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandler defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler. object No - -
typeSystemName The data type system name. string No - -
valueElementType Seeded type string No - -
wrappedType A wrapped type, may be a string or a BaseType. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Spec.inputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}.parameterType.configValues

Back to TaskValidation spec

TaskValidationInputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValues defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef TaskValidationInputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesParentRef defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ParentRef. object No - -

Spec.inputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}.parameterType.configValues.configParamValues{}

Back to TaskValidation spec

TaskValidationInputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesConfigParamValues defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.inputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}.parameterType.configValues.parentRef

Back to TaskValidation spec

TaskValidationInputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesParentRef defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.inputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}.parameterType.parentRef

Back to TaskValidation spec

TaskValidationInputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeParentRef defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.inputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler

Back to TaskValidation spec

TaskValidationInputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandler defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.

Field Description Type Required Default Enum
configValues TaskValidationInputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValues defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues. object No - -
flattenDetails Contains a key for referencing the flattenDetails information. string No - -
isOrderByRule Specifies whether it is ordered by rule. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef TaskValidationInputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerParentRef defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ParentRef. object No - -
projectionRules The projection rules. list[object] No - -
scope Reference key for the typed object. string No - -
scopeReference TaskValidationInputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerScopeReference defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ScopeReference. object No - -

Spec.inputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues

Back to TaskValidation spec

TaskValidationInputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValues defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef TaskValidationInputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesParentRef defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ParentRef. object No - -

Spec.inputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues.configParamValues{}

Back to TaskValidation spec

TaskValidationInputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesConfigParamValues defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.inputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues.parentRef

Back to TaskValidation spec

TaskValidationInputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesParentRef defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.inputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.parentRef

Back to TaskValidation spec

TaskValidationInputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerParentRef defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.inputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[]

Back to TaskValidation spec

TaskValidationInputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRule defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.

Field Description Type Required Default Enum
configValues TaskValidationInputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValues defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues. object No - -
description A user defined description for the object. string No - -
fromName The attribute name that needs to be renamed. string No - -
isCascade Specifies whether to cascade or not. boolean No - -
isCaseSensitive Specifies if the rule is case sensitive. boolean No - -
isJavaRegexSyntax Specifies whether the rule uses a java regex syntax. boolean No - -
isSkipRemainingRulesOnMatch Specifies whether to skip remaining rules when a match is found. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
matchingStrategy The pattern matching strategy. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Name of the group. string No - -
names Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. list[string] No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef TaskValidationInputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleParentRef defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ParentRef. object No - -
pattern The rule pattern. string No - -
ruleType The rule type. string No - -
scope Reference to a typed object. This can be either a key value to an object within the document, a shall referenced to a TypedObject, or a full TypedObject definition. Unknown nested fields are preserved. object (preserves unknown fields) No - -
toName The new attribute name. string No - -
types An arry of types. list[object (preserves unknown fields)] No - -

Spec.inputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues

Back to TaskValidation spec

TaskValidationInputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValues defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef TaskValidationInputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ParentRef. object No - -

Spec.inputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues.configParamValues{}

Back to TaskValidation spec

TaskValidationInputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesConfigParamValues defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.inputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues.parentRef

Back to TaskValidation spec

TaskValidationInputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.inputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].parentRef

Back to TaskValidation spec

TaskValidationInputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleParentRef defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.inputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.scopeReference

Back to TaskValidation spec

TaskValidationInputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerScopeReference defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ScopeReference.

Field Description Type Required Default Enum
refObjectName The referenced object name for this reference. Set to the field name if the referenceType is BOUND_ENTITY_SHAPE_FIELD, else set to null. string No - -
referenceObject A key or shallow reference to an object. For direct reference, it points to the actual scope object. For BOUND_ENTITY_SHAPE or BOUND_ENTITY_SHAPE_FIELD, it points to the source or target operator. For OCI_FUNCTION_INPUT_SHAPE or OCI_FUNCTION_OUTPUT_SHAPE, it points to the OCI Function object. string Yes - -
referenceType The reference type for this reference. Set to null for a direct reference, for indirect references set to a type of association such as "BOUND_ENTITY_SHAPE". Current known reference type values are "BOUND_ENTITY_SHAPE", "BOUND_ENTITY_SHAPE_FIELD", "OCI_FUNCTION_INPUT_SHAPE", "OCI_FUNCTION_OUTPUT_SHAPE" string No - -

Spec.inputPorts[].fields[].useType.configDefinition.parentRef

Back to TaskValidation spec

TaskValidationInputPortFieldUseTypeConfigDefinitionParentRef defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigDefinition.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.inputPorts[].fields[].useType.configValues

Back to TaskValidation spec

TaskValidationInputPortFieldUseTypeConfigValues defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef TaskValidationInputPortFieldUseTypeConfigValuesParentRef defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigValues.ParentRef. object No - -

Spec.inputPorts[].fields[].useType.configValues.configParamValues{}

Back to TaskValidation spec

TaskValidationInputPortFieldUseTypeConfigValuesConfigParamValues defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.inputPorts[].fields[].useType.configValues.parentRef

Back to TaskValidation spec

TaskValidationInputPortFieldUseTypeConfigValuesParentRef defines nested fields for TaskValidation.InputPort.Field.UseType.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.inputPorts[].fields[].useType.parentRef

Back to TaskValidation spec

TaskValidationInputPortFieldUseTypeParentRef defines nested fields for TaskValidation.InputPort.Field.UseType.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.inputPorts[].parentRef

Back to TaskValidation spec

TaskValidationInputPortParentRef defines nested fields for TaskValidation.InputPort.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.metadata

Back to TaskValidation spec

TaskValidationMetadata defines nested fields for TaskValidation.Metadata.

Field Description Type Required Default Enum
aggregator TaskValidationMetadataAggregator defines nested fields for TaskValidation.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics TaskValidationMetadataCountStatistics defines nested fields for TaskValidation.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Spec.metadata.aggregator

Back to TaskValidation spec

TaskValidationMetadataAggregator defines nested fields for TaskValidation.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Spec.metadata.countStatistics

Back to TaskValidation spec

TaskValidationMetadataCountStatistics defines nested fields for TaskValidation.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Spec.metadata.countStatistics.objectTypeCountList[]

Back to TaskValidation spec

TaskValidationMetadataCountStatisticsObjectTypeCountList defines nested fields for TaskValidation.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Spec.opConfigValues

Back to TaskValidation spec

TaskValidationOpConfigValues defines nested fields for TaskValidation.OpConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef TaskValidationOpConfigValuesParentRef defines nested fields for TaskValidation.OpConfigValues.ParentRef. object No - -

Spec.opConfigValues.configParamValues{}

Back to TaskValidation spec

TaskValidationOpConfigValuesConfigParamValues defines nested fields for TaskValidation.OpConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.opConfigValues.parentRef

Back to TaskValidation spec

TaskValidationOpConfigValuesParentRef defines nested fields for TaskValidation.OpConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.outputPorts[]

Back to TaskValidation spec

TaskValidationOutputPort defines nested fields for TaskValidation.OutputPort.

Field Description Type Required Default Enum
configValues TaskValidationOutputPortConfigValues defines nested fields for TaskValidation.OutputPort.ConfigValues. object No - -
description Detailed description for the object. string No - -
fields An array of fields. list[object] No - -
key The key of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef TaskValidationOutputPortParentRef defines nested fields for TaskValidation.OutputPort.ParentRef. object No - -
portType The port details for the data asset.Type. string No - -

Spec.outputPorts[].configValues

Back to TaskValidation spec

TaskValidationOutputPortConfigValues defines nested fields for TaskValidation.OutputPort.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef TaskValidationOutputPortConfigValuesParentRef defines nested fields for TaskValidation.OutputPort.ConfigValues.ParentRef. object No - -

Spec.outputPorts[].configValues.configParamValues{}

Back to TaskValidation spec

TaskValidationOutputPortConfigValuesConfigParamValues defines nested fields for TaskValidation.OutputPort.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.outputPorts[].configValues.parentRef

Back to TaskValidation spec

TaskValidationOutputPortConfigValuesParentRef defines nested fields for TaskValidation.OutputPort.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.outputPorts[].fields[]

Back to TaskValidation spec

TaskValidationOutputPortField defines nested fields for TaskValidation.OutputPort.Field.

Field Description Type Required Default Enum
columnNamePattern column name pattern can be used to generate the name structure of the generated columns. By default column names are of %PIVOT_KEY_VALUE% or %MACRO_INPUT%%PIVOT_KEY_VALUE%, but we can change it something by passing something like MY_PREFIX%PIVOT_KEY_VALUE%MY_SUFFIX or MY_PREFIX%MACRO_INPUT%%PIVOT_KEY_VALUE%MY_SUFFIX which will add custom prefix and suffix to the column name. string No - -
configValues TaskValidationOutputPortFieldConfigValues defines nested fields for TaskValidation.OutputPort.Field.ConfigValues. object No - -
decisionOutputPortType The port based on what decision expression evaluates to. string No - -
defaultValue The default value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
description Detailed description for the object. string No - -
expr TaskValidationOutputPortFieldExpr defines nested fields for TaskValidation.OutputPort.Field.Expr. object No - -
expression The expression string for the object. string No - -
fields An array of fields. list[object (preserves unknown fields)] No - -
isInput Specifies whether the parameter is input value. boolean No - -
isOutput Specifies whether the parameter is output value. boolean No - -
isUseInferredType Specifies whether to use inferred expression output type as output type of the derived field. Default value of this flag is false. boolean No - -
isUseSourceType Specifies whether the type of macro fields is inferred from an expression or useType (false) or the source field (true). boolean No - -
jsonData - string No - -
key The key of the object. string No - -
labels Labels are keywords or labels that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
nativeShapeField TaskValidationOutputPortFieldNativeShapeField defines nested fields for TaskValidation.OutputPort.Field.NativeShapeField. object No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
outputAggregationType The output aggregation type. string No - -
parentRef TaskValidationOutputPortFieldParentRef defines nested fields for TaskValidation.OutputPort.Field.ParentRef. object No - -
portType The port details for the data asset.Type. string No - -
rootObjectDefaultValue The default value of the parameter which can be an object in DIS, such as a data entity. Unknown nested fields are preserved. object (preserves unknown fields) No - -
scope Reference key value to an object within the document. string No - -
scopeReference TaskValidationOutputPortFieldScopeReference defines nested fields for TaskValidation.OutputPort.Field.ScopeReference. object No - -
splitCondition TaskValidationOutputPortFieldSplitCondition defines nested fields for TaskValidation.OutputPort.Field.SplitCondition. object No - -
type TaskValidationOutputPortFieldType defines nested fields for TaskValidation.OutputPort.Field.Type. object No - -
typeName The type of value the parameter was created for. string No - -
useType TaskValidationOutputPortFieldUseType defines nested fields for TaskValidation.OutputPort.Field.UseType. object No - -
usedFor The param name for which parameter is created for for eg. driver Shape, Operation etc. string No - -

Spec.outputPorts[].fields[].configValues

Back to TaskValidation spec

TaskValidationOutputPortFieldConfigValues defines nested fields for TaskValidation.OutputPort.Field.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef TaskValidationOutputPortFieldConfigValuesParentRef defines nested fields for TaskValidation.OutputPort.Field.ConfigValues.ParentRef. object No - -

Spec.outputPorts[].fields[].configValues.configParamValues{}

Back to TaskValidation spec

TaskValidationOutputPortFieldConfigValuesConfigParamValues defines nested fields for TaskValidation.OutputPort.Field.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.outputPorts[].fields[].configValues.parentRef

Back to TaskValidation spec

TaskValidationOutputPortFieldConfigValuesParentRef defines nested fields for TaskValidation.OutputPort.Field.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.outputPorts[].fields[].expr

Back to TaskValidation spec

TaskValidationOutputPortFieldExpr defines nested fields for TaskValidation.OutputPort.Field.Expr.

Field Description Type Required Default Enum
configValues TaskValidationOutputPortFieldExprConfigValues defines nested fields for TaskValidation.OutputPort.Field.Expr.ConfigValues. object No - -
exprString The expression string for the object. string No - -
key The object key. string No - -
modelType The object type. string No - -
modelVersion The object's model version. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef TaskValidationOutputPortFieldExprParentRef defines nested fields for TaskValidation.OutputPort.Field.Expr.ParentRef. object No - -

Spec.outputPorts[].fields[].expr.configValues

Back to TaskValidation spec

TaskValidationOutputPortFieldExprConfigValues defines nested fields for TaskValidation.OutputPort.Field.Expr.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef TaskValidationOutputPortFieldExprConfigValuesParentRef defines nested fields for TaskValidation.OutputPort.Field.Expr.ConfigValues.ParentRef. object No - -

Spec.outputPorts[].fields[].expr.configValues.configParamValues{}

Back to TaskValidation spec

TaskValidationOutputPortFieldExprConfigValuesConfigParamValues defines nested fields for TaskValidation.OutputPort.Field.Expr.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.outputPorts[].fields[].expr.configValues.parentRef

Back to TaskValidation spec

TaskValidationOutputPortFieldExprConfigValuesParentRef defines nested fields for TaskValidation.OutputPort.Field.Expr.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.outputPorts[].fields[].expr.parentRef

Back to TaskValidation spec

TaskValidationOutputPortFieldExprParentRef defines nested fields for TaskValidation.OutputPort.Field.Expr.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.outputPorts[].fields[].nativeShapeField

Back to TaskValidation spec

TaskValidationOutputPortFieldNativeShapeField defines nested fields for TaskValidation.OutputPort.Field.NativeShapeField.

Field Description Type Required Default Enum
configValues TaskValidationOutputPortFieldNativeShapeFieldConfigValues defines nested fields for TaskValidation.OutputPort.Field.NativeShapeField.ConfigValues. object No - -
defaultValueString The default value. string No - -
isMandatory Specifies whether the field is mandatory. boolean No - -
modelType The model type reference. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
position The position of the attribute. integer No - -
type The type reference. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Spec.outputPorts[].fields[].nativeShapeField.configValues

Back to TaskValidation spec

TaskValidationOutputPortFieldNativeShapeFieldConfigValues defines nested fields for TaskValidation.OutputPort.Field.NativeShapeField.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef TaskValidationOutputPortFieldNativeShapeFieldConfigValuesParentRef defines nested fields for TaskValidation.OutputPort.Field.NativeShapeField.ConfigValues.ParentRef. object No - -

Spec.outputPorts[].fields[].nativeShapeField.configValues.configParamValues{}

Back to TaskValidation spec

TaskValidationOutputPortFieldNativeShapeFieldConfigValuesConfigParamValues defines nested fields for TaskValidation.OutputPort.Field.NativeShapeField.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.outputPorts[].fields[].nativeShapeField.configValues.parentRef

Back to TaskValidation spec

TaskValidationOutputPortFieldNativeShapeFieldConfigValuesParentRef defines nested fields for TaskValidation.OutputPort.Field.NativeShapeField.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.outputPorts[].fields[].parentRef

Back to TaskValidation spec

TaskValidationOutputPortFieldParentRef defines nested fields for TaskValidation.OutputPort.Field.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.outputPorts[].fields[].scopeReference

Back to TaskValidation spec

TaskValidationOutputPortFieldScopeReference defines nested fields for TaskValidation.OutputPort.Field.ScopeReference.

Field Description Type Required Default Enum
refObjectName The referenced object name for this reference. Set to the field name if the referenceType is BOUND_ENTITY_SHAPE_FIELD, else set to null. string No - -
referenceObject A key or shallow reference to an object. For direct reference, it points to the actual scope object. For BOUND_ENTITY_SHAPE or BOUND_ENTITY_SHAPE_FIELD, it points to the source or target operator. For OCI_FUNCTION_INPUT_SHAPE or OCI_FUNCTION_OUTPUT_SHAPE, it points to the OCI Function object. string Yes - -
referenceType The reference type for this reference. Set to null for a direct reference, for indirect references set to a type of association such as "BOUND_ENTITY_SHAPE". Current known reference type values are "BOUND_ENTITY_SHAPE", "BOUND_ENTITY_SHAPE_FIELD", "OCI_FUNCTION_INPUT_SHAPE", "OCI_FUNCTION_OUTPUT_SHAPE" string No - -

Spec.outputPorts[].fields[].splitCondition

Back to TaskValidation spec

TaskValidationOutputPortFieldSplitCondition defines nested fields for TaskValidation.OutputPort.Field.SplitCondition.

Field Description Type Required Default Enum
configValues TaskValidationOutputPortFieldSplitConditionConfigValues defines nested fields for TaskValidation.OutputPort.Field.SplitCondition.ConfigValues. object No - -
exprString The expression string for the object. string No - -
key The object key. string No - -
modelType The object type. string No - -
modelVersion The object's model version. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef TaskValidationOutputPortFieldSplitConditionParentRef defines nested fields for TaskValidation.OutputPort.Field.SplitCondition.ParentRef. object No - -

Spec.outputPorts[].fields[].splitCondition.configValues

Back to TaskValidation spec

TaskValidationOutputPortFieldSplitConditionConfigValues defines nested fields for TaskValidation.OutputPort.Field.SplitCondition.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef TaskValidationOutputPortFieldSplitConditionConfigValuesParentRef defines nested fields for TaskValidation.OutputPort.Field.SplitCondition.ConfigValues.ParentRef. object No - -

Spec.outputPorts[].fields[].splitCondition.configValues.configParamValues{}

Back to TaskValidation spec

TaskValidationOutputPortFieldSplitConditionConfigValuesConfigParamValues defines nested fields for TaskValidation.OutputPort.Field.SplitCondition.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.outputPorts[].fields[].splitCondition.configValues.parentRef

Back to TaskValidation spec

TaskValidationOutputPortFieldSplitConditionConfigValuesParentRef defines nested fields for TaskValidation.OutputPort.Field.SplitCondition.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.outputPorts[].fields[].splitCondition.parentRef

Back to TaskValidation spec

TaskValidationOutputPortFieldSplitConditionParentRef defines nested fields for TaskValidation.OutputPort.Field.SplitCondition.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.outputPorts[].fields[].type

Back to TaskValidation spec

TaskValidationOutputPortFieldType defines nested fields for TaskValidation.OutputPort.Field.Type.

Field Description Type Required Default Enum
configDefinition TaskValidationOutputPortFieldTypeConfigDefinition defines nested fields for TaskValidation.OutputPort.Field.Type.ConfigDefinition. object No - -
configValues TaskValidationOutputPortFieldTypeConfigValues defines nested fields for TaskValidation.OutputPort.Field.Type.ConfigValues. object No - -
containsNull Defines whether null values are allowed. boolean No - -
description A user defined description for the object. string No - -
dtType The data type. string No - -
elementType Seeded type string No - -
elements An array of elements. list[string] No - -
javaTypeName The java type name. string No - -
jsonData - string No - -
key The key of the object. string No - -
keyElementType Seeded type string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef TaskValidationOutputPortFieldTypeParentRef defines nested fields for TaskValidation.OutputPort.Field.Type.ParentRef. object No - -
pathNames An array of path names corresponding to the elements. The path names are used when referring to the field in an expression. list[string] No - -
typeHandler TaskValidationOutputPortFieldTypeTypeHandler defines nested fields for TaskValidation.OutputPort.Field.Type.TypeHandler. object No - -
typeSystemName The data type system name. string No - -
valueElementType Seeded type string No - -
wrappedType A wrapped type, may be a string or a BaseType. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Spec.outputPorts[].fields[].type.configDefinition

Back to TaskValidation spec

TaskValidationOutputPortFieldTypeConfigDefinition defines nested fields for TaskValidation.OutputPort.Field.Type.ConfigDefinition.

Field Description Type Required Default Enum
configParameterDefinitions The parameter configuration details. map[string, object] No - -
isContained Specifies whether the configuration is contained or not. boolean No - -
key The key of the object. string No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef TaskValidationOutputPortFieldTypeConfigDefinitionParentRef defines nested fields for TaskValidation.OutputPort.Field.Type.ConfigDefinition.ParentRef. object No - -

Spec.outputPorts[].fields[].type.configDefinition.configParameterDefinitions{}

Back to TaskValidation spec

TaskValidationOutputPortFieldTypeConfigDefinitionConfigParameterDefinitions defines nested fields for TaskValidation.OutputPort.Field.Type.ConfigDefinition.ConfigParameterDefinitions.

Field Description Type Required Default Enum
classFieldName The parameter class field name. string No - -
defaultValue The default value for the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
description A user defined description for the object. string No - -
isClassFieldValue Specifies whether the parameter is a class field or not. boolean No - -
isStatic Specifies whether the parameter is static or not. boolean No - -
parameterName This object represents the configurable properties for an object type. string No - -
parameterType JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Spec.outputPorts[].fields[].type.configDefinition.parentRef

Back to TaskValidation spec

TaskValidationOutputPortFieldTypeConfigDefinitionParentRef defines nested fields for TaskValidation.OutputPort.Field.Type.ConfigDefinition.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.outputPorts[].fields[].type.configValues

Back to TaskValidation spec

TaskValidationOutputPortFieldTypeConfigValues defines nested fields for TaskValidation.OutputPort.Field.Type.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef TaskValidationOutputPortFieldTypeConfigValuesParentRef defines nested fields for TaskValidation.OutputPort.Field.Type.ConfigValues.ParentRef. object No - -

Spec.outputPorts[].fields[].type.configValues.configParamValues{}

Back to TaskValidation spec

TaskValidationOutputPortFieldTypeConfigValuesConfigParamValues defines nested fields for TaskValidation.OutputPort.Field.Type.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.outputPorts[].fields[].type.configValues.parentRef

Back to TaskValidation spec

TaskValidationOutputPortFieldTypeConfigValuesParentRef defines nested fields for TaskValidation.OutputPort.Field.Type.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.outputPorts[].fields[].type.parentRef

Back to TaskValidation spec

TaskValidationOutputPortFieldTypeParentRef defines nested fields for TaskValidation.OutputPort.Field.Type.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.outputPorts[].fields[].type.typeHandler

Back to TaskValidation spec

TaskValidationOutputPortFieldTypeTypeHandler defines nested fields for TaskValidation.OutputPort.Field.Type.TypeHandler.

Field Description Type Required Default Enum
configValues TaskValidationOutputPortFieldTypeTypeHandlerConfigValues defines nested fields for TaskValidation.OutputPort.Field.Type.TypeHandler.ConfigValues. object No - -
flattenDetails Contains a key for referencing the flattenDetails information. string No - -
isOrderByRule Specifies whether it is ordered by rule. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef TaskValidationOutputPortFieldTypeTypeHandlerParentRef defines nested fields for TaskValidation.OutputPort.Field.Type.TypeHandler.ParentRef. object No - -
projectionRules The projection rules. list[object] No - -
scope Reference key for the typed object. string No - -
scopeReference TaskValidationOutputPortFieldTypeTypeHandlerScopeReference defines nested fields for TaskValidation.OutputPort.Field.Type.TypeHandler.ScopeReference. object No - -

Spec.outputPorts[].fields[].type.typeHandler.configValues

Back to TaskValidation spec

TaskValidationOutputPortFieldTypeTypeHandlerConfigValues defines nested fields for TaskValidation.OutputPort.Field.Type.TypeHandler.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef TaskValidationOutputPortFieldTypeTypeHandlerConfigValuesParentRef defines nested fields for TaskValidation.OutputPort.Field.Type.TypeHandler.ConfigValues.ParentRef. object No - -

Spec.outputPorts[].fields[].type.typeHandler.configValues.configParamValues{}

Back to TaskValidation spec

TaskValidationOutputPortFieldTypeTypeHandlerConfigValuesConfigParamValues defines nested fields for TaskValidation.OutputPort.Field.Type.TypeHandler.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.outputPorts[].fields[].type.typeHandler.configValues.parentRef

Back to TaskValidation spec

TaskValidationOutputPortFieldTypeTypeHandlerConfigValuesParentRef defines nested fields for TaskValidation.OutputPort.Field.Type.TypeHandler.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.outputPorts[].fields[].type.typeHandler.parentRef

Back to TaskValidation spec

TaskValidationOutputPortFieldTypeTypeHandlerParentRef defines nested fields for TaskValidation.OutputPort.Field.Type.TypeHandler.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.outputPorts[].fields[].type.typeHandler.projectionRules[]

Back to TaskValidation spec

TaskValidationOutputPortFieldTypeTypeHandlerProjectionRule defines nested fields for TaskValidation.OutputPort.Field.Type.TypeHandler.ProjectionRule.

Field Description Type Required Default Enum
configValues TaskValidationOutputPortFieldTypeTypeHandlerProjectionRuleConfigValues defines nested fields for TaskValidation.OutputPort.Field.Type.TypeHandler.ProjectionRule.ConfigValues. object No - -
description A user defined description for the object. string No - -
fromName The attribute name that needs to be renamed. string No - -
isCascade Specifies whether to cascade or not. boolean No - -
isCaseSensitive Specifies if the rule is case sensitive. boolean No - -
isJavaRegexSyntax Specifies whether the rule uses a java regex syntax. boolean No - -
isSkipRemainingRulesOnMatch Specifies whether to skip remaining rules when a match is found. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
matchingStrategy The pattern matching strategy. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Name of the group. string No - -
names Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. list[string] No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef TaskValidationOutputPortFieldTypeTypeHandlerProjectionRuleParentRef defines nested fields for TaskValidation.OutputPort.Field.Type.TypeHandler.ProjectionRule.ParentRef. object No - -
pattern The rule pattern. string No - -
ruleType The rule type. string No - -
scope Reference to a typed object. This can be either a key value to an object within the document, a shall referenced to a TypedObject, or a full TypedObject definition. Unknown nested fields are preserved. object (preserves unknown fields) No - -
toName The new attribute name. string No - -
types An arry of types. list[object (preserves unknown fields)] No - -

Spec.outputPorts[].fields[].type.typeHandler.projectionRules[].configValues

Back to TaskValidation spec

TaskValidationOutputPortFieldTypeTypeHandlerProjectionRuleConfigValues defines nested fields for TaskValidation.OutputPort.Field.Type.TypeHandler.ProjectionRule.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef TaskValidationOutputPortFieldTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for TaskValidation.OutputPort.Field.Type.TypeHandler.ProjectionRule.ConfigValues.ParentRef. object No - -

Spec.outputPorts[].fields[].type.typeHandler.projectionRules[].configValues.configParamValues{}

Back to TaskValidation spec

TaskValidationOutputPortFieldTypeTypeHandlerProjectionRuleConfigValuesConfigParamValues defines nested fields for TaskValidation.OutputPort.Field.Type.TypeHandler.ProjectionRule.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.outputPorts[].fields[].type.typeHandler.projectionRules[].configValues.parentRef

Back to TaskValidation spec

TaskValidationOutputPortFieldTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for TaskValidation.OutputPort.Field.Type.TypeHandler.ProjectionRule.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.outputPorts[].fields[].type.typeHandler.projectionRules[].parentRef

Back to TaskValidation spec

TaskValidationOutputPortFieldTypeTypeHandlerProjectionRuleParentRef defines nested fields for TaskValidation.OutputPort.Field.Type.TypeHandler.ProjectionRule.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.outputPorts[].fields[].type.typeHandler.scopeReference

Back to TaskValidation spec

TaskValidationOutputPortFieldTypeTypeHandlerScopeReference defines nested fields for TaskValidation.OutputPort.Field.Type.TypeHandler.ScopeReference.

Field Description Type Required Default Enum
refObjectName The referenced object name for this reference. Set to the field name if the referenceType is BOUND_ENTITY_SHAPE_FIELD, else set to null. string No - -
referenceObject A key or shallow reference to an object. For direct reference, it points to the actual scope object. For BOUND_ENTITY_SHAPE or BOUND_ENTITY_SHAPE_FIELD, it points to the source or target operator. For OCI_FUNCTION_INPUT_SHAPE or OCI_FUNCTION_OUTPUT_SHAPE, it points to the OCI Function object. string Yes - -
referenceType The reference type for this reference. Set to null for a direct reference, for indirect references set to a type of association such as "BOUND_ENTITY_SHAPE". Current known reference type values are "BOUND_ENTITY_SHAPE", "BOUND_ENTITY_SHAPE_FIELD", "OCI_FUNCTION_INPUT_SHAPE", "OCI_FUNCTION_OUTPUT_SHAPE" string No - -

Spec.outputPorts[].fields[].useType

Back to TaskValidation spec

TaskValidationOutputPortFieldUseType defines nested fields for TaskValidation.OutputPort.Field.UseType.

Field Description Type Required Default Enum
configDefinition TaskValidationOutputPortFieldUseTypeConfigDefinition defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigDefinition. object No - -
configValues TaskValidationOutputPortFieldUseTypeConfigValues defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigValues. object No - -
description A user defined description for the object. string No - -
key The key of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef TaskValidationOutputPortFieldUseTypeParentRef defines nested fields for TaskValidation.OutputPort.Field.UseType.ParentRef. object No - -
wrappedType A wrapped type, may be a string or a BaseType. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Spec.outputPorts[].fields[].useType.configDefinition

Back to TaskValidation spec

TaskValidationOutputPortFieldUseTypeConfigDefinition defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigDefinition.

Field Description Type Required Default Enum
configParameterDefinitions The parameter configuration details. map[string, object] No - -
isContained Specifies whether the configuration is contained or not. boolean No - -
key The key of the object. string No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef TaskValidationOutputPortFieldUseTypeConfigDefinitionParentRef defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigDefinition.ParentRef. object No - -

Spec.outputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}

Back to TaskValidation spec

TaskValidationOutputPortFieldUseTypeConfigDefinitionConfigParameterDefinitions defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.

Field Description Type Required Default Enum
classFieldName The parameter class field name. string No - -
defaultValue The default value for the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
description A user defined description for the object. string No - -
isClassFieldValue Specifies whether the parameter is a class field or not. boolean No - -
isStatic Specifies whether the parameter is static or not. boolean No - -
parameterName This object represents the configurable properties for an object type. string No - -
parameterType TaskValidationOutputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterType defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType. object No - -

Spec.outputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}.parameterType

Back to TaskValidation spec

TaskValidationOutputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterType defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.

Field Description Type Required Default Enum
configDefinition JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
configValues TaskValidationOutputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValues defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues. object No - -
containsNull Defines whether null values are allowed. boolean No - -
description A user defined description for the object. string No - -
dtType The data type. string No - -
elementType Seeded type string No - -
elements An array of elements. list[string] No - -
javaTypeName The java type name. string No - -
jsonData - string No - -
key The key of the object. string No - -
keyElementType Seeded type string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef TaskValidationOutputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeParentRef defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ParentRef. object No - -
pathNames An array of path names corresponding to the elements. The path names are used when referring to the field in an expression. list[string] No - -
typeHandler TaskValidationOutputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandler defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler. object No - -
typeSystemName The data type system name. string No - -
valueElementType Seeded type string No - -
wrappedType A wrapped type, may be a string or a BaseType. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Spec.outputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}.parameterType.configValues

Back to TaskValidation spec

TaskValidationOutputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValues defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef TaskValidationOutputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesParentRef defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ParentRef. object No - -

Spec.outputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}.parameterType.configValues.configParamValues{}

Back to TaskValidation spec

TaskValidationOutputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesConfigParamValues defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.outputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}.parameterType.configValues.parentRef

Back to TaskValidation spec

TaskValidationOutputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesParentRef defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.outputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}.parameterType.parentRef

Back to TaskValidation spec

TaskValidationOutputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeParentRef defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.outputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler

Back to TaskValidation spec

TaskValidationOutputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandler defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.

Field Description Type Required Default Enum
configValues TaskValidationOutputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValues defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues. object No - -
flattenDetails Contains a key for referencing the flattenDetails information. string No - -
isOrderByRule Specifies whether it is ordered by rule. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef TaskValidationOutputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerParentRef defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ParentRef. object No - -
projectionRules The projection rules. list[object] No - -
scope Reference key for the typed object. string No - -
scopeReference TaskValidationOutputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerScopeReference defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ScopeReference. object No - -

Spec.outputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues

Back to TaskValidation spec

TaskValidationOutputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValues defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef TaskValidationOutputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesParentRef defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ParentRef. object No - -

Spec.outputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues.configParamValues{}

Back to TaskValidation spec

TaskValidationOutputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesConfigParamValues defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.outputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues.parentRef

Back to TaskValidation spec

TaskValidationOutputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesParentRef defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.outputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.parentRef

Back to TaskValidation spec

TaskValidationOutputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerParentRef defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.outputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[]

Back to TaskValidation spec

TaskValidationOutputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRule defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.

Field Description Type Required Default Enum
configValues TaskValidationOutputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValues defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues. object No - -
description A user defined description for the object. string No - -
fromName The attribute name that needs to be renamed. string No - -
isCascade Specifies whether to cascade or not. boolean No - -
isCaseSensitive Specifies if the rule is case sensitive. boolean No - -
isJavaRegexSyntax Specifies whether the rule uses a java regex syntax. boolean No - -
isSkipRemainingRulesOnMatch Specifies whether to skip remaining rules when a match is found. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
matchingStrategy The pattern matching strategy. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Name of the group. string No - -
names Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. list[string] No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef TaskValidationOutputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleParentRef defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ParentRef. object No - -
pattern The rule pattern. string No - -
ruleType The rule type. string No - -
scope Reference to a typed object. This can be either a key value to an object within the document, a shall referenced to a TypedObject, or a full TypedObject definition. Unknown nested fields are preserved. object (preserves unknown fields) No - -
toName The new attribute name. string No - -
types An arry of types. list[object (preserves unknown fields)] No - -

Spec.outputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues

Back to TaskValidation spec

TaskValidationOutputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValues defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef TaskValidationOutputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ParentRef. object No - -

Spec.outputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues.configParamValues{}

Back to TaskValidation spec

TaskValidationOutputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesConfigParamValues defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.outputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues.parentRef

Back to TaskValidation spec

TaskValidationOutputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.outputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].parentRef

Back to TaskValidation spec

TaskValidationOutputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleParentRef defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.outputPorts[].fields[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.scopeReference

Back to TaskValidation spec

TaskValidationOutputPortFieldUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerScopeReference defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ScopeReference.

Field Description Type Required Default Enum
refObjectName The referenced object name for this reference. Set to the field name if the referenceType is BOUND_ENTITY_SHAPE_FIELD, else set to null. string No - -
referenceObject A key or shallow reference to an object. For direct reference, it points to the actual scope object. For BOUND_ENTITY_SHAPE or BOUND_ENTITY_SHAPE_FIELD, it points to the source or target operator. For OCI_FUNCTION_INPUT_SHAPE or OCI_FUNCTION_OUTPUT_SHAPE, it points to the OCI Function object. string Yes - -
referenceType The reference type for this reference. Set to null for a direct reference, for indirect references set to a type of association such as "BOUND_ENTITY_SHAPE". Current known reference type values are "BOUND_ENTITY_SHAPE", "BOUND_ENTITY_SHAPE_FIELD", "OCI_FUNCTION_INPUT_SHAPE", "OCI_FUNCTION_OUTPUT_SHAPE" string No - -

Spec.outputPorts[].fields[].useType.configDefinition.parentRef

Back to TaskValidation spec

TaskValidationOutputPortFieldUseTypeConfigDefinitionParentRef defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigDefinition.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.outputPorts[].fields[].useType.configValues

Back to TaskValidation spec

TaskValidationOutputPortFieldUseTypeConfigValues defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef TaskValidationOutputPortFieldUseTypeConfigValuesParentRef defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigValues.ParentRef. object No - -

Spec.outputPorts[].fields[].useType.configValues.configParamValues{}

Back to TaskValidation spec

TaskValidationOutputPortFieldUseTypeConfigValuesConfigParamValues defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.outputPorts[].fields[].useType.configValues.parentRef

Back to TaskValidation spec

TaskValidationOutputPortFieldUseTypeConfigValuesParentRef defines nested fields for TaskValidation.OutputPort.Field.UseType.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.outputPorts[].fields[].useType.parentRef

Back to TaskValidation spec

TaskValidationOutputPortFieldUseTypeParentRef defines nested fields for TaskValidation.OutputPort.Field.UseType.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.outputPorts[].parentRef

Back to TaskValidation spec

TaskValidationOutputPortParentRef defines nested fields for TaskValidation.OutputPort.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.parameters[]

Back to TaskValidation spec

TaskValidationParameter defines nested fields for TaskValidation.Parameter.

Field Description Type Required Default Enum
configValues TaskValidationParameterConfigValues defines nested fields for TaskValidation.Parameter.ConfigValues. object No - -
defaultValue The default value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
description Detailed description for the object. string No - -
isInput Specifies whether the parameter is input value. boolean No - -
isOutput Specifies whether the parameter is output value. boolean No - -
key The key of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
outputAggregationType The output aggregation type. string No - -
parentRef TaskValidationParameterParentRef defines nested fields for TaskValidation.Parameter.ParentRef. object No - -
rootObjectDefaultValue The default value of the parameter which can be an object in DIS, such as a data entity. Unknown nested fields are preserved. object (preserves unknown fields) No - -
type This can either be a string value referencing the type or a BaseType object. Unknown nested fields are preserved. object (preserves unknown fields) No - -
typeName The type of value the parameter was created for. string No - -
usedFor The param name for which parameter is created for for eg. driver Shape, Operation etc. string No - -

Spec.parameters[].configValues

Back to TaskValidation spec

TaskValidationParameterConfigValues defines nested fields for TaskValidation.Parameter.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef TaskValidationParameterConfigValuesParentRef defines nested fields for TaskValidation.Parameter.ConfigValues.ParentRef. object No - -

Spec.parameters[].configValues.configParamValues{}

Back to TaskValidation spec

TaskValidationParameterConfigValuesConfigParamValues defines nested fields for TaskValidation.Parameter.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.parameters[].configValues.parentRef

Back to TaskValidation spec

TaskValidationParameterConfigValuesParentRef defines nested fields for TaskValidation.Parameter.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.parameters[].parentRef

Back to TaskValidation spec

TaskValidationParameterParentRef defines nested fields for TaskValidation.Parameter.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.parentRef

Back to TaskValidation spec

TaskValidationParentRef defines nested fields for TaskValidation.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status

TaskValidationStatus defines the observed state of TaskValidation.

Field Description Type Required Default Enum
description Detailed description for the object. string No - -
errorMessageCount Total number of validation error messages. integer No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
infoMessageCount Total number of validation information messages. integer No - -
key Objects use a 36 character key as unique ID. It is system generated and cannot be modified. string No - -
metadata TaskValidationMetadata defines nested fields for TaskValidation.Metadata. object No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef TaskValidationParentRef defines nested fields for TaskValidation.ParentRef. object No - -
status - object Yes - -
totalMessageCount Total number of validation messages. integer No - -
validationMessages Detailed information of the data flow object validation. map[string, list[object]] No - -
warnMessageCount Total number of validation warning messages. integer No - -

Status.metadata

Back to TaskValidation status

TaskValidationMetadata defines nested fields for TaskValidation.Metadata.

Field Description Type Required Default Enum
aggregator TaskValidationMetadataAggregator defines nested fields for TaskValidation.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics TaskValidationMetadataCountStatistics defines nested fields for TaskValidation.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.metadata.aggregator

Back to TaskValidation status

TaskValidationMetadataAggregator defines nested fields for TaskValidation.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.metadata.countStatistics

Back to TaskValidation status

TaskValidationMetadataCountStatistics defines nested fields for TaskValidation.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Status.metadata.countStatistics.objectTypeCountList[]

Back to TaskValidation status

TaskValidationMetadataCountStatisticsObjectTypeCountList defines nested fields for TaskValidation.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.parentRef

Back to TaskValidation status

TaskValidationParentRef defines nested fields for TaskValidation.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.status

Back to TaskValidation 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

Back to TaskValidation status

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

Back to TaskValidation status

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[]

Back to TaskValidation status

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

Status.validationMessages{}

Back to TaskValidation status

No documented fields in the checked-in CRD schema.

UserDefinedFunction

UserDefinedFunction is the Schema for the userdefinedfunctions API.

  • Plural: userdefinedfunctions
  • Scope: Namespaced
  • APIVersion: dataintegration.oracle.com/v1beta1
  • Sample: Sample (config/samples/dataintegration_v1beta1_userdefinedfunction.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

UserDefinedFunctionSpec defines the desired state of UserDefinedFunction.

Field Description Type Required Default Enum
description Detailed description for the object. string No - -
expr UserDefinedFunctionExpr defines nested fields for UserDefinedFunction.Expr. object No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string Yes - -
key Generated key that can be used in API calls to identify user defined function. On scenarios where reference to the user defined function is needed, a value can be passed in create. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string Yes - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef UserDefinedFunctionParentRef defines nested fields for UserDefinedFunction.ParentRef. object No - -
registryMetadata UserDefinedFunctionRegistryMetadata defines nested fields for UserDefinedFunction.RegistryMetadata. object Yes - -
signatures An array of function signature. list[object] No - -

Spec.expr

Back to UserDefinedFunction spec

UserDefinedFunctionExpr defines nested fields for UserDefinedFunction.Expr.

Field Description Type Required Default Enum
configValues UserDefinedFunctionExprConfigValues defines nested fields for UserDefinedFunction.Expr.ConfigValues. object No - -
exprString The expression string for the object. string No - -
key The object key. string No - -
modelType The object type. string No - -
modelVersion The object's model version. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionExprParentRef defines nested fields for UserDefinedFunction.Expr.ParentRef. object No - -

Spec.expr.configValues

Back to UserDefinedFunction spec

UserDefinedFunctionExprConfigValues defines nested fields for UserDefinedFunction.Expr.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionExprConfigValuesParentRef defines nested fields for UserDefinedFunction.Expr.ConfigValues.ParentRef. object No - -

Spec.expr.configValues.configParamValues{}

Back to UserDefinedFunction spec

UserDefinedFunctionExprConfigValuesConfigParamValues defines nested fields for UserDefinedFunction.Expr.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.expr.configValues.parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionExprConfigValuesParentRef defines nested fields for UserDefinedFunction.Expr.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.expr.parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionExprParentRef defines nested fields for UserDefinedFunction.Expr.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionParentRef defines nested fields for UserDefinedFunction.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.registryMetadata

Back to UserDefinedFunction spec

UserDefinedFunctionRegistryMetadata defines nested fields for UserDefinedFunction.RegistryMetadata.

Field Description Type Required Default Enum
aggregatorKey The owning object's key for this object. string No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
key The identifying key for the object. string No - -
labels Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version. integer No - -

Spec.signatures[]

Back to UserDefinedFunction spec

UserDefinedFunctionSignature defines nested fields for UserDefinedFunction.Signature.

Field Description Type Required Default Enum
arguments An array of function arguments. list[object] No - -
description Detailed description for the object. string No - -
key The key of the object. string No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureParentRef defines nested fields for UserDefinedFunction.Signature.ParentRef. object No - -
retType UserDefinedFunctionSignatureRetType defines nested fields for UserDefinedFunction.Signature.RetType. object No - -

Spec.signatures[].arguments[]

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgument defines nested fields for UserDefinedFunction.Signature.Argument.

Field Description Type Required Default Enum
columnNamePattern column name pattern can be used to generate the name structure of the generated columns. By default column names are of %PIVOT_KEY_VALUE% or %MACRO_INPUT%%PIVOT_KEY_VALUE%, but we can change it something by passing something like MY_PREFIX%PIVOT_KEY_VALUE%MY_SUFFIX or MY_PREFIX%MACRO_INPUT%%PIVOT_KEY_VALUE%MY_SUFFIX which will add custom prefix and suffix to the column name. string No - -
configValues UserDefinedFunctionSignatureArgumentConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.ConfigValues. object No - -
decisionOutputPortType The port based on what decision expression evaluates to. string No - -
defaultValue The default value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
description Detailed description for the object. string No - -
expr UserDefinedFunctionSignatureArgumentExpr defines nested fields for UserDefinedFunction.Signature.Argument.Expr. object No - -
expression The expression string for the object. string No - -
fields An array of fields. list[object (preserves unknown fields)] No - -
isInput Specifies whether the parameter is input value. boolean No - -
isOutput Specifies whether the parameter is output value. boolean No - -
isUseInferredType Specifies whether to use inferred expression output type as output type of the derived field. Default value of this flag is false. boolean No - -
isUseSourceType Specifies whether the type of macro fields is inferred from an expression or useType (false) or the source field (true). boolean No - -
jsonData - string No - -
key The key of the object. string No - -
labels Labels are keywords or labels that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
nativeShapeField UserDefinedFunctionSignatureArgumentNativeShapeField defines nested fields for UserDefinedFunction.Signature.Argument.NativeShapeField. object No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
outputAggregationType The output aggregation type. string No - -
parentRef UserDefinedFunctionSignatureArgumentParentRef defines nested fields for UserDefinedFunction.Signature.Argument.ParentRef. object No - -
portType The port details for the data asset.Type. string No - -
rootObjectDefaultValue The default value of the parameter which can be an object in DIS, such as a data entity. Unknown nested fields are preserved. object (preserves unknown fields) No - -
scope Reference key value to an object within the document. string No - -
scopeReference UserDefinedFunctionSignatureArgumentScopeReference defines nested fields for UserDefinedFunction.Signature.Argument.ScopeReference. object No - -
splitCondition UserDefinedFunctionSignatureArgumentSplitCondition defines nested fields for UserDefinedFunction.Signature.Argument.SplitCondition. object No - -
type UserDefinedFunctionSignatureArgumentType defines nested fields for UserDefinedFunction.Signature.Argument.Type. object No - -
typeName The type of value the parameter was created for. string No - -
useType UserDefinedFunctionSignatureArgumentUseType defines nested fields for UserDefinedFunction.Signature.Argument.UseType. object No - -
usedFor The param name for which parameter is created for for eg. driver Shape, Operation etc. string No - -

Spec.signatures[].arguments[].configValues

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionSignatureArgumentConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.ConfigValues.ParentRef. object No - -

Spec.signatures[].arguments[].configValues.configParamValues{}

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentConfigValuesConfigParamValues defines nested fields for UserDefinedFunction.Signature.Argument.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.signatures[].arguments[].configValues.parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].expr

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentExpr defines nested fields for UserDefinedFunction.Signature.Argument.Expr.

Field Description Type Required Default Enum
configValues UserDefinedFunctionSignatureArgumentExprConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.Expr.ConfigValues. object No - -
exprString The expression string for the object. string No - -
key The object key. string No - -
modelType The object type. string No - -
modelVersion The object's model version. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureArgumentExprParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Expr.ParentRef. object No - -

Spec.signatures[].arguments[].expr.configValues

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentExprConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.Expr.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionSignatureArgumentExprConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Expr.ConfigValues.ParentRef. object No - -

Spec.signatures[].arguments[].expr.configValues.configParamValues{}

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentExprConfigValuesConfigParamValues defines nested fields for UserDefinedFunction.Signature.Argument.Expr.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.signatures[].arguments[].expr.configValues.parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentExprConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Expr.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].expr.parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentExprParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Expr.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].nativeShapeField

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentNativeShapeField defines nested fields for UserDefinedFunction.Signature.Argument.NativeShapeField.

Field Description Type Required Default Enum
configValues UserDefinedFunctionSignatureArgumentNativeShapeFieldConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.NativeShapeField.ConfigValues. object No - -
defaultValueString The default value. string No - -
isMandatory Specifies whether the field is mandatory. boolean No - -
modelType The model type reference. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
position The position of the attribute. integer No - -
type The type reference. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Spec.signatures[].arguments[].nativeShapeField.configValues

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentNativeShapeFieldConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.NativeShapeField.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionSignatureArgumentNativeShapeFieldConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.NativeShapeField.ConfigValues.ParentRef. object No - -

Spec.signatures[].arguments[].nativeShapeField.configValues.configParamValues{}

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentNativeShapeFieldConfigValuesConfigParamValues defines nested fields for UserDefinedFunction.Signature.Argument.NativeShapeField.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.signatures[].arguments[].nativeShapeField.configValues.parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentNativeShapeFieldConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.NativeShapeField.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentParentRef defines nested fields for UserDefinedFunction.Signature.Argument.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].scopeReference

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentScopeReference defines nested fields for UserDefinedFunction.Signature.Argument.ScopeReference.

Field Description Type Required Default Enum
refObjectName The referenced object name for this reference. Set to the field name if the referenceType is BOUND_ENTITY_SHAPE_FIELD, else set to null. string No - -
referenceObject A key or shallow reference to an object. For direct reference, it points to the actual scope object. For BOUND_ENTITY_SHAPE or BOUND_ENTITY_SHAPE_FIELD, it points to the source or target operator. For OCI_FUNCTION_INPUT_SHAPE or OCI_FUNCTION_OUTPUT_SHAPE, it points to the OCI Function object. string Yes - -
referenceType The reference type for this reference. Set to null for a direct reference, for indirect references set to a type of association such as "BOUND_ENTITY_SHAPE". Current known reference type values are "BOUND_ENTITY_SHAPE", "BOUND_ENTITY_SHAPE_FIELD", "OCI_FUNCTION_INPUT_SHAPE", "OCI_FUNCTION_OUTPUT_SHAPE" string No - -

Spec.signatures[].arguments[].splitCondition

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentSplitCondition defines nested fields for UserDefinedFunction.Signature.Argument.SplitCondition.

Field Description Type Required Default Enum
configValues UserDefinedFunctionSignatureArgumentSplitConditionConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.SplitCondition.ConfigValues. object No - -
exprString The expression string for the object. string No - -
key The object key. string No - -
modelType The object type. string No - -
modelVersion The object's model version. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureArgumentSplitConditionParentRef defines nested fields for UserDefinedFunction.Signature.Argument.SplitCondition.ParentRef. object No - -

Spec.signatures[].arguments[].splitCondition.configValues

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentSplitConditionConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.SplitCondition.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionSignatureArgumentSplitConditionConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.SplitCondition.ConfigValues.ParentRef. object No - -

Spec.signatures[].arguments[].splitCondition.configValues.configParamValues{}

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentSplitConditionConfigValuesConfigParamValues defines nested fields for UserDefinedFunction.Signature.Argument.SplitCondition.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.signatures[].arguments[].splitCondition.configValues.parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentSplitConditionConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.SplitCondition.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].splitCondition.parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentSplitConditionParentRef defines nested fields for UserDefinedFunction.Signature.Argument.SplitCondition.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].type

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentType defines nested fields for UserDefinedFunction.Signature.Argument.Type.

Field Description Type Required Default Enum
configDefinition UserDefinedFunctionSignatureArgumentTypeConfigDefinition defines nested fields for UserDefinedFunction.Signature.Argument.Type.ConfigDefinition. object No - -
configValues UserDefinedFunctionSignatureArgumentTypeConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.Type.ConfigValues. object No - -
containsNull Defines whether null values are allowed. boolean No - -
description A user defined description for the object. string No - -
dtType The data type. string No - -
elementType Seeded type string No - -
elements An array of elements. list[string] No - -
javaTypeName The java type name. string No - -
jsonData - string No - -
key The key of the object. string No - -
keyElementType Seeded type string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureArgumentTypeParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Type.ParentRef. object No - -
pathNames An array of path names corresponding to the elements. The path names are used when referring to the field in an expression. list[string] No - -
typeHandler UserDefinedFunctionSignatureArgumentTypeTypeHandler defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler. object No - -
typeSystemName The data type system name. string No - -
valueElementType Seeded type string No - -
wrappedType A wrapped type, may be a string or a BaseType. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Spec.signatures[].arguments[].type.configDefinition

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentTypeConfigDefinition defines nested fields for UserDefinedFunction.Signature.Argument.Type.ConfigDefinition.

Field Description Type Required Default Enum
configParameterDefinitions The parameter configuration details. map[string, object] No - -
isContained Specifies whether the configuration is contained or not. boolean No - -
key The key of the object. string No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureArgumentTypeConfigDefinitionParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Type.ConfigDefinition.ParentRef. object No - -

Spec.signatures[].arguments[].type.configDefinition.configParameterDefinitions{}

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentTypeConfigDefinitionConfigParameterDefinitions defines nested fields for UserDefinedFunction.Signature.Argument.Type.ConfigDefinition.ConfigParameterDefinitions.

Field Description Type Required Default Enum
classFieldName The parameter class field name. string No - -
defaultValue The default value for the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
description A user defined description for the object. string No - -
isClassFieldValue Specifies whether the parameter is a class field or not. boolean No - -
isStatic Specifies whether the parameter is static or not. boolean No - -
parameterName This object represents the configurable properties for an object type. string No - -
parameterType JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Spec.signatures[].arguments[].type.configDefinition.parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentTypeConfigDefinitionParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Type.ConfigDefinition.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].type.configValues

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentTypeConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.Type.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionSignatureArgumentTypeConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Type.ConfigValues.ParentRef. object No - -

Spec.signatures[].arguments[].type.configValues.configParamValues{}

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentTypeConfigValuesConfigParamValues defines nested fields for UserDefinedFunction.Signature.Argument.Type.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.signatures[].arguments[].type.configValues.parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentTypeConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Type.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].type.parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentTypeParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Type.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].type.typeHandler

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentTypeTypeHandler defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.

Field Description Type Required Default Enum
configValues UserDefinedFunctionSignatureArgumentTypeTypeHandlerConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ConfigValues. object No - -
flattenDetails Contains a key for referencing the flattenDetails information. string No - -
isOrderByRule Specifies whether it is ordered by rule. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureArgumentTypeTypeHandlerParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ParentRef. object No - -
projectionRules The projection rules. list[object] No - -
scope Reference key for the typed object. string No - -
scopeReference UserDefinedFunctionSignatureArgumentTypeTypeHandlerScopeReference defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ScopeReference. object No - -

Spec.signatures[].arguments[].type.typeHandler.configValues

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentTypeTypeHandlerConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionSignatureArgumentTypeTypeHandlerConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ConfigValues.ParentRef. object No - -

Spec.signatures[].arguments[].type.typeHandler.configValues.configParamValues{}

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentTypeTypeHandlerConfigValuesConfigParamValues defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.signatures[].arguments[].type.typeHandler.configValues.parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentTypeTypeHandlerConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].type.typeHandler.parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentTypeTypeHandlerParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].type.typeHandler.projectionRules[]

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentTypeTypeHandlerProjectionRule defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ProjectionRule.

Field Description Type Required Default Enum
configValues UserDefinedFunctionSignatureArgumentTypeTypeHandlerProjectionRuleConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ProjectionRule.ConfigValues. object No - -
description A user defined description for the object. string No - -
fromName The attribute name that needs to be renamed. string No - -
isCascade Specifies whether to cascade or not. boolean No - -
isCaseSensitive Specifies if the rule is case sensitive. boolean No - -
isJavaRegexSyntax Specifies whether the rule uses a java regex syntax. boolean No - -
isSkipRemainingRulesOnMatch Specifies whether to skip remaining rules when a match is found. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
matchingStrategy The pattern matching strategy. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Name of the group. string No - -
names Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. list[string] No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureArgumentTypeTypeHandlerProjectionRuleParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ProjectionRule.ParentRef. object No - -
pattern The rule pattern. string No - -
ruleType The rule type. string No - -
scope Reference to a typed object. This can be either a key value to an object within the document, a shall referenced to a TypedObject, or a full TypedObject definition. Unknown nested fields are preserved. object (preserves unknown fields) No - -
toName The new attribute name. string No - -
types An arry of types. list[object (preserves unknown fields)] No - -

Spec.signatures[].arguments[].type.typeHandler.projectionRules[].configValues

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentTypeTypeHandlerProjectionRuleConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ProjectionRule.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionSignatureArgumentTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ProjectionRule.ConfigValues.ParentRef. object No - -

Spec.signatures[].arguments[].type.typeHandler.projectionRules[].configValues.configParamValues{}

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentTypeTypeHandlerProjectionRuleConfigValuesConfigParamValues defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ProjectionRule.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.signatures[].arguments[].type.typeHandler.projectionRules[].configValues.parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ProjectionRule.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].type.typeHandler.projectionRules[].parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentTypeTypeHandlerProjectionRuleParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ProjectionRule.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].type.typeHandler.scopeReference

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentTypeTypeHandlerScopeReference defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ScopeReference.

Field Description Type Required Default Enum
refObjectName The referenced object name for this reference. Set to the field name if the referenceType is BOUND_ENTITY_SHAPE_FIELD, else set to null. string No - -
referenceObject A key or shallow reference to an object. For direct reference, it points to the actual scope object. For BOUND_ENTITY_SHAPE or BOUND_ENTITY_SHAPE_FIELD, it points to the source or target operator. For OCI_FUNCTION_INPUT_SHAPE or OCI_FUNCTION_OUTPUT_SHAPE, it points to the OCI Function object. string Yes - -
referenceType The reference type for this reference. Set to null for a direct reference, for indirect references set to a type of association such as "BOUND_ENTITY_SHAPE". Current known reference type values are "BOUND_ENTITY_SHAPE", "BOUND_ENTITY_SHAPE_FIELD", "OCI_FUNCTION_INPUT_SHAPE", "OCI_FUNCTION_OUTPUT_SHAPE" string No - -

Spec.signatures[].arguments[].useType

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentUseType defines nested fields for UserDefinedFunction.Signature.Argument.UseType.

Field Description Type Required Default Enum
configDefinition UserDefinedFunctionSignatureArgumentUseTypeConfigDefinition defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition. object No - -
configValues UserDefinedFunctionSignatureArgumentUseTypeConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigValues. object No - -
description A user defined description for the object. string No - -
key The key of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureArgumentUseTypeParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ParentRef. object No - -
wrappedType A wrapped type, may be a string or a BaseType. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Spec.signatures[].arguments[].useType.configDefinition

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinition defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.

Field Description Type Required Default Enum
configParameterDefinitions The parameter configuration details. map[string, object] No - -
isContained Specifies whether the configuration is contained or not. boolean No - -
key The key of the object. string No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ParentRef. object No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitions defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.

Field Description Type Required Default Enum
classFieldName The parameter class field name. string No - -
defaultValue The default value for the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
description A user defined description for the object. string No - -
isClassFieldValue Specifies whether the parameter is a class field or not. boolean No - -
isStatic Specifies whether the parameter is static or not. boolean No - -
parameterName This object represents the configurable properties for an object type. string No - -
parameterType UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterType defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType. object No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterType defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.

Field Description Type Required Default Enum
configDefinition JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
configValues UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues. object No - -
containsNull Defines whether null values are allowed. boolean No - -
description A user defined description for the object. string No - -
dtType The data type. string No - -
elementType Seeded type string No - -
elements An array of elements. list[string] No - -
javaTypeName The java type name. string No - -
jsonData - string No - -
key The key of the object. string No - -
keyElementType Seeded type string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ParentRef. object No - -
pathNames An array of path names corresponding to the elements. The path names are used when referring to the field in an expression. list[string] No - -
typeHandler UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandler defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler. object No - -
typeSystemName The data type system name. string No - -
valueElementType Seeded type string No - -
wrappedType A wrapped type, may be a string or a BaseType. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.configValues

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ParentRef. object No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.configValues.configParamValues{}

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesConfigParamValues defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.configValues.parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandler defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.

Field Description Type Required Default Enum
configValues UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues. object No - -
flattenDetails Contains a key for referencing the flattenDetails information. string No - -
isOrderByRule Specifies whether it is ordered by rule. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ParentRef. object No - -
projectionRules The projection rules. list[object] No - -
scope Reference key for the typed object. string No - -
scopeReference UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerScopeReference defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ScopeReference. object No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ParentRef. object No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues.configParamValues{}

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesConfigParamValues defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues.parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[]

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRule defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.

Field Description Type Required Default Enum
configValues UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues. object No - -
description A user defined description for the object. string No - -
fromName The attribute name that needs to be renamed. string No - -
isCascade Specifies whether to cascade or not. boolean No - -
isCaseSensitive Specifies if the rule is case sensitive. boolean No - -
isJavaRegexSyntax Specifies whether the rule uses a java regex syntax. boolean No - -
isSkipRemainingRulesOnMatch Specifies whether to skip remaining rules when a match is found. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
matchingStrategy The pattern matching strategy. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Name of the group. string No - -
names Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. list[string] No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ParentRef. object No - -
pattern The rule pattern. string No - -
ruleType The rule type. string No - -
scope Reference to a typed object. This can be either a key value to an object within the document, a shall referenced to a TypedObject, or a full TypedObject definition. Unknown nested fields are preserved. object (preserves unknown fields) No - -
toName The new attribute name. string No - -
types An arry of types. list[object (preserves unknown fields)] No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ParentRef. object No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues.configParamValues{}

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesConfigParamValues defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues.parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.scopeReference

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerScopeReference defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ScopeReference.

Field Description Type Required Default Enum
refObjectName The referenced object name for this reference. Set to the field name if the referenceType is BOUND_ENTITY_SHAPE_FIELD, else set to null. string No - -
referenceObject A key or shallow reference to an object. For direct reference, it points to the actual scope object. For BOUND_ENTITY_SHAPE or BOUND_ENTITY_SHAPE_FIELD, it points to the source or target operator. For OCI_FUNCTION_INPUT_SHAPE or OCI_FUNCTION_OUTPUT_SHAPE, it points to the OCI Function object. string Yes - -
referenceType The reference type for this reference. Set to null for a direct reference, for indirect references set to a type of association such as "BOUND_ENTITY_SHAPE". Current known reference type values are "BOUND_ENTITY_SHAPE", "BOUND_ENTITY_SHAPE_FIELD", "OCI_FUNCTION_INPUT_SHAPE", "OCI_FUNCTION_OUTPUT_SHAPE" string No - -

Spec.signatures[].arguments[].useType.configDefinition.parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].useType.configValues

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentUseTypeConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionSignatureArgumentUseTypeConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigValues.ParentRef. object No - -

Spec.signatures[].arguments[].useType.configValues.configParamValues{}

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentUseTypeConfigValuesConfigParamValues defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.signatures[].arguments[].useType.configValues.parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentUseTypeConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].useType.parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureArgumentUseTypeParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureParentRef defines nested fields for UserDefinedFunction.Signature.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].retType

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureRetType defines nested fields for UserDefinedFunction.Signature.RetType.

Field Description Type Required Default Enum
configDefinition UserDefinedFunctionSignatureRetTypeConfigDefinition defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition. object No - -
configValues UserDefinedFunctionSignatureRetTypeConfigValues defines nested fields for UserDefinedFunction.Signature.RetType.ConfigValues. object No - -
description A user defined description for the object. string No - -
key The key of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureRetTypeParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ParentRef. object No - -
wrappedType A wrapped type, may be a string or a BaseType. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Spec.signatures[].retType.configDefinition

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureRetTypeConfigDefinition defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.

Field Description Type Required Default Enum
configParameterDefinitions The parameter configuration details. map[string, object] No - -
isContained Specifies whether the configuration is contained or not. boolean No - -
key The key of the object. string No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureRetTypeConfigDefinitionParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ParentRef. object No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitions defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.

Field Description Type Required Default Enum
classFieldName The parameter class field name. string No - -
defaultValue The default value for the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
description A user defined description for the object. string No - -
isClassFieldValue Specifies whether the parameter is a class field or not. boolean No - -
isStatic Specifies whether the parameter is static or not. boolean No - -
parameterName This object represents the configurable properties for an object type. string No - -
parameterType UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterType defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType. object No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterType defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.

Field Description Type Required Default Enum
configDefinition JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
configValues UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValues defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues. object No - -
containsNull Defines whether null values are allowed. boolean No - -
description A user defined description for the object. string No - -
dtType The data type. string No - -
elementType Seeded type string No - -
elements An array of elements. list[string] No - -
javaTypeName The java type name. string No - -
jsonData - string No - -
key The key of the object. string No - -
keyElementType Seeded type string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ParentRef. object No - -
pathNames An array of path names corresponding to the elements. The path names are used when referring to the field in an expression. list[string] No - -
typeHandler UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandler defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler. object No - -
typeSystemName The data type system name. string No - -
valueElementType Seeded type string No - -
wrappedType A wrapped type, may be a string or a BaseType. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.configValues

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValues defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ParentRef. object No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.configValues.configParamValues{}

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesConfigParamValues defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.configValues.parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandler defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.

Field Description Type Required Default Enum
configValues UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValues defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues. object No - -
flattenDetails Contains a key for referencing the flattenDetails information. string No - -
isOrderByRule Specifies whether it is ordered by rule. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ParentRef. object No - -
projectionRules The projection rules. list[object] No - -
scope Reference key for the typed object. string No - -
scopeReference UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerScopeReference defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ScopeReference. object No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValues defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ParentRef. object No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues.configParamValues{}

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesConfigParamValues defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues.parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[]

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRule defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.

Field Description Type Required Default Enum
configValues UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValues defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues. object No - -
description A user defined description for the object. string No - -
fromName The attribute name that needs to be renamed. string No - -
isCascade Specifies whether to cascade or not. boolean No - -
isCaseSensitive Specifies if the rule is case sensitive. boolean No - -
isJavaRegexSyntax Specifies whether the rule uses a java regex syntax. boolean No - -
isSkipRemainingRulesOnMatch Specifies whether to skip remaining rules when a match is found. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
matchingStrategy The pattern matching strategy. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Name of the group. string No - -
names Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. list[string] No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ParentRef. object No - -
pattern The rule pattern. string No - -
ruleType The rule type. string No - -
scope Reference to a typed object. This can be either a key value to an object within the document, a shall referenced to a TypedObject, or a full TypedObject definition. Unknown nested fields are preserved. object (preserves unknown fields) No - -
toName The new attribute name. string No - -
types An arry of types. list[object (preserves unknown fields)] No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValues defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ParentRef. object No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues.configParamValues{}

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesConfigParamValues defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues.parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.scopeReference

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerScopeReference defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ScopeReference.

Field Description Type Required Default Enum
refObjectName The referenced object name for this reference. Set to the field name if the referenceType is BOUND_ENTITY_SHAPE_FIELD, else set to null. string No - -
referenceObject A key or shallow reference to an object. For direct reference, it points to the actual scope object. For BOUND_ENTITY_SHAPE or BOUND_ENTITY_SHAPE_FIELD, it points to the source or target operator. For OCI_FUNCTION_INPUT_SHAPE or OCI_FUNCTION_OUTPUT_SHAPE, it points to the OCI Function object. string Yes - -
referenceType The reference type for this reference. Set to null for a direct reference, for indirect references set to a type of association such as "BOUND_ENTITY_SHAPE". Current known reference type values are "BOUND_ENTITY_SHAPE", "BOUND_ENTITY_SHAPE_FIELD", "OCI_FUNCTION_INPUT_SHAPE", "OCI_FUNCTION_OUTPUT_SHAPE" string No - -

Spec.signatures[].retType.configDefinition.parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureRetTypeConfigDefinitionParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].retType.configValues

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureRetTypeConfigValues defines nested fields for UserDefinedFunction.Signature.RetType.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionSignatureRetTypeConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ConfigValues.ParentRef. object No - -

Spec.signatures[].retType.configValues.configParamValues{}

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureRetTypeConfigValuesConfigParamValues defines nested fields for UserDefinedFunction.Signature.RetType.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.signatures[].retType.configValues.parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureRetTypeConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].retType.parentRef

Back to UserDefinedFunction spec

UserDefinedFunctionSignatureRetTypeParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status

UserDefinedFunctionStatus defines the observed state of UserDefinedFunction.

Field Description Type Required Default Enum
description Detailed description for the object. string No - -
expr UserDefinedFunctionExpr defines nested fields for UserDefinedFunction.Expr. object No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
key Generated key that can be used in API calls to identify user defined function. On scenarios where reference to the user defined function is needed, a value can be passed in create. string No - -
keyMap A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. map[string, string] No - -
metadata UserDefinedFunctionMetadata defines nested fields for UserDefinedFunction.Metadata. object No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef UserDefinedFunctionParentRef defines nested fields for UserDefinedFunction.ParentRef. object No - -
signatures An array of function signature. list[object] No - -
status - object Yes - -

Status.expr

Back to UserDefinedFunction status

UserDefinedFunctionExpr defines nested fields for UserDefinedFunction.Expr.

Field Description Type Required Default Enum
configValues UserDefinedFunctionExprConfigValues defines nested fields for UserDefinedFunction.Expr.ConfigValues. object No - -
exprString The expression string for the object. string No - -
key The object key. string No - -
modelType The object type. string No - -
modelVersion The object's model version. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionExprParentRef defines nested fields for UserDefinedFunction.Expr.ParentRef. object No - -

Status.expr.configValues

Back to UserDefinedFunction status

UserDefinedFunctionExprConfigValues defines nested fields for UserDefinedFunction.Expr.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionExprConfigValuesParentRef defines nested fields for UserDefinedFunction.Expr.ConfigValues.ParentRef. object No - -

Status.expr.configValues.configParamValues{}

Back to UserDefinedFunction status

UserDefinedFunctionExprConfigValuesConfigParamValues defines nested fields for UserDefinedFunction.Expr.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Status.expr.configValues.parentRef

Back to UserDefinedFunction status

UserDefinedFunctionExprConfigValuesParentRef defines nested fields for UserDefinedFunction.Expr.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.expr.parentRef

Back to UserDefinedFunction status

UserDefinedFunctionExprParentRef defines nested fields for UserDefinedFunction.Expr.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.metadata

Back to UserDefinedFunction status

UserDefinedFunctionMetadata defines nested fields for UserDefinedFunction.Metadata.

Field Description Type Required Default Enum
aggregator UserDefinedFunctionMetadataAggregator defines nested fields for UserDefinedFunction.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics UserDefinedFunctionMetadataCountStatistics defines nested fields for UserDefinedFunction.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.metadata.aggregator

Back to UserDefinedFunction status

UserDefinedFunctionMetadataAggregator defines nested fields for UserDefinedFunction.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.metadata.countStatistics

Back to UserDefinedFunction status

UserDefinedFunctionMetadataCountStatistics defines nested fields for UserDefinedFunction.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] No - -

Status.metadata.countStatistics.objectTypeCountList[]

Back to UserDefinedFunction status

UserDefinedFunctionMetadataCountStatisticsObjectTypeCountList defines nested fields for UserDefinedFunction.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.parentRef

Back to UserDefinedFunction status

UserDefinedFunctionParentRef defines nested fields for UserDefinedFunction.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.signatures[]

Back to UserDefinedFunction status

UserDefinedFunctionSignature defines nested fields for UserDefinedFunction.Signature.

Field Description Type Required Default Enum
arguments An array of function arguments. list[object] No - -
description Detailed description for the object. string No - -
key The key of the object. string No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureParentRef defines nested fields for UserDefinedFunction.Signature.ParentRef. object No - -
retType UserDefinedFunctionSignatureRetType defines nested fields for UserDefinedFunction.Signature.RetType. object No - -

Status.signatures[].arguments[]

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgument defines nested fields for UserDefinedFunction.Signature.Argument.

Field Description Type Required Default Enum
columnNamePattern column name pattern can be used to generate the name structure of the generated columns. By default column names are of %PIVOT_KEY_VALUE% or %MACRO_INPUT%%PIVOT_KEY_VALUE%, but we can change it something by passing something like MY_PREFIX%PIVOT_KEY_VALUE%MY_SUFFIX or MY_PREFIX%MACRO_INPUT%%PIVOT_KEY_VALUE%MY_SUFFIX which will add custom prefix and suffix to the column name. string No - -
configValues UserDefinedFunctionSignatureArgumentConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.ConfigValues. object No - -
decisionOutputPortType The port based on what decision expression evaluates to. string No - -
defaultValue The default value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
description Detailed description for the object. string No - -
expr UserDefinedFunctionSignatureArgumentExpr defines nested fields for UserDefinedFunction.Signature.Argument.Expr. object No - -
expression The expression string for the object. string No - -
fields An array of fields. list[object (preserves unknown fields)] No - -
isInput Specifies whether the parameter is input value. boolean No - -
isOutput Specifies whether the parameter is output value. boolean No - -
isUseInferredType Specifies whether to use inferred expression output type as output type of the derived field. Default value of this flag is false. boolean No - -
isUseSourceType Specifies whether the type of macro fields is inferred from an expression or useType (false) or the source field (true). boolean No - -
jsonData - string No - -
key The key of the object. string No - -
labels Labels are keywords or labels that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
nativeShapeField UserDefinedFunctionSignatureArgumentNativeShapeField defines nested fields for UserDefinedFunction.Signature.Argument.NativeShapeField. object No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
outputAggregationType The output aggregation type. string No - -
parentRef UserDefinedFunctionSignatureArgumentParentRef defines nested fields for UserDefinedFunction.Signature.Argument.ParentRef. object No - -
portType The port details for the data asset.Type. string No - -
rootObjectDefaultValue The default value of the parameter which can be an object in DIS, such as a data entity. Unknown nested fields are preserved. object (preserves unknown fields) No - -
scope Reference key value to an object within the document. string No - -
scopeReference UserDefinedFunctionSignatureArgumentScopeReference defines nested fields for UserDefinedFunction.Signature.Argument.ScopeReference. object No - -
splitCondition UserDefinedFunctionSignatureArgumentSplitCondition defines nested fields for UserDefinedFunction.Signature.Argument.SplitCondition. object No - -
type UserDefinedFunctionSignatureArgumentType defines nested fields for UserDefinedFunction.Signature.Argument.Type. object No - -
typeName The type of value the parameter was created for. string No - -
useType UserDefinedFunctionSignatureArgumentUseType defines nested fields for UserDefinedFunction.Signature.Argument.UseType. object No - -
usedFor The param name for which parameter is created for for eg. driver Shape, Operation etc. string No - -

Status.signatures[].arguments[].configValues

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionSignatureArgumentConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.ConfigValues.ParentRef. object No - -

Status.signatures[].arguments[].configValues.configParamValues{}

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentConfigValuesConfigParamValues defines nested fields for UserDefinedFunction.Signature.Argument.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Status.signatures[].arguments[].configValues.parentRef

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.signatures[].arguments[].expr

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentExpr defines nested fields for UserDefinedFunction.Signature.Argument.Expr.

Field Description Type Required Default Enum
configValues UserDefinedFunctionSignatureArgumentExprConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.Expr.ConfigValues. object No - -
exprString The expression string for the object. string No - -
key The object key. string No - -
modelType The object type. string No - -
modelVersion The object's model version. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureArgumentExprParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Expr.ParentRef. object No - -

Status.signatures[].arguments[].expr.configValues

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentExprConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.Expr.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionSignatureArgumentExprConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Expr.ConfigValues.ParentRef. object No - -

Status.signatures[].arguments[].expr.configValues.configParamValues{}

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentExprConfigValuesConfigParamValues defines nested fields for UserDefinedFunction.Signature.Argument.Expr.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Status.signatures[].arguments[].expr.configValues.parentRef

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentExprConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Expr.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.signatures[].arguments[].expr.parentRef

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentExprParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Expr.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.signatures[].arguments[].nativeShapeField

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentNativeShapeField defines nested fields for UserDefinedFunction.Signature.Argument.NativeShapeField.

Field Description Type Required Default Enum
configValues UserDefinedFunctionSignatureArgumentNativeShapeFieldConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.NativeShapeField.ConfigValues. object No - -
defaultValueString The default value. string No - -
isMandatory Specifies whether the field is mandatory. boolean No - -
modelType The model type reference. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
position The position of the attribute. integer No - -
type The type reference. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Status.signatures[].arguments[].nativeShapeField.configValues

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentNativeShapeFieldConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.NativeShapeField.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionSignatureArgumentNativeShapeFieldConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.NativeShapeField.ConfigValues.ParentRef. object No - -

Status.signatures[].arguments[].nativeShapeField.configValues.configParamValues{}

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentNativeShapeFieldConfigValuesConfigParamValues defines nested fields for UserDefinedFunction.Signature.Argument.NativeShapeField.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Status.signatures[].arguments[].nativeShapeField.configValues.parentRef

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentNativeShapeFieldConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.NativeShapeField.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.signatures[].arguments[].parentRef

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentParentRef defines nested fields for UserDefinedFunction.Signature.Argument.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.signatures[].arguments[].scopeReference

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentScopeReference defines nested fields for UserDefinedFunction.Signature.Argument.ScopeReference.

Field Description Type Required Default Enum
refObjectName The referenced object name for this reference. Set to the field name if the referenceType is BOUND_ENTITY_SHAPE_FIELD, else set to null. string No - -
referenceObject A key or shallow reference to an object. For direct reference, it points to the actual scope object. For BOUND_ENTITY_SHAPE or BOUND_ENTITY_SHAPE_FIELD, it points to the source or target operator. For OCI_FUNCTION_INPUT_SHAPE or OCI_FUNCTION_OUTPUT_SHAPE, it points to the OCI Function object. string Yes - -
referenceType The reference type for this reference. Set to null for a direct reference, for indirect references set to a type of association such as "BOUND_ENTITY_SHAPE". Current known reference type values are "BOUND_ENTITY_SHAPE", "BOUND_ENTITY_SHAPE_FIELD", "OCI_FUNCTION_INPUT_SHAPE", "OCI_FUNCTION_OUTPUT_SHAPE" string No - -

Status.signatures[].arguments[].splitCondition

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentSplitCondition defines nested fields for UserDefinedFunction.Signature.Argument.SplitCondition.

Field Description Type Required Default Enum
configValues UserDefinedFunctionSignatureArgumentSplitConditionConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.SplitCondition.ConfigValues. object No - -
exprString The expression string for the object. string No - -
key The object key. string No - -
modelType The object type. string No - -
modelVersion The object's model version. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureArgumentSplitConditionParentRef defines nested fields for UserDefinedFunction.Signature.Argument.SplitCondition.ParentRef. object No - -

Status.signatures[].arguments[].splitCondition.configValues

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentSplitConditionConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.SplitCondition.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionSignatureArgumentSplitConditionConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.SplitCondition.ConfigValues.ParentRef. object No - -

Status.signatures[].arguments[].splitCondition.configValues.configParamValues{}

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentSplitConditionConfigValuesConfigParamValues defines nested fields for UserDefinedFunction.Signature.Argument.SplitCondition.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Status.signatures[].arguments[].splitCondition.configValues.parentRef

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentSplitConditionConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.SplitCondition.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.signatures[].arguments[].splitCondition.parentRef

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentSplitConditionParentRef defines nested fields for UserDefinedFunction.Signature.Argument.SplitCondition.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.signatures[].arguments[].type

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentType defines nested fields for UserDefinedFunction.Signature.Argument.Type.

Field Description Type Required Default Enum
configDefinition UserDefinedFunctionSignatureArgumentTypeConfigDefinition defines nested fields for UserDefinedFunction.Signature.Argument.Type.ConfigDefinition. object No - -
configValues UserDefinedFunctionSignatureArgumentTypeConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.Type.ConfigValues. object No - -
containsNull Defines whether null values are allowed. boolean No - -
description A user defined description for the object. string No - -
dtType The data type. string No - -
elementType Seeded type string No - -
elements An array of elements. list[string] No - -
javaTypeName The java type name. string No - -
jsonData - string No - -
key The key of the object. string No - -
keyElementType Seeded type string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureArgumentTypeParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Type.ParentRef. object No - -
pathNames An array of path names corresponding to the elements. The path names are used when referring to the field in an expression. list[string] No - -
typeHandler UserDefinedFunctionSignatureArgumentTypeTypeHandler defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler. object No - -
typeSystemName The data type system name. string No - -
valueElementType Seeded type string No - -
wrappedType A wrapped type, may be a string or a BaseType. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Status.signatures[].arguments[].type.configDefinition

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentTypeConfigDefinition defines nested fields for UserDefinedFunction.Signature.Argument.Type.ConfigDefinition.

Field Description Type Required Default Enum
configParameterDefinitions The parameter configuration details. map[string, object] No - -
isContained Specifies whether the configuration is contained or not. boolean No - -
key The key of the object. string No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureArgumentTypeConfigDefinitionParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Type.ConfigDefinition.ParentRef. object No - -

Status.signatures[].arguments[].type.configDefinition.configParameterDefinitions{}

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentTypeConfigDefinitionConfigParameterDefinitions defines nested fields for UserDefinedFunction.Signature.Argument.Type.ConfigDefinition.ConfigParameterDefinitions.

Field Description Type Required Default Enum
classFieldName The parameter class field name. string No - -
defaultValue The default value for the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
description A user defined description for the object. string No - -
isClassFieldValue Specifies whether the parameter is a class field or not. boolean No - -
isStatic Specifies whether the parameter is static or not. boolean No - -
parameterName This object represents the configurable properties for an object type. string No - -
parameterType JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Status.signatures[].arguments[].type.configDefinition.parentRef

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentTypeConfigDefinitionParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Type.ConfigDefinition.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.signatures[].arguments[].type.configValues

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentTypeConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.Type.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionSignatureArgumentTypeConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Type.ConfigValues.ParentRef. object No - -

Status.signatures[].arguments[].type.configValues.configParamValues{}

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentTypeConfigValuesConfigParamValues defines nested fields for UserDefinedFunction.Signature.Argument.Type.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Status.signatures[].arguments[].type.configValues.parentRef

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentTypeConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Type.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.signatures[].arguments[].type.parentRef

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentTypeParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Type.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.signatures[].arguments[].type.typeHandler

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentTypeTypeHandler defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.

Field Description Type Required Default Enum
configValues UserDefinedFunctionSignatureArgumentTypeTypeHandlerConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ConfigValues. object No - -
flattenDetails Contains a key for referencing the flattenDetails information. string No - -
isOrderByRule Specifies whether it is ordered by rule. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureArgumentTypeTypeHandlerParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ParentRef. object No - -
projectionRules The projection rules. list[object] No - -
scope Reference key for the typed object. string No - -
scopeReference UserDefinedFunctionSignatureArgumentTypeTypeHandlerScopeReference defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ScopeReference. object No - -

Status.signatures[].arguments[].type.typeHandler.configValues

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentTypeTypeHandlerConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionSignatureArgumentTypeTypeHandlerConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ConfigValues.ParentRef. object No - -

Status.signatures[].arguments[].type.typeHandler.configValues.configParamValues{}

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentTypeTypeHandlerConfigValuesConfigParamValues defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Status.signatures[].arguments[].type.typeHandler.configValues.parentRef

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentTypeTypeHandlerConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.signatures[].arguments[].type.typeHandler.parentRef

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentTypeTypeHandlerParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.signatures[].arguments[].type.typeHandler.projectionRules[]

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentTypeTypeHandlerProjectionRule defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ProjectionRule.

Field Description Type Required Default Enum
configValues UserDefinedFunctionSignatureArgumentTypeTypeHandlerProjectionRuleConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ProjectionRule.ConfigValues. object No - -
description A user defined description for the object. string No - -
fromName The attribute name that needs to be renamed. string No - -
isCascade Specifies whether to cascade or not. boolean No - -
isCaseSensitive Specifies if the rule is case sensitive. boolean No - -
isJavaRegexSyntax Specifies whether the rule uses a java regex syntax. boolean No - -
isSkipRemainingRulesOnMatch Specifies whether to skip remaining rules when a match is found. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
matchingStrategy The pattern matching strategy. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Name of the group. string No - -
names Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. list[string] No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureArgumentTypeTypeHandlerProjectionRuleParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ProjectionRule.ParentRef. object No - -
pattern The rule pattern. string No - -
ruleType The rule type. string No - -
scope Reference to a typed object. This can be either a key value to an object within the document, a shall referenced to a TypedObject, or a full TypedObject definition. Unknown nested fields are preserved. object (preserves unknown fields) No - -
toName The new attribute name. string No - -
types An arry of types. list[object (preserves unknown fields)] No - -

Status.signatures[].arguments[].type.typeHandler.projectionRules[].configValues

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentTypeTypeHandlerProjectionRuleConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ProjectionRule.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionSignatureArgumentTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ProjectionRule.ConfigValues.ParentRef. object No - -

Status.signatures[].arguments[].type.typeHandler.projectionRules[].configValues.configParamValues{}

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentTypeTypeHandlerProjectionRuleConfigValuesConfigParamValues defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ProjectionRule.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Status.signatures[].arguments[].type.typeHandler.projectionRules[].configValues.parentRef

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ProjectionRule.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.signatures[].arguments[].type.typeHandler.projectionRules[].parentRef

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentTypeTypeHandlerProjectionRuleParentRef defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ProjectionRule.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.signatures[].arguments[].type.typeHandler.scopeReference

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentTypeTypeHandlerScopeReference defines nested fields for UserDefinedFunction.Signature.Argument.Type.TypeHandler.ScopeReference.

Field Description Type Required Default Enum
refObjectName The referenced object name for this reference. Set to the field name if the referenceType is BOUND_ENTITY_SHAPE_FIELD, else set to null. string No - -
referenceObject A key or shallow reference to an object. For direct reference, it points to the actual scope object. For BOUND_ENTITY_SHAPE or BOUND_ENTITY_SHAPE_FIELD, it points to the source or target operator. For OCI_FUNCTION_INPUT_SHAPE or OCI_FUNCTION_OUTPUT_SHAPE, it points to the OCI Function object. string Yes - -
referenceType The reference type for this reference. Set to null for a direct reference, for indirect references set to a type of association such as "BOUND_ENTITY_SHAPE". Current known reference type values are "BOUND_ENTITY_SHAPE", "BOUND_ENTITY_SHAPE_FIELD", "OCI_FUNCTION_INPUT_SHAPE", "OCI_FUNCTION_OUTPUT_SHAPE" string No - -

Status.signatures[].arguments[].useType

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentUseType defines nested fields for UserDefinedFunction.Signature.Argument.UseType.

Field Description Type Required Default Enum
configDefinition UserDefinedFunctionSignatureArgumentUseTypeConfigDefinition defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition. object No - -
configValues UserDefinedFunctionSignatureArgumentUseTypeConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigValues. object No - -
description A user defined description for the object. string No - -
key The key of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureArgumentUseTypeParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ParentRef. object No - -
wrappedType A wrapped type, may be a string or a BaseType. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Status.signatures[].arguments[].useType.configDefinition

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinition defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.

Field Description Type Required Default Enum
configParameterDefinitions The parameter configuration details. map[string, object] No - -
isContained Specifies whether the configuration is contained or not. boolean No - -
key The key of the object. string No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ParentRef. object No - -

Status.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitions defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.

Field Description Type Required Default Enum
classFieldName The parameter class field name. string No - -
defaultValue The default value for the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
description A user defined description for the object. string No - -
isClassFieldValue Specifies whether the parameter is a class field or not. boolean No - -
isStatic Specifies whether the parameter is static or not. boolean No - -
parameterName This object represents the configurable properties for an object type. string No - -
parameterType UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterType defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType. object No - -

Status.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterType defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.

Field Description Type Required Default Enum
configDefinition JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
configValues UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues. object No - -
containsNull Defines whether null values are allowed. boolean No - -
description A user defined description for the object. string No - -
dtType The data type. string No - -
elementType Seeded type string No - -
elements An array of elements. list[string] No - -
javaTypeName The java type name. string No - -
jsonData - string No - -
key The key of the object. string No - -
keyElementType Seeded type string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ParentRef. object No - -
pathNames An array of path names corresponding to the elements. The path names are used when referring to the field in an expression. list[string] No - -
typeHandler UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandler defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler. object No - -
typeSystemName The data type system name. string No - -
valueElementType Seeded type string No - -
wrappedType A wrapped type, may be a string or a BaseType. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Status.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.configValues

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ParentRef. object No - -

Status.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.configValues.configParamValues{}

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesConfigParamValues defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Status.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.configValues.parentRef

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.parentRef

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandler defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.

Field Description Type Required Default Enum
configValues UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues. object No - -
flattenDetails Contains a key for referencing the flattenDetails information. string No - -
isOrderByRule Specifies whether it is ordered by rule. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ParentRef. object No - -
projectionRules The projection rules. list[object] No - -
scope Reference key for the typed object. string No - -
scopeReference UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerScopeReference defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ScopeReference. object No - -

Status.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ParentRef. object No - -

Status.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues.configParamValues{}

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesConfigParamValues defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Status.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues.parentRef

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.parentRef

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[]

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRule defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.

Field Description Type Required Default Enum
configValues UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues. object No - -
description A user defined description for the object. string No - -
fromName The attribute name that needs to be renamed. string No - -
isCascade Specifies whether to cascade or not. boolean No - -
isCaseSensitive Specifies if the rule is case sensitive. boolean No - -
isJavaRegexSyntax Specifies whether the rule uses a java regex syntax. boolean No - -
isSkipRemainingRulesOnMatch Specifies whether to skip remaining rules when a match is found. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
matchingStrategy The pattern matching strategy. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Name of the group. string No - -
names Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. list[string] No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ParentRef. object No - -
pattern The rule pattern. string No - -
ruleType The rule type. string No - -
scope Reference to a typed object. This can be either a key value to an object within the document, a shall referenced to a TypedObject, or a full TypedObject definition. Unknown nested fields are preserved. object (preserves unknown fields) No - -
toName The new attribute name. string No - -
types An arry of types. list[object (preserves unknown fields)] No - -

Status.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ParentRef. object No - -

Status.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues.configParamValues{}

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesConfigParamValues defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Status.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues.parentRef

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].parentRef

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.scopeReference

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerScopeReference defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ScopeReference.

Field Description Type Required Default Enum
refObjectName The referenced object name for this reference. Set to the field name if the referenceType is BOUND_ENTITY_SHAPE_FIELD, else set to null. string No - -
referenceObject A key or shallow reference to an object. For direct reference, it points to the actual scope object. For BOUND_ENTITY_SHAPE or BOUND_ENTITY_SHAPE_FIELD, it points to the source or target operator. For OCI_FUNCTION_INPUT_SHAPE or OCI_FUNCTION_OUTPUT_SHAPE, it points to the OCI Function object. string Yes - -
referenceType The reference type for this reference. Set to null for a direct reference, for indirect references set to a type of association such as "BOUND_ENTITY_SHAPE". Current known reference type values are "BOUND_ENTITY_SHAPE", "BOUND_ENTITY_SHAPE_FIELD", "OCI_FUNCTION_INPUT_SHAPE", "OCI_FUNCTION_OUTPUT_SHAPE" string No - -

Status.signatures[].arguments[].useType.configDefinition.parentRef

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentUseTypeConfigDefinitionParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigDefinition.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.signatures[].arguments[].useType.configValues

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentUseTypeConfigValues defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionSignatureArgumentUseTypeConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigValues.ParentRef. object No - -

Status.signatures[].arguments[].useType.configValues.configParamValues{}

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentUseTypeConfigValuesConfigParamValues defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Status.signatures[].arguments[].useType.configValues.parentRef

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentUseTypeConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.signatures[].arguments[].useType.parentRef

Back to UserDefinedFunction status

UserDefinedFunctionSignatureArgumentUseTypeParentRef defines nested fields for UserDefinedFunction.Signature.Argument.UseType.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.signatures[].parentRef

Back to UserDefinedFunction status

UserDefinedFunctionSignatureParentRef defines nested fields for UserDefinedFunction.Signature.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.signatures[].retType

Back to UserDefinedFunction status

UserDefinedFunctionSignatureRetType defines nested fields for UserDefinedFunction.Signature.RetType.

Field Description Type Required Default Enum
configDefinition UserDefinedFunctionSignatureRetTypeConfigDefinition defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition. object No - -
configValues UserDefinedFunctionSignatureRetTypeConfigValues defines nested fields for UserDefinedFunction.Signature.RetType.ConfigValues. object No - -
description A user defined description for the object. string No - -
key The key of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureRetTypeParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ParentRef. object No - -
wrappedType A wrapped type, may be a string or a BaseType. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Status.signatures[].retType.configDefinition

Back to UserDefinedFunction status

UserDefinedFunctionSignatureRetTypeConfigDefinition defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.

Field Description Type Required Default Enum
configParameterDefinitions The parameter configuration details. map[string, object] No - -
isContained Specifies whether the configuration is contained or not. boolean No - -
key The key of the object. string No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureRetTypeConfigDefinitionParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ParentRef. object No - -

Status.signatures[].retType.configDefinition.configParameterDefinitions{}

Back to UserDefinedFunction status

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitions defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.

Field Description Type Required Default Enum
classFieldName The parameter class field name. string No - -
defaultValue The default value for the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
description A user defined description for the object. string No - -
isClassFieldValue Specifies whether the parameter is a class field or not. boolean No - -
isStatic Specifies whether the parameter is static or not. boolean No - -
parameterName This object represents the configurable properties for an object type. string No - -
parameterType UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterType defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType. object No - -

Status.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType

Back to UserDefinedFunction status

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterType defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.

Field Description Type Required Default Enum
configDefinition JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
configValues UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValues defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues. object No - -
containsNull Defines whether null values are allowed. boolean No - -
description A user defined description for the object. string No - -
dtType The data type. string No - -
elementType Seeded type string No - -
elements An array of elements. list[string] No - -
javaTypeName The java type name. string No - -
jsonData - string No - -
key The key of the object. string No - -
keyElementType Seeded type string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ParentRef. object No - -
pathNames An array of path names corresponding to the elements. The path names are used when referring to the field in an expression. list[string] No - -
typeHandler UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandler defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler. object No - -
typeSystemName The data type system name. string No - -
valueElementType Seeded type string No - -
wrappedType A wrapped type, may be a string or a BaseType. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Status.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.configValues

Back to UserDefinedFunction status

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValues defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ParentRef. object No - -

Status.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.configValues.configParamValues{}

Back to UserDefinedFunction status

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesConfigParamValues defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Status.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.configValues.parentRef

Back to UserDefinedFunction status

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.parentRef

Back to UserDefinedFunction status

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler

Back to UserDefinedFunction status

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandler defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.

Field Description Type Required Default Enum
configValues UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValues defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues. object No - -
flattenDetails Contains a key for referencing the flattenDetails information. string No - -
isOrderByRule Specifies whether it is ordered by rule. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ParentRef. object No - -
projectionRules The projection rules. list[object] No - -
scope Reference key for the typed object. string No - -
scopeReference UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerScopeReference defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ScopeReference. object No - -

Status.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues

Back to UserDefinedFunction status

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValues defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ParentRef. object No - -

Status.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues.configParamValues{}

Back to UserDefinedFunction status

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesConfigParamValues defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Status.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues.parentRef

Back to UserDefinedFunction status

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.parentRef

Back to UserDefinedFunction status

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[]

Back to UserDefinedFunction status

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRule defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.

Field Description Type Required Default Enum
configValues UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValues defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues. object No - -
description A user defined description for the object. string No - -
fromName The attribute name that needs to be renamed. string No - -
isCascade Specifies whether to cascade or not. boolean No - -
isCaseSensitive Specifies if the rule is case sensitive. boolean No - -
isJavaRegexSyntax Specifies whether the rule uses a java regex syntax. boolean No - -
isSkipRemainingRulesOnMatch Specifies whether to skip remaining rules when a match is found. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
matchingStrategy The pattern matching strategy. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Name of the group. string No - -
names Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. list[string] No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ParentRef. object No - -
pattern The rule pattern. string No - -
ruleType The rule type. string No - -
scope Reference to a typed object. This can be either a key value to an object within the document, a shall referenced to a TypedObject, or a full TypedObject definition. Unknown nested fields are preserved. object (preserves unknown fields) No - -
toName The new attribute name. string No - -
types An arry of types. list[object (preserves unknown fields)] No - -

Status.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues

Back to UserDefinedFunction status

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValues defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ParentRef. object No - -

Status.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues.configParamValues{}

Back to UserDefinedFunction status

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesConfigParamValues defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Status.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues.parentRef

Back to UserDefinedFunction status

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].parentRef

Back to UserDefinedFunction status

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.scopeReference

Back to UserDefinedFunction status

UserDefinedFunctionSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerScopeReference defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ScopeReference.

Field Description Type Required Default Enum
refObjectName The referenced object name for this reference. Set to the field name if the referenceType is BOUND_ENTITY_SHAPE_FIELD, else set to null. string No - -
referenceObject A key or shallow reference to an object. For direct reference, it points to the actual scope object. For BOUND_ENTITY_SHAPE or BOUND_ENTITY_SHAPE_FIELD, it points to the source or target operator. For OCI_FUNCTION_INPUT_SHAPE or OCI_FUNCTION_OUTPUT_SHAPE, it points to the OCI Function object. string Yes - -
referenceType The reference type for this reference. Set to null for a direct reference, for indirect references set to a type of association such as "BOUND_ENTITY_SHAPE". Current known reference type values are "BOUND_ENTITY_SHAPE", "BOUND_ENTITY_SHAPE_FIELD", "OCI_FUNCTION_INPUT_SHAPE", "OCI_FUNCTION_OUTPUT_SHAPE" string No - -

Status.signatures[].retType.configDefinition.parentRef

Back to UserDefinedFunction status

UserDefinedFunctionSignatureRetTypeConfigDefinitionParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ConfigDefinition.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.signatures[].retType.configValues

Back to UserDefinedFunction status

UserDefinedFunctionSignatureRetTypeConfigValues defines nested fields for UserDefinedFunction.Signature.RetType.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionSignatureRetTypeConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ConfigValues.ParentRef. object No - -

Status.signatures[].retType.configValues.configParamValues{}

Back to UserDefinedFunction status

UserDefinedFunctionSignatureRetTypeConfigValuesConfigParamValues defines nested fields for UserDefinedFunction.Signature.RetType.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Status.signatures[].retType.configValues.parentRef

Back to UserDefinedFunction status

UserDefinedFunctionSignatureRetTypeConfigValuesParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.signatures[].retType.parentRef

Back to UserDefinedFunction status

UserDefinedFunctionSignatureRetTypeParentRef defines nested fields for UserDefinedFunction.Signature.RetType.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.status

Back to UserDefinedFunction 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

Back to UserDefinedFunction status

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

Back to UserDefinedFunction status

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[]

Back to UserDefinedFunction status

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

UserDefinedFunctionValidation

UserDefinedFunctionValidation is the Schema for the userdefinedfunctionvalidations API.

  • Plural: userdefinedfunctionvalidations
  • Scope: Namespaced
  • APIVersion: dataintegration.oracle.com/v1beta1
  • Sample: Sample (config/samples/dataintegration_v1beta1_userdefinedfunctionvalidation.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

UserDefinedFunctionValidationSpec defines the desired state of UserDefinedFunctionValidation.

Field Description Type Required Default Enum
description Detailed description for the object. string No - -
expr UserDefinedFunctionValidationExpr defines nested fields for UserDefinedFunctionValidation.Expr. object No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
key Generated key that can be used in API calls to identify user defined function. On scenarios where reference to the user defined function is needed, a value can be passed in create. string No - -
keyMap A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. map[string, string] No - -
metadata UserDefinedFunctionValidationMetadata defines nested fields for UserDefinedFunctionValidation.Metadata. object No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef UserDefinedFunctionValidationParentRef defines nested fields for UserDefinedFunctionValidation.ParentRef. object No - -
signatures An array of function signature. list[object] No - -

Spec.expr

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationExpr defines nested fields for UserDefinedFunctionValidation.Expr.

Field Description Type Required Default Enum
configValues UserDefinedFunctionValidationExprConfigValues defines nested fields for UserDefinedFunctionValidation.Expr.ConfigValues. object No - -
exprString The expression string for the object. string No - -
key The object key. string No - -
modelType The object type. string No - -
modelVersion The object's model version. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionValidationExprParentRef defines nested fields for UserDefinedFunctionValidation.Expr.ParentRef. object No - -

Spec.expr.configValues

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationExprConfigValues defines nested fields for UserDefinedFunctionValidation.Expr.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionValidationExprConfigValuesParentRef defines nested fields for UserDefinedFunctionValidation.Expr.ConfigValues.ParentRef. object No - -

Spec.expr.configValues.configParamValues{}

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationExprConfigValuesConfigParamValues defines nested fields for UserDefinedFunctionValidation.Expr.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.expr.configValues.parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationExprConfigValuesParentRef defines nested fields for UserDefinedFunctionValidation.Expr.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.expr.parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationExprParentRef defines nested fields for UserDefinedFunctionValidation.Expr.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.metadata

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationMetadata defines nested fields for UserDefinedFunctionValidation.Metadata.

Field Description Type Required Default Enum
aggregator UserDefinedFunctionValidationMetadataAggregator defines nested fields for UserDefinedFunctionValidation.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics UserDefinedFunctionValidationMetadataCountStatistics defines nested fields for UserDefinedFunctionValidation.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Spec.metadata.aggregator

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationMetadataAggregator defines nested fields for UserDefinedFunctionValidation.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Spec.metadata.countStatistics

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationMetadataCountStatistics defines nested fields for UserDefinedFunctionValidation.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Spec.metadata.countStatistics.objectTypeCountList[]

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationMetadataCountStatisticsObjectTypeCountList defines nested fields for UserDefinedFunctionValidation.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Spec.parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationParentRef defines nested fields for UserDefinedFunctionValidation.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[]

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignature defines nested fields for UserDefinedFunctionValidation.Signature.

Field Description Type Required Default Enum
arguments An array of function arguments. list[object] No - -
description Detailed description for the object. string No - -
key The key of the object. string No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionValidationSignatureParentRef defines nested fields for UserDefinedFunctionValidation.Signature.ParentRef. object No - -
retType UserDefinedFunctionValidationSignatureRetType defines nested fields for UserDefinedFunctionValidation.Signature.RetType. object No - -

Spec.signatures[].arguments[]

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgument defines nested fields for UserDefinedFunctionValidation.Signature.Argument.

Field Description Type Required Default Enum
columnNamePattern column name pattern can be used to generate the name structure of the generated columns. By default column names are of %PIVOT_KEY_VALUE% or %MACRO_INPUT%%PIVOT_KEY_VALUE%, but we can change it something by passing something like MY_PREFIX%PIVOT_KEY_VALUE%MY_SUFFIX or MY_PREFIX%MACRO_INPUT%%PIVOT_KEY_VALUE%MY_SUFFIX which will add custom prefix and suffix to the column name. string No - -
configValues UserDefinedFunctionValidationSignatureArgumentConfigValues defines nested fields for UserDefinedFunctionValidation.Signature.Argument.ConfigValues. object No - -
decisionOutputPortType The port based on what decision expression evaluates to. string No - -
defaultValue The default value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
description Detailed description for the object. string No - -
expr UserDefinedFunctionValidationSignatureArgumentExpr defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Expr. object No - -
expression The expression string for the object. string No - -
fields An array of fields. list[object (preserves unknown fields)] No - -
isInput Specifies whether the parameter is input value. boolean No - -
isOutput Specifies whether the parameter is output value. boolean No - -
isUseInferredType Specifies whether to use inferred expression output type as output type of the derived field. Default value of this flag is false. boolean No - -
isUseSourceType Specifies whether the type of macro fields is inferred from an expression or useType (false) or the source field (true). boolean No - -
jsonData - string No - -
key The key of the object. string No - -
labels Labels are keywords or labels that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
nativeShapeField UserDefinedFunctionValidationSignatureArgumentNativeShapeField defines nested fields for UserDefinedFunctionValidation.Signature.Argument.NativeShapeField. object No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
outputAggregationType The output aggregation type. string No - -
parentRef UserDefinedFunctionValidationSignatureArgumentParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.ParentRef. object No - -
portType The port details for the data asset.Type. string No - -
rootObjectDefaultValue The default value of the parameter which can be an object in DIS, such as a data entity. Unknown nested fields are preserved. object (preserves unknown fields) No - -
scope Reference key value to an object within the document. string No - -
scopeReference UserDefinedFunctionValidationSignatureArgumentScopeReference defines nested fields for UserDefinedFunctionValidation.Signature.Argument.ScopeReference. object No - -
splitCondition UserDefinedFunctionValidationSignatureArgumentSplitCondition defines nested fields for UserDefinedFunctionValidation.Signature.Argument.SplitCondition. object No - -
type UserDefinedFunctionValidationSignatureArgumentType defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Type. object No - -
typeName The type of value the parameter was created for. string No - -
useType UserDefinedFunctionValidationSignatureArgumentUseType defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType. object No - -
usedFor The param name for which parameter is created for for eg. driver Shape, Operation etc. string No - -

Spec.signatures[].arguments[].configValues

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentConfigValues defines nested fields for UserDefinedFunctionValidation.Signature.Argument.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionValidationSignatureArgumentConfigValuesParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.ConfigValues.ParentRef. object No - -

Spec.signatures[].arguments[].configValues.configParamValues{}

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentConfigValuesConfigParamValues defines nested fields for UserDefinedFunctionValidation.Signature.Argument.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.signatures[].arguments[].configValues.parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentConfigValuesParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].expr

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentExpr defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Expr.

Field Description Type Required Default Enum
configValues UserDefinedFunctionValidationSignatureArgumentExprConfigValues defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Expr.ConfigValues. object No - -
exprString The expression string for the object. string No - -
key The object key. string No - -
modelType The object type. string No - -
modelVersion The object's model version. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionValidationSignatureArgumentExprParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Expr.ParentRef. object No - -

Spec.signatures[].arguments[].expr.configValues

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentExprConfigValues defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Expr.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionValidationSignatureArgumentExprConfigValuesParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Expr.ConfigValues.ParentRef. object No - -

Spec.signatures[].arguments[].expr.configValues.configParamValues{}

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentExprConfigValuesConfigParamValues defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Expr.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.signatures[].arguments[].expr.configValues.parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentExprConfigValuesParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Expr.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].expr.parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentExprParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Expr.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].nativeShapeField

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentNativeShapeField defines nested fields for UserDefinedFunctionValidation.Signature.Argument.NativeShapeField.

Field Description Type Required Default Enum
configValues UserDefinedFunctionValidationSignatureArgumentNativeShapeFieldConfigValues defines nested fields for UserDefinedFunctionValidation.Signature.Argument.NativeShapeField.ConfigValues. object No - -
defaultValueString The default value. string No - -
isMandatory Specifies whether the field is mandatory. boolean No - -
modelType The model type reference. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
position The position of the attribute. integer No - -
type The type reference. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Spec.signatures[].arguments[].nativeShapeField.configValues

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentNativeShapeFieldConfigValues defines nested fields for UserDefinedFunctionValidation.Signature.Argument.NativeShapeField.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionValidationSignatureArgumentNativeShapeFieldConfigValuesParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.NativeShapeField.ConfigValues.ParentRef. object No - -

Spec.signatures[].arguments[].nativeShapeField.configValues.configParamValues{}

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentNativeShapeFieldConfigValuesConfigParamValues defines nested fields for UserDefinedFunctionValidation.Signature.Argument.NativeShapeField.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.signatures[].arguments[].nativeShapeField.configValues.parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentNativeShapeFieldConfigValuesParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.NativeShapeField.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].scopeReference

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentScopeReference defines nested fields for UserDefinedFunctionValidation.Signature.Argument.ScopeReference.

Field Description Type Required Default Enum
refObjectName The referenced object name for this reference. Set to the field name if the referenceType is BOUND_ENTITY_SHAPE_FIELD, else set to null. string No - -
referenceObject A key or shallow reference to an object. For direct reference, it points to the actual scope object. For BOUND_ENTITY_SHAPE or BOUND_ENTITY_SHAPE_FIELD, it points to the source or target operator. For OCI_FUNCTION_INPUT_SHAPE or OCI_FUNCTION_OUTPUT_SHAPE, it points to the OCI Function object. string Yes - -
referenceType The reference type for this reference. Set to null for a direct reference, for indirect references set to a type of association such as "BOUND_ENTITY_SHAPE". Current known reference type values are "BOUND_ENTITY_SHAPE", "BOUND_ENTITY_SHAPE_FIELD", "OCI_FUNCTION_INPUT_SHAPE", "OCI_FUNCTION_OUTPUT_SHAPE" string No - -

Spec.signatures[].arguments[].splitCondition

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentSplitCondition defines nested fields for UserDefinedFunctionValidation.Signature.Argument.SplitCondition.

Field Description Type Required Default Enum
configValues UserDefinedFunctionValidationSignatureArgumentSplitConditionConfigValues defines nested fields for UserDefinedFunctionValidation.Signature.Argument.SplitCondition.ConfigValues. object No - -
exprString The expression string for the object. string No - -
key The object key. string No - -
modelType The object type. string No - -
modelVersion The object's model version. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionValidationSignatureArgumentSplitConditionParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.SplitCondition.ParentRef. object No - -

Spec.signatures[].arguments[].splitCondition.configValues

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentSplitConditionConfigValues defines nested fields for UserDefinedFunctionValidation.Signature.Argument.SplitCondition.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionValidationSignatureArgumentSplitConditionConfigValuesParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.SplitCondition.ConfigValues.ParentRef. object No - -

Spec.signatures[].arguments[].splitCondition.configValues.configParamValues{}

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentSplitConditionConfigValuesConfigParamValues defines nested fields for UserDefinedFunctionValidation.Signature.Argument.SplitCondition.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.signatures[].arguments[].splitCondition.configValues.parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentSplitConditionConfigValuesParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.SplitCondition.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].splitCondition.parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentSplitConditionParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.SplitCondition.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].type

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentType defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Type.

Field Description Type Required Default Enum
configDefinition UserDefinedFunctionValidationSignatureArgumentTypeConfigDefinition defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Type.ConfigDefinition. object No - -
configValues UserDefinedFunctionValidationSignatureArgumentTypeConfigValues defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Type.ConfigValues. object No - -
containsNull Defines whether null values are allowed. boolean No - -
description A user defined description for the object. string No - -
dtType The data type. string No - -
elementType Seeded type string No - -
elements An array of elements. list[string] No - -
javaTypeName The java type name. string No - -
jsonData - string No - -
key The key of the object. string No - -
keyElementType Seeded type string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionValidationSignatureArgumentTypeParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Type.ParentRef. object No - -
pathNames An array of path names corresponding to the elements. The path names are used when referring to the field in an expression. list[string] No - -
typeHandler UserDefinedFunctionValidationSignatureArgumentTypeTypeHandler defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Type.TypeHandler. object No - -
typeSystemName The data type system name. string No - -
valueElementType Seeded type string No - -
wrappedType A wrapped type, may be a string or a BaseType. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Spec.signatures[].arguments[].type.configDefinition

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentTypeConfigDefinition defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Type.ConfigDefinition.

Field Description Type Required Default Enum
configParameterDefinitions The parameter configuration details. map[string, object] No - -
isContained Specifies whether the configuration is contained or not. boolean No - -
key The key of the object. string No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionValidationSignatureArgumentTypeConfigDefinitionParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Type.ConfigDefinition.ParentRef. object No - -

Spec.signatures[].arguments[].type.configDefinition.configParameterDefinitions{}

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentTypeConfigDefinitionConfigParameterDefinitions defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Type.ConfigDefinition.ConfigParameterDefinitions.

Field Description Type Required Default Enum
classFieldName The parameter class field name. string No - -
defaultValue The default value for the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
description A user defined description for the object. string No - -
isClassFieldValue Specifies whether the parameter is a class field or not. boolean No - -
isStatic Specifies whether the parameter is static or not. boolean No - -
parameterName This object represents the configurable properties for an object type. string No - -
parameterType JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Spec.signatures[].arguments[].type.configDefinition.parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentTypeConfigDefinitionParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Type.ConfigDefinition.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].type.configValues

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentTypeConfigValues defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Type.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionValidationSignatureArgumentTypeConfigValuesParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Type.ConfigValues.ParentRef. object No - -

Spec.signatures[].arguments[].type.configValues.configParamValues{}

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentTypeConfigValuesConfigParamValues defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Type.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.signatures[].arguments[].type.configValues.parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentTypeConfigValuesParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Type.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].type.parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentTypeParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Type.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].type.typeHandler

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentTypeTypeHandler defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Type.TypeHandler.

Field Description Type Required Default Enum
configValues UserDefinedFunctionValidationSignatureArgumentTypeTypeHandlerConfigValues defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Type.TypeHandler.ConfigValues. object No - -
flattenDetails Contains a key for referencing the flattenDetails information. string No - -
isOrderByRule Specifies whether it is ordered by rule. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionValidationSignatureArgumentTypeTypeHandlerParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Type.TypeHandler.ParentRef. object No - -
projectionRules The projection rules. list[object] No - -
scope Reference key for the typed object. string No - -
scopeReference UserDefinedFunctionValidationSignatureArgumentTypeTypeHandlerScopeReference defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Type.TypeHandler.ScopeReference. object No - -

Spec.signatures[].arguments[].type.typeHandler.configValues

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentTypeTypeHandlerConfigValues defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Type.TypeHandler.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionValidationSignatureArgumentTypeTypeHandlerConfigValuesParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Type.TypeHandler.ConfigValues.ParentRef. object No - -

Spec.signatures[].arguments[].type.typeHandler.configValues.configParamValues{}

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentTypeTypeHandlerConfigValuesConfigParamValues defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Type.TypeHandler.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.signatures[].arguments[].type.typeHandler.configValues.parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentTypeTypeHandlerConfigValuesParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Type.TypeHandler.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].type.typeHandler.parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentTypeTypeHandlerParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Type.TypeHandler.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].type.typeHandler.projectionRules[]

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentTypeTypeHandlerProjectionRule defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Type.TypeHandler.ProjectionRule.

Field Description Type Required Default Enum
configValues UserDefinedFunctionValidationSignatureArgumentTypeTypeHandlerProjectionRuleConfigValues defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Type.TypeHandler.ProjectionRule.ConfigValues. object No - -
description A user defined description for the object. string No - -
fromName The attribute name that needs to be renamed. string No - -
isCascade Specifies whether to cascade or not. boolean No - -
isCaseSensitive Specifies if the rule is case sensitive. boolean No - -
isJavaRegexSyntax Specifies whether the rule uses a java regex syntax. boolean No - -
isSkipRemainingRulesOnMatch Specifies whether to skip remaining rules when a match is found. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
matchingStrategy The pattern matching strategy. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Name of the group. string No - -
names Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. list[string] No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionValidationSignatureArgumentTypeTypeHandlerProjectionRuleParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Type.TypeHandler.ProjectionRule.ParentRef. object No - -
pattern The rule pattern. string No - -
ruleType The rule type. string No - -
scope Reference to a typed object. This can be either a key value to an object within the document, a shall referenced to a TypedObject, or a full TypedObject definition. Unknown nested fields are preserved. object (preserves unknown fields) No - -
toName The new attribute name. string No - -
types An arry of types. list[object (preserves unknown fields)] No - -

Spec.signatures[].arguments[].type.typeHandler.projectionRules[].configValues

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentTypeTypeHandlerProjectionRuleConfigValues defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Type.TypeHandler.ProjectionRule.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionValidationSignatureArgumentTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Type.TypeHandler.ProjectionRule.ConfigValues.ParentRef. object No - -

Spec.signatures[].arguments[].type.typeHandler.projectionRules[].configValues.configParamValues{}

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentTypeTypeHandlerProjectionRuleConfigValuesConfigParamValues defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Type.TypeHandler.ProjectionRule.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.signatures[].arguments[].type.typeHandler.projectionRules[].configValues.parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Type.TypeHandler.ProjectionRule.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].type.typeHandler.projectionRules[].parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentTypeTypeHandlerProjectionRuleParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Type.TypeHandler.ProjectionRule.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].type.typeHandler.scopeReference

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentTypeTypeHandlerScopeReference defines nested fields for UserDefinedFunctionValidation.Signature.Argument.Type.TypeHandler.ScopeReference.

Field Description Type Required Default Enum
refObjectName The referenced object name for this reference. Set to the field name if the referenceType is BOUND_ENTITY_SHAPE_FIELD, else set to null. string No - -
referenceObject A key or shallow reference to an object. For direct reference, it points to the actual scope object. For BOUND_ENTITY_SHAPE or BOUND_ENTITY_SHAPE_FIELD, it points to the source or target operator. For OCI_FUNCTION_INPUT_SHAPE or OCI_FUNCTION_OUTPUT_SHAPE, it points to the OCI Function object. string Yes - -
referenceType The reference type for this reference. Set to null for a direct reference, for indirect references set to a type of association such as "BOUND_ENTITY_SHAPE". Current known reference type values are "BOUND_ENTITY_SHAPE", "BOUND_ENTITY_SHAPE_FIELD", "OCI_FUNCTION_INPUT_SHAPE", "OCI_FUNCTION_OUTPUT_SHAPE" string No - -

Spec.signatures[].arguments[].useType

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentUseType defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.

Field Description Type Required Default Enum
configDefinition UserDefinedFunctionValidationSignatureArgumentUseTypeConfigDefinition defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigDefinition. object No - -
configValues UserDefinedFunctionValidationSignatureArgumentUseTypeConfigValues defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigValues. object No - -
description A user defined description for the object. string No - -
key The key of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionValidationSignatureArgumentUseTypeParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ParentRef. object No - -
wrappedType A wrapped type, may be a string or a BaseType. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Spec.signatures[].arguments[].useType.configDefinition

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentUseTypeConfigDefinition defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigDefinition.

Field Description Type Required Default Enum
configParameterDefinitions The parameter configuration details. map[string, object] No - -
isContained Specifies whether the configuration is contained or not. boolean No - -
key The key of the object. string No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionValidationSignatureArgumentUseTypeConfigDefinitionParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigDefinition.ParentRef. object No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitions defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.

Field Description Type Required Default Enum
classFieldName The parameter class field name. string No - -
defaultValue The default value for the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
description A user defined description for the object. string No - -
isClassFieldValue Specifies whether the parameter is a class field or not. boolean No - -
isStatic Specifies whether the parameter is static or not. boolean No - -
parameterName This object represents the configurable properties for an object type. string No - -
parameterType UserDefinedFunctionValidationSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterType defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType. object No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterType defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.

Field Description Type Required Default Enum
configDefinition JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
configValues UserDefinedFunctionValidationSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValues defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues. object No - -
containsNull Defines whether null values are allowed. boolean No - -
description A user defined description for the object. string No - -
dtType The data type. string No - -
elementType Seeded type string No - -
elements An array of elements. list[string] No - -
javaTypeName The java type name. string No - -
jsonData - string No - -
key The key of the object. string No - -
keyElementType Seeded type string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionValidationSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ParentRef. object No - -
pathNames An array of path names corresponding to the elements. The path names are used when referring to the field in an expression. list[string] No - -
typeHandler UserDefinedFunctionValidationSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandler defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler. object No - -
typeSystemName The data type system name. string No - -
valueElementType Seeded type string No - -
wrappedType A wrapped type, may be a string or a BaseType. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.configValues

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValues defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionValidationSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ParentRef. object No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.configValues.configParamValues{}

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesConfigParamValues defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.configValues.parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandler defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.

Field Description Type Required Default Enum
configValues UserDefinedFunctionValidationSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValues defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues. object No - -
flattenDetails Contains a key for referencing the flattenDetails information. string No - -
isOrderByRule Specifies whether it is ordered by rule. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionValidationSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ParentRef. object No - -
projectionRules The projection rules. list[object] No - -
scope Reference key for the typed object. string No - -
scopeReference UserDefinedFunctionValidationSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerScopeReference defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ScopeReference. object No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValues defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionValidationSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ParentRef. object No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues.configParamValues{}

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesConfigParamValues defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues.parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[]

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRule defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.

Field Description Type Required Default Enum
configValues UserDefinedFunctionValidationSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValues defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues. object No - -
description A user defined description for the object. string No - -
fromName The attribute name that needs to be renamed. string No - -
isCascade Specifies whether to cascade or not. boolean No - -
isCaseSensitive Specifies if the rule is case sensitive. boolean No - -
isJavaRegexSyntax Specifies whether the rule uses a java regex syntax. boolean No - -
isSkipRemainingRulesOnMatch Specifies whether to skip remaining rules when a match is found. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
matchingStrategy The pattern matching strategy. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Name of the group. string No - -
names Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. list[string] No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionValidationSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ParentRef. object No - -
pattern The rule pattern. string No - -
ruleType The rule type. string No - -
scope Reference to a typed object. This can be either a key value to an object within the document, a shall referenced to a TypedObject, or a full TypedObject definition. Unknown nested fields are preserved. object (preserves unknown fields) No - -
toName The new attribute name. string No - -
types An arry of types. list[object (preserves unknown fields)] No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValues defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionValidationSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ParentRef. object No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues.configParamValues{}

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesConfigParamValues defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues.parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].useType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.scopeReference

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentUseTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerScopeReference defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ScopeReference.

Field Description Type Required Default Enum
refObjectName The referenced object name for this reference. Set to the field name if the referenceType is BOUND_ENTITY_SHAPE_FIELD, else set to null. string No - -
referenceObject A key or shallow reference to an object. For direct reference, it points to the actual scope object. For BOUND_ENTITY_SHAPE or BOUND_ENTITY_SHAPE_FIELD, it points to the source or target operator. For OCI_FUNCTION_INPUT_SHAPE or OCI_FUNCTION_OUTPUT_SHAPE, it points to the OCI Function object. string Yes - -
referenceType The reference type for this reference. Set to null for a direct reference, for indirect references set to a type of association such as "BOUND_ENTITY_SHAPE". Current known reference type values are "BOUND_ENTITY_SHAPE", "BOUND_ENTITY_SHAPE_FIELD", "OCI_FUNCTION_INPUT_SHAPE", "OCI_FUNCTION_OUTPUT_SHAPE" string No - -

Spec.signatures[].arguments[].useType.configDefinition.parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentUseTypeConfigDefinitionParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigDefinition.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].useType.configValues

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentUseTypeConfigValues defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionValidationSignatureArgumentUseTypeConfigValuesParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigValues.ParentRef. object No - -

Spec.signatures[].arguments[].useType.configValues.configParamValues{}

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentUseTypeConfigValuesConfigParamValues defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.signatures[].arguments[].useType.configValues.parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentUseTypeConfigValuesParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].arguments[].useType.parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureArgumentUseTypeParentRef defines nested fields for UserDefinedFunctionValidation.Signature.Argument.UseType.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureParentRef defines nested fields for UserDefinedFunctionValidation.Signature.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].retType

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureRetType defines nested fields for UserDefinedFunctionValidation.Signature.RetType.

Field Description Type Required Default Enum
configDefinition UserDefinedFunctionValidationSignatureRetTypeConfigDefinition defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigDefinition. object No - -
configValues UserDefinedFunctionValidationSignatureRetTypeConfigValues defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigValues. object No - -
description A user defined description for the object. string No - -
key The key of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionValidationSignatureRetTypeParentRef defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ParentRef. object No - -
wrappedType A wrapped type, may be a string or a BaseType. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Spec.signatures[].retType.configDefinition

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureRetTypeConfigDefinition defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigDefinition.

Field Description Type Required Default Enum
configParameterDefinitions The parameter configuration details. map[string, object] No - -
isContained Specifies whether the configuration is contained or not. boolean No - -
key The key of the object. string No - -
modelType The type of the object. string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionValidationSignatureRetTypeConfigDefinitionParentRef defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigDefinition.ParentRef. object No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureRetTypeConfigDefinitionConfigParameterDefinitions defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.

Field Description Type Required Default Enum
classFieldName The parameter class field name. string No - -
defaultValue The default value for the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
description A user defined description for the object. string No - -
isClassFieldValue Specifies whether the parameter is a class field or not. boolean No - -
isStatic Specifies whether the parameter is static or not. boolean No - -
parameterName This object represents the configurable properties for an object type. string No - -
parameterType UserDefinedFunctionValidationSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterType defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType. object No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterType defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.

Field Description Type Required Default Enum
configDefinition JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
configValues UserDefinedFunctionValidationSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValues defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues. object No - -
containsNull Defines whether null values are allowed. boolean No - -
description A user defined description for the object. string No - -
dtType The data type. string No - -
elementType Seeded type string No - -
elements An array of elements. list[string] No - -
javaTypeName The java type name. string No - -
jsonData - string No - -
key The key of the object. string No - -
keyElementType Seeded type string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionValidationSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeParentRef defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ParentRef. object No - -
pathNames An array of path names corresponding to the elements. The path names are used when referring to the field in an expression. list[string] No - -
typeHandler UserDefinedFunctionValidationSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandler defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler. object No - -
typeSystemName The data type system name. string No - -
valueElementType Seeded type string No - -
wrappedType A wrapped type, may be a string or a BaseType. Unknown nested fields are preserved. object (preserves unknown fields) No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.configValues

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValues defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionValidationSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesParentRef defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ParentRef. object No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.configValues.configParamValues{}

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesConfigParamValues defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.configValues.parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeConfigValuesParentRef defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeParentRef defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandler defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.

Field Description Type Required Default Enum
configValues UserDefinedFunctionValidationSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValues defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues. object No - -
flattenDetails Contains a key for referencing the flattenDetails information. string No - -
isOrderByRule Specifies whether it is ordered by rule. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionValidationSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerParentRef defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ParentRef. object No - -
projectionRules The projection rules. list[object] No - -
scope Reference key for the typed object. string No - -
scopeReference UserDefinedFunctionValidationSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerScopeReference defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ScopeReference. object No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValues defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionValidationSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesParentRef defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ParentRef. object No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues.configParamValues{}

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesConfigParamValues defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.configValues.parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerConfigValuesParentRef defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerParentRef defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[]

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRule defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.

Field Description Type Required Default Enum
configValues UserDefinedFunctionValidationSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValues defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues. object No - -
description A user defined description for the object. string No - -
fromName The attribute name that needs to be renamed. string No - -
isCascade Specifies whether to cascade or not. boolean No - -
isCaseSensitive Specifies if the rule is case sensitive. boolean No - -
isJavaRegexSyntax Specifies whether the rule uses a java regex syntax. boolean No - -
isSkipRemainingRulesOnMatch Specifies whether to skip remaining rules when a match is found. boolean No - -
jsonData - string No - -
key The key of the object. string No - -
matchingStrategy The pattern matching strategy. string No - -
modelType - string No - -
modelVersion The model version of an object. string No - -
name Name of the group. string No - -
names Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. list[string] No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
parentRef UserDefinedFunctionValidationSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleParentRef defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ParentRef. object No - -
pattern The rule pattern. string No - -
ruleType The rule type. string No - -
scope Reference to a typed object. This can be either a key value to an object within the document, a shall referenced to a TypedObject, or a full TypedObject definition. Unknown nested fields are preserved. object (preserves unknown fields) No - -
toName The new attribute name. string No - -
types An arry of types. list[object (preserves unknown fields)] No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValues defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionValidationSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ParentRef. object No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues.configParamValues{}

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesConfigParamValues defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].configValues.parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleConfigValuesParentRef defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.projectionRules[].parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerProjectionRuleParentRef defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ProjectionRule.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].retType.configDefinition.configParameterDefinitions{}.parameterType.typeHandler.scopeReference

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureRetTypeConfigDefinitionConfigParameterDefinitionsParameterTypeTypeHandlerScopeReference defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigDefinition.ConfigParameterDefinitions.ParameterType.TypeHandler.ScopeReference.

Field Description Type Required Default Enum
refObjectName The referenced object name for this reference. Set to the field name if the referenceType is BOUND_ENTITY_SHAPE_FIELD, else set to null. string No - -
referenceObject A key or shallow reference to an object. For direct reference, it points to the actual scope object. For BOUND_ENTITY_SHAPE or BOUND_ENTITY_SHAPE_FIELD, it points to the source or target operator. For OCI_FUNCTION_INPUT_SHAPE or OCI_FUNCTION_OUTPUT_SHAPE, it points to the OCI Function object. string Yes - -
referenceType The reference type for this reference. Set to null for a direct reference, for indirect references set to a type of association such as "BOUND_ENTITY_SHAPE". Current known reference type values are "BOUND_ENTITY_SHAPE", "BOUND_ENTITY_SHAPE_FIELD", "OCI_FUNCTION_INPUT_SHAPE", "OCI_FUNCTION_OUTPUT_SHAPE" string No - -

Spec.signatures[].retType.configDefinition.parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureRetTypeConfigDefinitionParentRef defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigDefinition.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].retType.configValues

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureRetTypeConfigValues defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigValues.

Field Description Type Required Default Enum
configParamValues The configuration parameter values. map[string, object] No - -
parentRef UserDefinedFunctionValidationSignatureRetTypeConfigValuesParentRef defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigValues.ParentRef. object No - -

Spec.signatures[].retType.configValues.configParamValues{}

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureRetTypeConfigValuesConfigParamValues defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigValues.ConfigParamValues.

Field Description Type Required Default Enum
intValue An integer value of the parameter. integer No - -
objectValue An object value of the parameter. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parameterValue Reference to the parameter by its key. string No - -
refValue The root object reference value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
rootObjectValue The root object value, used in custom parameters. Unknown nested fields are preserved. object (preserves unknown fields) No - -
stringValue A string value of the parameter. string No - -

Spec.signatures[].retType.configValues.parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureRetTypeConfigValuesParentRef defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ConfigValues.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Spec.signatures[].retType.parentRef

Back to UserDefinedFunctionValidation spec

UserDefinedFunctionValidationSignatureRetTypeParentRef defines nested fields for UserDefinedFunctionValidation.Signature.RetType.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status

UserDefinedFunctionValidationStatus defines the observed state of UserDefinedFunctionValidation.

Field Description Type Required Default Enum
description Detailed description for the object. string No - -
errorMessageCount The total number of validation error messages. integer No - -
identifier Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. string No - -
infoMessageCount The total number of validation information messages. integer No - -
key Objects will use a 36 character key as unique ID. It is system generated and cannot be modified. string No - -
metadata UserDefinedFunctionValidationMetadata defines nested fields for UserDefinedFunctionValidation.Metadata. object No - -
modelType The type of the object. string No - -
modelVersion The model version of the object. string No - -
name Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. string No - -
objectStatus The status of an object that can be set to value 1 for shallow references across objects, other values reserved. integer No - -
objectVersion The version of the object that is used to track changes in the object instance. integer No - -
parentRef UserDefinedFunctionValidationParentRef defines nested fields for UserDefinedFunctionValidation.ParentRef. object No - -
status - object Yes - -
totalMessageCount The total number of validation messages. integer No - -
validationMessages The detailed information of the UserDefinedFunction object validation. map[string, list[object]] No - -
warnMessageCount The total number of validation warning messages. integer No - -

Status.metadata

Back to UserDefinedFunctionValidation status

UserDefinedFunctionValidationMetadata defines nested fields for UserDefinedFunctionValidation.Metadata.

Field Description Type Required Default Enum
aggregator UserDefinedFunctionValidationMetadataAggregator defines nested fields for UserDefinedFunctionValidation.Metadata.Aggregator. object No - -
aggregatorKey The owning object key for this object. string No - -
countStatistics UserDefinedFunctionValidationMetadataCountStatistics defines nested fields for UserDefinedFunctionValidation.Metadata.CountStatistics. object No - -
createdBy The user that created the object. string No - -
createdByName The user that created the object. string No - -
identifierPath The full path to identify this object. string No - -
infoFields Information property fields. map[string, string] No - -
isFavorite Specifies whether this object is a favorite or not. boolean No - -
labels Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. list[string] No - -
registryVersion The registry version of the object. integer No - -
timeCreated The date and time that the object was created. string No - -
timeUpdated The date and time that the object was updated. string No - -
updatedBy The user that updated the object. string No - -
updatedByName The user that updated the object. string No - -

Status.metadata.aggregator

Back to UserDefinedFunctionValidation status

UserDefinedFunctionValidationMetadataAggregator defines nested fields for UserDefinedFunctionValidation.Metadata.Aggregator.

Field Description Type Required Default Enum
description The description of the aggregator. string No - -
identifier The identifier of the aggregator. string No - -
key The key of the aggregator object. string No - -
name The name of the aggregator. string No - -
type The type of the aggregator. string No - -

Status.metadata.countStatistics

Back to UserDefinedFunctionValidation status

UserDefinedFunctionValidationMetadataCountStatistics defines nested fields for UserDefinedFunctionValidation.Metadata.CountStatistics.

Field Description Type Required Default Enum
objectTypeCountList The array of statistics. list[object] Yes - -

Status.metadata.countStatistics.objectTypeCountList[]

Back to UserDefinedFunctionValidation status

UserDefinedFunctionValidationMetadataCountStatisticsObjectTypeCountList defines nested fields for UserDefinedFunctionValidation.Metadata.CountStatistics.ObjectTypeCountList.

Field Description Type Required Default Enum
objectCount The value for the count statistic object. integer (int64) No - -
objectType The type of object for the count statistic object. string No - -

Status.parentRef

Back to UserDefinedFunctionValidation status

UserDefinedFunctionValidationParentRef defines nested fields for UserDefinedFunctionValidation.ParentRef.

Field Description Type Required Default Enum
parent Key of the parent object. string No - -
rootDocId Key of the root document object. string No - -

Status.status

Back to UserDefinedFunctionValidation 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

Back to UserDefinedFunctionValidation status

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

Back to UserDefinedFunctionValidation status

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[]

Back to UserDefinedFunctionValidation status

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

Status.validationMessages{}

Back to UserDefinedFunctionValidation status

No documented fields in the checked-in CRD schema.

Workspace

Workspace is the Schema for the workspaces API.

  • Plural: workspaces
  • Scope: Namespaced
  • APIVersion: dataintegration.oracle.com/v1beta1
  • Sample: Sample (config/samples/dataintegration_v1beta1_workspace.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

WorkspaceSpec defines the desired state of Workspace.

Field Description Type Required Default Enum
compartmentId The OCID of the compartment containing the workspace. string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
description A user defined description for the workspace. string No - -
displayName A user-friendly display name for the workspace. Does not have to be unique, and can be modified. Avoid entering confidential information. string Yes - -
dnsServerIp The IP of the custom DNS. string No - -
dnsServerZone The DNS zone of the custom DNS to use to resolve names. string No - -
endpointCompartmentId DCMS PRivate Endpoint Compartment Identifier string No - -
endpointId DCMS Private Endpoint ID associated with workspace if the pvt networking is enabled string No - -
endpointName DCMS Private Endpoint Name string No - -
freeformTags Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
isPrivateNetworkEnabled Specifies whether the private network connection is enabled or disabled. boolean No - -
registryCompartmentId DCMS Data Asset Registry Compartment Identifier string No - -
registryId DCMS Data Asset Registry ID to which the workspace is associated string No - -
registryName DCMS Data Asset Registry display name string No - -
subnetId The OCID of the subnet for customer connected databases. string No - -
vcnId The OCID of the VCN the subnet is in. string No - -
workspaceProperties Key-values pairs of workspace for storing properties on the workspace. map[string, string] No - -

Status

WorkspaceStatus defines the observed state of Workspace.

Field Description Type Required Default Enum
compartmentId The OCID of the compartment containing the workspace. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
description A detailed description for the workspace. string No - -
displayName A user-friendly display name for the workspace. Does not have to be unique, and can be modified. Avoid entering confidential information. string No - -
dnsServerIp The IP of the custom DNS. string No - -
dnsServerZone The DNS zone of the custom DNS to use to resolve names. string No - -
endpointId OCID of the private endpoint associated with the container/workspace. string No - -
endpointName Name of the private endpoint associated with the container/workspace. string No - -
freeformTags Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
id A system-generated and immutable identifier assigned to the workspace upon creation. string No - -
isPrivateNetworkEnabled Specifies whether the private network connection is enabled or disabled. boolean No - -
lifecycleState Lifecycle states for workspaces in Data Integration Service CREATING - The resource is being created and may not be usable until the entire metadata is defined UPDATING - The resource is being updated and may not be usable until all changes are commited DELETING - The resource is being deleted and might require deep cleanup of children. ACTIVE - The resource is valid and available for access INACTIVE - The resource might be incomplete in its definition or might have been made unavailable for administrative reasons DELETED - The resource has been deleted and isn't available FAILED - The resource is in a failed state due to validation or other errors STARTING - The resource is being started and may not be usable until becomes ACTIVE again STOPPING - The resource is in the process of Stopping and may not be usable until it Stops or fails STOPPED - The resource is in Stopped state due to stop operation. string No - -
registryId DCMS Registry ID associated with the container/workspace. string No - -
stateMessage 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 - -
status - object Yes - -
subnetId The OCID of the subnet for customer connected databases. string No - -
timeCreated The date and time the workspace was created, in the timestamp format defined by RFC3339. string No - -
timeUpdated The date and time the workspace was updated, in the timestamp format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). string No - -
vcnId The OCID of the VCN the subnet is in. string No - -
workspaceProperties key-value pairs of workspace properties map[string, string] No - -

Status.status

Back to Workspace 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

Back to Workspace status

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

Back to Workspace status

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[]

Back to Workspace status

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