SparkSecretKeyOciObjectStorageConfig¶

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

Bases: oci.golden_gate.models.spark_oci_object_storage_config.SparkOciObjectStorageConfig

Secret-key authentication and location details for an OCI Object Storage Spark 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
`access_key_id`	[Required] Gets the access_key_id of this SparkSecretKeyOciObjectStorageConfig.
`authentication_type`	[Required] Gets the authentication_type of this SparkOciObjectStorageConfig.
`bucket`	[Required] Gets the bucket of this SparkSecretKeyOciObjectStorageConfig.
`namespace`	[Required] Gets the namespace of this SparkSecretKeyOciObjectStorageConfig.
`path`	[Required] Gets the path of this SparkSecretKeyOciObjectStorageConfig.
`region`	[Required] Gets the region of this SparkSecretKeyOciObjectStorageConfig.
`secret_access_key_secret_id`	Gets the secret_access_key_secret_id of this SparkSecretKeyOciObjectStorageConfig.

Methods

`__init__`(**kwargs)	Initializes a new SparkSecretKeyOciObjectStorageConfig 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 SparkSecretKeyOciObjectStorageConfig object with values from keyword arguments. The default value of the authentication_type attribute of this class is CUSTOMER_SECRET_KEY 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 SparkSecretKeyOciObjectStorageConfig. 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 SparkSecretKeyOciObjectStorageConfig.
namespace (str) – The value to assign to the namespace property of this SparkSecretKeyOciObjectStorageConfig.
bucket (str) – The value to assign to the bucket property of this SparkSecretKeyOciObjectStorageConfig.
path (str) – The value to assign to the path property of this SparkSecretKeyOciObjectStorageConfig.
access_key_id (str) – The value to assign to the access_key_id property of this SparkSecretKeyOciObjectStorageConfig.
secret_access_key_secret_id (str) – The value to assign to the secret_access_key_secret_id property of this SparkSecretKeyOciObjectStorageConfig.

access_key_id¶

[Required] Gets the access_key_id of this SparkSecretKeyOciObjectStorageConfig. Access key identifier used for OCI Object Storage secret-key authentication. Note: Despite the “Id” suffix, this value is not an OCI OCID.

Returns:	The access_key_id of this SparkSecretKeyOciObjectStorageConfig.
Return type:	str

authentication_type¶

[Required] Gets the authentication_type of this SparkOciObjectStorageConfig. 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 SparkOciObjectStorageConfig.
Return type:	str

bucket¶

[Required] Gets the bucket of this SparkSecretKeyOciObjectStorageConfig. Bucket containing Spark application artifacts. Example: “spark-artifacts”

Returns:	The bucket of this SparkSecretKeyOciObjectStorageConfig.
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 SparkSecretKeyOciObjectStorageConfig. The OCI Object Storage namespace containing the bucket. Example: “mynamespace”

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

path¶

[Required] Gets the path of this SparkSecretKeyOciObjectStorageConfig. Object path used for Spark application artifacts. Example: “spark-apps/order-analysis/1.2.0”

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

region¶

[Required] Gets the region of this SparkSecretKeyOciObjectStorageConfig. 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 SparkSecretKeyOciObjectStorageConfig.
Return type:	str

secret_access_key_secret_id¶

Gets the secret_access_key_secret_id of this SparkSecretKeyOciObjectStorageConfig. The OCID of the Secret that stores the secret access key. Note: When provided, secretAccessKey must not be provided.

Returns:	The secret_access_key_secret_id of this SparkSecretKeyOciObjectStorageConfig.
Return type:	str