UcVolumeDatabricksEngineArtifactLocationSummary¶

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

Bases: oci.golden_gate.models.databricks_engine_artifact_location_summary.DatabricksEngineArtifactLocationSummary

Summary of a Unity Catalog volume 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
`location_type`	[Required] Gets the location_type of this DatabricksEngineArtifactLocationSummary.
`path`	[Required] Gets the path of this UcVolumeDatabricksEngineArtifactLocationSummary.
`should_overwrite_existing`	Gets the should_overwrite_existing of this DatabricksEngineArtifactLocationSummary.

Methods

`__init__`(**kwargs)	Initializes a new UcVolumeDatabricksEngineArtifactLocationSummary 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 UcVolumeDatabricksEngineArtifactLocationSummary object with values from keyword arguments. The default value of the location_type attribute of this class is UC_VOLUME 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 UcVolumeDatabricksEngineArtifactLocationSummary. 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 UcVolumeDatabricksEngineArtifactLocationSummary.
path (str) – The value to assign to the path property of this UcVolumeDatabricksEngineArtifactLocationSummary.

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 UcVolumeDatabricksEngineArtifactLocationSummary. Unity Catalog volume artifact path.

Returns:	The path of this UcVolumeDatabricksEngineArtifactLocationSummary.
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