SparkUserPrincipalOciObjectStorageConfig

class oci.golden_gate.models.SparkUserPrincipalOciObjectStorageConfig(**kwargs)

Bases: SparkOciObjectStorageConfig

User-principal authentication and location details for an OCI Object Storage Spark artifact location. The private key is represented by privateKeyFileSecretId; the private key content is never returned.

Attributes:

AUTHENTICATION_TYPE_CUSTOMER_SECRET_KEY

A constant which can be used with the authentication_type property of a SparkOciObjectStorageConfig.

AUTHENTICATION_TYPE_PRE_AUTHENTICATED_REQUEST

A constant which can be used with the authentication_type property of a SparkOciObjectStorageConfig.

AUTHENTICATION_TYPE_RESOURCE_PRINCIPAL

A constant which can be used with the authentication_type property of a SparkOciObjectStorageConfig.

AUTHENTICATION_TYPE_USER_PRINCIPAL

A constant which can be used with the authentication_type property of a SparkOciObjectStorageConfig.

authentication_type

[Required] Gets the authentication_type of this SparkOciObjectStorageConfig.

bucket

[Required] Gets the bucket of this SparkUserPrincipalOciObjectStorageConfig.

namespace

[Required] Gets the namespace of this SparkUserPrincipalOciObjectStorageConfig.

path

[Required] Gets the path of this SparkUserPrincipalOciObjectStorageConfig.

private_key_file_secret_id

Gets the private_key_file_secret_id of this SparkUserPrincipalOciObjectStorageConfig.

private_key_passphrase_secret_id

Gets the private_key_passphrase_secret_id of this SparkUserPrincipalOciObjectStorageConfig.

public_key_fingerprint

[Required] Gets the public_key_fingerprint of this SparkUserPrincipalOciObjectStorageConfig.

region

[Required] Gets the region of this SparkUserPrincipalOciObjectStorageConfig.

tenancy_id

Gets the tenancy_id of this SparkUserPrincipalOciObjectStorageConfig.

user_id

[Required] Gets the user_id of this SparkUserPrincipalOciObjectStorageConfig.

Methods:

__init__(**kwargs)

Initializes a new SparkUserPrincipalOciObjectStorageConfig 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'

A constant which can be used with the authentication_type property of a SparkOciObjectStorageConfig. This constant has a value of “CUSTOMER_SECRET_KEY”

AUTHENTICATION_TYPE_PRE_AUTHENTICATED_REQUEST = 'PRE_AUTHENTICATED_REQUEST'

A constant which can be used with the authentication_type property of a SparkOciObjectStorageConfig. This constant has a value of “PRE_AUTHENTICATED_REQUEST”

AUTHENTICATION_TYPE_RESOURCE_PRINCIPAL = 'RESOURCE_PRINCIPAL'

A constant which can be used with the authentication_type property of a SparkOciObjectStorageConfig. This constant has a value of “RESOURCE_PRINCIPAL”

AUTHENTICATION_TYPE_USER_PRINCIPAL = 'USER_PRINCIPAL'

A constant which can be used with the authentication_type property of a SparkOciObjectStorageConfig. This constant has a value of “USER_PRINCIPAL”

__init__(**kwargs)

Initializes a new SparkUserPrincipalOciObjectStorageConfig 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 SparkUserPrincipalOciObjectStorageConfig. 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 SparkUserPrincipalOciObjectStorageConfig.

  • namespace (str) – The value to assign to the namespace property of this SparkUserPrincipalOciObjectStorageConfig.

  • bucket (str) – The value to assign to the bucket property of this SparkUserPrincipalOciObjectStorageConfig.

  • path (str) – The value to assign to the path property of this SparkUserPrincipalOciObjectStorageConfig.

  • tenancy_id (str) – The value to assign to the tenancy_id property of this SparkUserPrincipalOciObjectStorageConfig.

  • user_id (str) – The value to assign to the user_id property of this SparkUserPrincipalOciObjectStorageConfig.

  • private_key_file_secret_id (str) – The value to assign to the private_key_file_secret_id property of this SparkUserPrincipalOciObjectStorageConfig.

  • private_key_passphrase_secret_id (str) – The value to assign to the private_key_passphrase_secret_id property of this SparkUserPrincipalOciObjectStorageConfig.

  • public_key_fingerprint (str) – The value to assign to the public_key_fingerprint property of this SparkUserPrincipalOciObjectStorageConfig.

property 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

property bucket

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

Returns

The bucket of this SparkUserPrincipalOciObjectStorageConfig.

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.

property namespace

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

Returns

The namespace of this SparkUserPrincipalOciObjectStorageConfig.

Return type

str

property path

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

Returns

The path of this SparkUserPrincipalOciObjectStorageConfig.

Return type

str

property private_key_file_secret_id

Gets the private_key_file_secret_id of this SparkUserPrincipalOciObjectStorageConfig. 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 SparkUserPrincipalOciObjectStorageConfig.

Return type

str

property private_key_passphrase_secret_id

Gets the private_key_passphrase_secret_id of this SparkUserPrincipalOciObjectStorageConfig. 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 SparkUserPrincipalOciObjectStorageConfig.

Return type

str

property public_key_fingerprint

[Required] Gets the public_key_fingerprint of this SparkUserPrincipalOciObjectStorageConfig. 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 SparkUserPrincipalOciObjectStorageConfig.

Return type

str

property region

[Required] Gets the region of this SparkUserPrincipalOciObjectStorageConfig. 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 SparkUserPrincipalOciObjectStorageConfig.

Return type

str

property tenancy_id

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

Returns

The tenancy_id of this SparkUserPrincipalOciObjectStorageConfig.

Return type

str

property user_id

[Required] Gets the user_id of this SparkUserPrincipalOciObjectStorageConfig. 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 SparkUserPrincipalOciObjectStorageConfig.

Return type

str