SparkResourcePrincipalOciObjectStorageConfig¶

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

Bases: oci.golden_gate.models.spark_oci_object_storage_config.SparkOciObjectStorageConfig

Resource-principal 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
`authentication_type`	[Required] Gets the authentication_type of this SparkOciObjectStorageConfig.
`bucket`	[Required] Gets the bucket of this SparkResourcePrincipalOciObjectStorageConfig.
`namespace`	[Required] Gets the namespace of this SparkResourcePrincipalOciObjectStorageConfig.
`path`	[Required] Gets the path of this SparkResourcePrincipalOciObjectStorageConfig.
`region`	[Required] Gets the region of this SparkResourcePrincipalOciObjectStorageConfig.

Methods

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

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 SparkResourcePrincipalOciObjectStorageConfig. Bucket containing Spark application artifacts. Example: “spark-artifacts”

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

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

path¶

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

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

region¶

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