UpdateSparkResourcePrincipalOciObjectStorageConfigDetails

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

Bases: UpdateSparkOciObjectStorageConfigDetails

Resource-principal authentication and location details for updating an OCI Object Storage Spark artifact location.

Methods:

__init__(**kwargs)

Initializes a new UpdateSparkResourcePrincipalOciObjectStorageConfigDetails 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:

authentication_type

Gets the authentication_type of this UpdateSparkOciObjectStorageConfigDetails.

bucket

Gets the bucket of this UpdateSparkResourcePrincipalOciObjectStorageConfigDetails.

namespace

Gets the namespace of this UpdateSparkResourcePrincipalOciObjectStorageConfigDetails.

path

Gets the path of this UpdateSparkResourcePrincipalOciObjectStorageConfigDetails.

region

Gets the region of this UpdateSparkResourcePrincipalOciObjectStorageConfigDetails.

__init__(**kwargs)

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

  • region (str) – The value to assign to the region property of this UpdateSparkResourcePrincipalOciObjectStorageConfigDetails.

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

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

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

property 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

property bucket

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

Returns

The bucket of this UpdateSparkResourcePrincipalOciObjectStorageConfigDetails.

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

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

Returns

The namespace of this UpdateSparkResourcePrincipalOciObjectStorageConfigDetails.

Return type

str

property path

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

Returns

The path of this UpdateSparkResourcePrincipalOciObjectStorageConfigDetails.

Return type

str

property region

Gets the region of this UpdateSparkResourcePrincipalOciObjectStorageConfigDetails. 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 UpdateSparkResourcePrincipalOciObjectStorageConfigDetails.

Return type

str