CreateSparkResourcePrincipalOciObjectStorageConfigDetails¶
- class oci.golden_gate.models.CreateSparkResourcePrincipalOciObjectStorageConfigDetails(**kwargs)¶
Bases:
CreateSparkOciObjectStorageConfigDetailsResource-principal authentication and location details for creating an OCI Object Storage Spark artifact location.
Methods:
__init__(**kwargs)Initializes a new CreateSparkResourcePrincipalOciObjectStorageConfigDetails 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:
[Required] Gets the authentication_type of this CreateSparkOciObjectStorageConfigDetails.
[Required] Gets the bucket of this CreateSparkResourcePrincipalOciObjectStorageConfigDetails.
[Required] Gets the namespace of this CreateSparkResourcePrincipalOciObjectStorageConfigDetails.
[Required] Gets the path of this CreateSparkResourcePrincipalOciObjectStorageConfigDetails.
Gets the region of this CreateSparkResourcePrincipalOciObjectStorageConfigDetails.
- __init__(**kwargs)¶
Initializes a new CreateSparkResourcePrincipalOciObjectStorageConfigDetails object with values from keyword arguments. The default value of the
authentication_typeattribute of this class isRESOURCE_PRINCIPALand 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 CreateSparkResourcePrincipalOciObjectStorageConfigDetails.
region (str) – The value to assign to the region property of this CreateSparkResourcePrincipalOciObjectStorageConfigDetails.
namespace (str) – The value to assign to the namespace property of this CreateSparkResourcePrincipalOciObjectStorageConfigDetails.
bucket (str) – The value to assign to the bucket property of this CreateSparkResourcePrincipalOciObjectStorageConfigDetails.
path (str) – The value to assign to the path property of this CreateSparkResourcePrincipalOciObjectStorageConfigDetails.
- property authentication_type¶
[Required] Gets the authentication_type of this CreateSparkOciObjectStorageConfigDetails. 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 CreateSparkOciObjectStorageConfigDetails.
- Return type
str
- property bucket¶
[Required] Gets the bucket of this CreateSparkResourcePrincipalOciObjectStorageConfigDetails. Bucket containing Spark application artifacts. Example: “spark-artifacts”
- Returns
The bucket of this CreateSparkResourcePrincipalOciObjectStorageConfigDetails.
- 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 CreateSparkResourcePrincipalOciObjectStorageConfigDetails. The OCI Object Storage namespace containing the bucket. Example: “mynamespace”
- Returns
The namespace of this CreateSparkResourcePrincipalOciObjectStorageConfigDetails.
- Return type
str
- property path¶
[Required] Gets the path of this CreateSparkResourcePrincipalOciObjectStorageConfigDetails. Object path used for Spark application artifacts. Example: “spark-apps/order-analysis/1.2.0”
- Returns
The path of this CreateSparkResourcePrincipalOciObjectStorageConfigDetails.
- Return type
str
- property region¶
Gets the region of this CreateSparkResourcePrincipalOciObjectStorageConfigDetails. 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 CreateSparkResourcePrincipalOciObjectStorageConfigDetails.
- Return type
str