AzureDataLakeStorageDatabricksEngineArtifactLocationSummary¶

class oci.golden_gate.models.AzureDataLakeStorageDatabricksEngineArtifactLocationSummary(**kwargs)¶

Bases: oci.golden_gate.models.databricks_engine_artifact_location_summary.DatabricksEngineArtifactLocationSummary

Summary of an Azure Data Lake Storage Gen2 location used to share Databricks application artifacts.

Attributes

`LOCATION_TYPE_AZURE_DATE_LAKE_STORAGE`	str(object=’’) -> str
`LOCATION_TYPE_OCI_OBJECT_STORAGE`	str(object=’’) -> str
`LOCATION_TYPE_UC_VOLUME`	str(object=’’) -> str
`account_key_secret_id`	Gets the account_key_secret_id of this AzureDataLakeStorageDatabricksEngineArtifactLocationSummary.
`endpoint_suffix`	Gets the endpoint_suffix of this AzureDataLakeStorageDatabricksEngineArtifactLocationSummary.
`filesystem`	[Required] Gets the filesystem of this AzureDataLakeStorageDatabricksEngineArtifactLocationSummary.
`location_type`	[Required] Gets the location_type of this DatabricksEngineArtifactLocationSummary.
`path`	[Required] Gets the path of this AzureDataLakeStorageDatabricksEngineArtifactLocationSummary.
`should_overwrite_existing`	Gets the should_overwrite_existing of this DatabricksEngineArtifactLocationSummary.
`storage_account`	[Required] Gets the storage_account of this AzureDataLakeStorageDatabricksEngineArtifactLocationSummary.

Methods

`__init__`(**kwargs)	Initializes a new AzureDataLakeStorageDatabricksEngineArtifactLocationSummary object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

LOCATION_TYPE_AZURE_DATE_LAKE_STORAGE = 'AZURE_DATE_LAKE_STORAGE'¶

LOCATION_TYPE_OCI_OBJECT_STORAGE = 'OCI_OBJECT_STORAGE'¶

LOCATION_TYPE_UC_VOLUME = 'UC_VOLUME'¶

__init__(**kwargs)¶

Initializes a new AzureDataLakeStorageDatabricksEngineArtifactLocationSummary object with values from keyword arguments. The default value of the location_type attribute of this class is AZURE_DATE_LAKE_STORAGE and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

location_type (str) – The value to assign to the location_type property of this AzureDataLakeStorageDatabricksEngineArtifactLocationSummary. Allowed values for this property are: “UC_VOLUME”, “OCI_OBJECT_STORAGE”, “AZURE_DATE_LAKE_STORAGE”
should_overwrite_existing (bool) – The value to assign to the should_overwrite_existing property of this AzureDataLakeStorageDatabricksEngineArtifactLocationSummary.
storage_account (str) – The value to assign to the storage_account property of this AzureDataLakeStorageDatabricksEngineArtifactLocationSummary.
filesystem (str) – The value to assign to the filesystem property of this AzureDataLakeStorageDatabricksEngineArtifactLocationSummary.
path (str) – The value to assign to the path property of this AzureDataLakeStorageDatabricksEngineArtifactLocationSummary.
endpoint_suffix (str) – The value to assign to the endpoint_suffix property of this AzureDataLakeStorageDatabricksEngineArtifactLocationSummary.
account_key_secret_id (str) – The value to assign to the account_key_secret_id property of this AzureDataLakeStorageDatabricksEngineArtifactLocationSummary.

account_key_secret_id¶

Gets the account_key_secret_id of this AzureDataLakeStorageDatabricksEngineArtifactLocationSummary. The OCID of the Secret that stores the storage account access key. Note: When provided, ‘accountKey’ field must not be provided.

Returns:	The account_key_secret_id of this AzureDataLakeStorageDatabricksEngineArtifactLocationSummary.
Return type:	str

endpoint_suffix¶

Gets the endpoint_suffix of this AzureDataLakeStorageDatabricksEngineArtifactLocationSummary. Endpoint suffix. Defaults to dfs.core.windows.net.

Returns:	The endpoint_suffix of this AzureDataLakeStorageDatabricksEngineArtifactLocationSummary.
Return type:	str

filesystem¶

[Required] Gets the filesystem of this AzureDataLakeStorageDatabricksEngineArtifactLocationSummary. Azure Data Lake Storage Gen2 filesystem containing the application artifacts. Example: “ggs-artifacts”

Returns:	The filesystem of this AzureDataLakeStorageDatabricksEngineArtifactLocationSummary.
Return type:	str

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

location_type¶

[Required] Gets the location_type of this DatabricksEngineArtifactLocationSummary. The type of location used to share Databricks application artifacts.

Allowed values for this property are: “UC_VOLUME”, “OCI_OBJECT_STORAGE”, “AZURE_DATE_LAKE_STORAGE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The location_type of this DatabricksEngineArtifactLocationSummary.
Return type:	str

path¶

[Required] Gets the path of this AzureDataLakeStorageDatabricksEngineArtifactLocationSummary. Artifact path.

Returns:	The path of this AzureDataLakeStorageDatabricksEngineArtifactLocationSummary.
Return type:	str

should_overwrite_existing¶

Gets the should_overwrite_existing of this DatabricksEngineArtifactLocationSummary. Controls whether a staged application artifact replaces an existing file or object with the same name at the configured destination. The artifact is typically a GGFAB pipeline package or one of its dependency files.

When set to true, the existing file or object is replaced with the newly staged version. When set to false, staging fails or skips the upload rather than replacing it. This setting does not replace the entire target directory or prefix. It allows an updated pipeline or dependency to be deployed when artifact names remain the same across versions.

Returns:	The should_overwrite_existing of this DatabricksEngineArtifactLocationSummary.
Return type:	bool

storage_account¶

[Required] Gets the storage_account of this AzureDataLakeStorageDatabricksEngineArtifactLocationSummary. Azure Data Lake Storage Gen2 storage-account name.

Returns:	The storage_account of this AzureDataLakeStorageDatabricksEngineArtifactLocationSummary.
Return type:	str