DatabricksEngineUserPrincipalOciObjectStorageConfig¶

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

Bases: oci.golden_gate.models.databricks_engine_oci_object_storage_config.DatabricksEngineOciObjectStorageConfig

User-principal authentication and location details for an OCI Object Storage Databricks Engine artifact location.

Attributes

`AUTHENTICATION_TYPE_CUSTOMER_SECRET_KEY`	str(object=’’) -> str
`AUTHENTICATION_TYPE_PRE_AUTHENTICATED_REQUEST`	str(object=’’) -> str
`AUTHENTICATION_TYPE_RESOURCE_PRINCIPAL`	str(object=’’) -> str
`AUTHENTICATION_TYPE_USER_PRINCIPAL`	str(object=’’) -> str
`authentication_type`	[Required] Gets the authentication_type of this DatabricksEngineOciObjectStorageConfig.
`bucket`	[Required] Gets the bucket of this DatabricksEngineUserPrincipalOciObjectStorageConfig.
`namespace`	[Required] Gets the namespace of this DatabricksEngineUserPrincipalOciObjectStorageConfig.
`path`	[Required] Gets the path of this DatabricksEngineUserPrincipalOciObjectStorageConfig.
`private_key_file_secret_id`	Gets the private_key_file_secret_id of this DatabricksEngineUserPrincipalOciObjectStorageConfig.
`private_key_passphrase_secret_id`	Gets the private_key_passphrase_secret_id of this DatabricksEngineUserPrincipalOciObjectStorageConfig.
`public_key_fingerprint`	[Required] Gets the public_key_fingerprint of this DatabricksEngineUserPrincipalOciObjectStorageConfig.
`region`	[Required] Gets the region of this DatabricksEngineUserPrincipalOciObjectStorageConfig.
`tenancy_id`	Gets the tenancy_id of this DatabricksEngineUserPrincipalOciObjectStorageConfig.
`user_id`	[Required] Gets the user_id of this DatabricksEngineUserPrincipalOciObjectStorageConfig.

Methods

`__init__`(**kwargs)	Initializes a new DatabricksEngineUserPrincipalOciObjectStorageConfig 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.

AUTHENTICATION_TYPE_CUSTOMER_SECRET_KEY = 'CUSTOMER_SECRET_KEY'¶

AUTHENTICATION_TYPE_PRE_AUTHENTICATED_REQUEST = 'PRE_AUTHENTICATED_REQUEST'¶

AUTHENTICATION_TYPE_RESOURCE_PRINCIPAL = 'RESOURCE_PRINCIPAL'¶

AUTHENTICATION_TYPE_USER_PRINCIPAL = 'USER_PRINCIPAL'¶

__init__(**kwargs)¶

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

Parameters:

authentication_type (str) – The value to assign to the authentication_type property of this DatabricksEngineUserPrincipalOciObjectStorageConfig. Allowed values for this property are: “USER_PRINCIPAL”, “RESOURCE_PRINCIPAL”, “CUSTOMER_SECRET_KEY”, “PRE_AUTHENTICATED_REQUEST”
region (str) – The value to assign to the region property of this DatabricksEngineUserPrincipalOciObjectStorageConfig.
namespace (str) – The value to assign to the namespace property of this DatabricksEngineUserPrincipalOciObjectStorageConfig.
bucket (str) – The value to assign to the bucket property of this DatabricksEngineUserPrincipalOciObjectStorageConfig.
path (str) – The value to assign to the path property of this DatabricksEngineUserPrincipalOciObjectStorageConfig.
tenancy_id (str) – The value to assign to the tenancy_id property of this DatabricksEngineUserPrincipalOciObjectStorageConfig.
user_id (str) – The value to assign to the user_id property of this DatabricksEngineUserPrincipalOciObjectStorageConfig.
private_key_file_secret_id (str) – The value to assign to the private_key_file_secret_id property of this DatabricksEngineUserPrincipalOciObjectStorageConfig.
private_key_passphrase_secret_id (str) – The value to assign to the private_key_passphrase_secret_id property of this DatabricksEngineUserPrincipalOciObjectStorageConfig.
public_key_fingerprint (str) – The value to assign to the public_key_fingerprint property of this DatabricksEngineUserPrincipalOciObjectStorageConfig.

authentication_type¶

[Required] Gets the authentication_type of this DatabricksEngineOciObjectStorageConfig. Authentication method used to access OCI Object Storage.

Allowed values for this property are: “USER_PRINCIPAL”, “RESOURCE_PRINCIPAL”, “CUSTOMER_SECRET_KEY”, “PRE_AUTHENTICATED_REQUEST”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The authentication_type of this DatabricksEngineOciObjectStorageConfig.
Return type:	str

bucket¶

[Required] Gets the bucket of this DatabricksEngineUserPrincipalOciObjectStorageConfig. Bucket containing Databricks application artifacts.

Returns:	The bucket of this DatabricksEngineUserPrincipalOciObjectStorageConfig.
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.

namespace¶

[Required] Gets the namespace of this DatabricksEngineUserPrincipalOciObjectStorageConfig. The OCI Object Storage namespace containing the bucket. Example: “mynamespace”

Returns:	The namespace of this DatabricksEngineUserPrincipalOciObjectStorageConfig.
Return type:	str

path¶

[Required] Gets the path of this DatabricksEngineUserPrincipalOciObjectStorageConfig. Object path used for Databricks application artifacts.

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

private_key_file_secret_id¶

Gets the private_key_file_secret_id of this DatabricksEngineUserPrincipalOciObjectStorageConfig. The OCID of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Note: When provided, ‘privateKeyFile’ field must not be provided.

Returns:	The private_key_file_secret_id of this DatabricksEngineUserPrincipalOciObjectStorageConfig.
Return type:	str

private_key_passphrase_secret_id¶

Gets the private_key_passphrase_secret_id of this DatabricksEngineUserPrincipalOciObjectStorageConfig. The OCID of the Secret that stores the passphrase of the private key. Note: When provided, ‘privateKeyPassphrase’ field must not be provided.

Returns:	The private_key_passphrase_secret_id of this DatabricksEngineUserPrincipalOciObjectStorageConfig.
Return type:	str

public_key_fingerprint¶

[Required] Gets the public_key_fingerprint of this DatabricksEngineUserPrincipalOciObjectStorageConfig. The fingerprint of the API Key of the user specified by the userId. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm

Returns:	The public_key_fingerprint of this DatabricksEngineUserPrincipalOciObjectStorageConfig.
Return type:	str

region¶

[Required] Gets the region of this DatabricksEngineUserPrincipalOciObjectStorageConfig. The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the current region.

Returns:	The region of this DatabricksEngineUserPrincipalOciObjectStorageConfig.
Return type:	str

tenancy_id¶

Gets the tenancy_id of this DatabricksEngineUserPrincipalOciObjectStorageConfig. The OCID of the related OCI tenancy.

Returns:	The tenancy_id of this DatabricksEngineUserPrincipalOciObjectStorageConfig.
Return type:	str

user_id¶

[Required] Gets the user_id of this DatabricksEngineUserPrincipalOciObjectStorageConfig. The OCID of the OCI user whose API key is used to access the artifact location. If not provided it will default to the current user.

Returns:	The user_id of this DatabricksEngineUserPrincipalOciObjectStorageConfig.
Return type:	str