UpdateSparkSecretKeyOciObjectStorageConfigDetails¶

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

Bases: oci.golden_gate.models.update_spark_oci_object_storage_config_details.UpdateSparkOciObjectStorageConfigDetails

Secret-key authentication and location details for updating an OCI Object Storage Spark artifact location. When updating the secret key, provide exactly one of secretAccessKey or secretAccessKeySecretId.

Methods

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

Attributes

`access_key_id`	Gets the access_key_id of this UpdateSparkSecretKeyOciObjectStorageConfigDetails.
`authentication_type`	Gets the authentication_type of this UpdateSparkOciObjectStorageConfigDetails.
`bucket`	Gets the bucket of this UpdateSparkSecretKeyOciObjectStorageConfigDetails.
`namespace`	Gets the namespace of this UpdateSparkSecretKeyOciObjectStorageConfigDetails.
`path`	Gets the path of this UpdateSparkSecretKeyOciObjectStorageConfigDetails.
`region`	Gets the region of this UpdateSparkSecretKeyOciObjectStorageConfigDetails.
`secret_access_key`	Gets the secret_access_key of this UpdateSparkSecretKeyOciObjectStorageConfigDetails.
`secret_access_key_secret_id`	Gets the secret_access_key_secret_id of this UpdateSparkSecretKeyOciObjectStorageConfigDetails.

__init__(**kwargs)¶

Initializes a new UpdateSparkSecretKeyOciObjectStorageConfigDetails 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 UpdateSparkSecretKeyOciObjectStorageConfigDetails.
region (str) – The value to assign to the region property of this UpdateSparkSecretKeyOciObjectStorageConfigDetails.
namespace (str) – The value to assign to the namespace property of this UpdateSparkSecretKeyOciObjectStorageConfigDetails.
bucket (str) – The value to assign to the bucket property of this UpdateSparkSecretKeyOciObjectStorageConfigDetails.
path (str) – The value to assign to the path property of this UpdateSparkSecretKeyOciObjectStorageConfigDetails.
access_key_id (str) – The value to assign to the access_key_id property of this UpdateSparkSecretKeyOciObjectStorageConfigDetails.
secret_access_key (str) – The value to assign to the secret_access_key property of this UpdateSparkSecretKeyOciObjectStorageConfigDetails.
secret_access_key_secret_id (str) – The value to assign to the secret_access_key_secret_id property of this UpdateSparkSecretKeyOciObjectStorageConfigDetails.

access_key_id¶

Gets the access_key_id of this UpdateSparkSecretKeyOciObjectStorageConfigDetails. 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 UpdateSparkSecretKeyOciObjectStorageConfigDetails.
Return type:	str

authentication_type¶

Gets the authentication_type of this UpdateSparkOciObjectStorageConfigDetails. Authentication method used to access OCI Object Storage.

When authenticationType is USER_PRINCIPAL, region, namespace, bucket, path, userId, and publicKeyFingerprint are required. Provide exactly one of privateKeyFile or privateKeyFileSecretId as the private-key credential. tenancyId and the private-key passphrase are optional. When a passphrase is used, provide at most one of privateKeyPassphrase or privateKeyPassphraseSecretId.

When authenticationType is RESOURCE_PRINCIPAL, region, namespace, bucket, and path are required.

When authenticationType is CUSTOMER_SECRET_KEY, region, namespace, bucket, path, and accessKeyId are required. Provide exactly one of secretAccessKey or secretAccessKeySecretId as the secret-key credential. The S3 Compatibility API endpoint is inferred from region and namespace.

When authenticationType is PRE_AUTHENTICATED_REQUEST, provide exactly one of parUrl or parUrlSecretId.

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

bucket¶

Gets the bucket of this UpdateSparkSecretKeyOciObjectStorageConfigDetails. Bucket containing Spark application artifacts. Example: “spark-artifacts”

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

Gets the namespace of this UpdateSparkSecretKeyOciObjectStorageConfigDetails. The OCI Object Storage namespace containing the bucket. Example: “mynamespace”

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

path¶

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

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

region¶

Gets the region of this UpdateSparkSecretKeyOciObjectStorageConfigDetails. 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 UpdateSparkSecretKeyOciObjectStorageConfigDetails.
Return type:	str

secret_access_key¶

Gets the secret_access_key of this UpdateSparkSecretKeyOciObjectStorageConfigDetails. Secret access key used for OCI Object Storage secret-key authentication. Deprecated: This field is deprecated and replaced by “secretAccessKeySecretId”. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

Returns:	The secret_access_key of this UpdateSparkSecretKeyOciObjectStorageConfigDetails.
Return type:	str

secret_access_key_secret_id¶

Gets the secret_access_key_secret_id of this UpdateSparkSecretKeyOciObjectStorageConfigDetails. 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 UpdateSparkSecretKeyOciObjectStorageConfigDetails.
Return type:	str