CreateSparkUserPrincipalOciObjectStorageConfigDetails¶

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

Bases: oci.golden_gate.models.create_spark_oci_object_storage_config_details.CreateSparkOciObjectStorageConfigDetails

User-principal authentication and location details for creating an OCI Object Storage Spark artifact location. Provide exactly one of privateKeyFile or privateKeyFileSecretId. If the private key is passphrase-protected, provide at most one of privateKeyPassphrase or privateKeyPassphraseSecretId.

Methods

`__init__`(**kwargs)	Initializes a new CreateSparkUserPrincipalOciObjectStorageConfigDetails 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`	[Required] Gets the authentication_type of this CreateSparkOciObjectStorageConfigDetails.
`bucket`	[Required] Gets the bucket of this CreateSparkUserPrincipalOciObjectStorageConfigDetails.
`namespace`	[Required] Gets the namespace of this CreateSparkUserPrincipalOciObjectStorageConfigDetails.
`path`	[Required] Gets the path of this CreateSparkUserPrincipalOciObjectStorageConfigDetails.
`private_key_file`	Gets the private_key_file of this CreateSparkUserPrincipalOciObjectStorageConfigDetails.
`private_key_file_secret_id`	Gets the private_key_file_secret_id of this CreateSparkUserPrincipalOciObjectStorageConfigDetails.
`private_key_passphrase`	Gets the private_key_passphrase of this CreateSparkUserPrincipalOciObjectStorageConfigDetails.
`private_key_passphrase_secret_id`	Gets the private_key_passphrase_secret_id of this CreateSparkUserPrincipalOciObjectStorageConfigDetails.
`public_key_fingerprint`	[Required] Gets the public_key_fingerprint of this CreateSparkUserPrincipalOciObjectStorageConfigDetails.
`region`	Gets the region of this CreateSparkUserPrincipalOciObjectStorageConfigDetails.
`tenancy_id`	Gets the tenancy_id of this CreateSparkUserPrincipalOciObjectStorageConfigDetails.
`user_id`	Gets the user_id of this CreateSparkUserPrincipalOciObjectStorageConfigDetails.

__init__(**kwargs)¶

Initializes a new CreateSparkUserPrincipalOciObjectStorageConfigDetails 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 CreateSparkUserPrincipalOciObjectStorageConfigDetails.
region (str) – The value to assign to the region property of this CreateSparkUserPrincipalOciObjectStorageConfigDetails.
namespace (str) – The value to assign to the namespace property of this CreateSparkUserPrincipalOciObjectStorageConfigDetails.
bucket (str) – The value to assign to the bucket property of this CreateSparkUserPrincipalOciObjectStorageConfigDetails.
path (str) – The value to assign to the path property of this CreateSparkUserPrincipalOciObjectStorageConfigDetails.
tenancy_id (str) – The value to assign to the tenancy_id property of this CreateSparkUserPrincipalOciObjectStorageConfigDetails.
user_id (str) – The value to assign to the user_id property of this CreateSparkUserPrincipalOciObjectStorageConfigDetails.
private_key_file (str) – The value to assign to the private_key_file property of this CreateSparkUserPrincipalOciObjectStorageConfigDetails.
private_key_file_secret_id (str) – The value to assign to the private_key_file_secret_id property of this CreateSparkUserPrincipalOciObjectStorageConfigDetails.
private_key_passphrase (str) – The value to assign to the private_key_passphrase property of this CreateSparkUserPrincipalOciObjectStorageConfigDetails.
private_key_passphrase_secret_id (str) – The value to assign to the private_key_passphrase_secret_id property of this CreateSparkUserPrincipalOciObjectStorageConfigDetails.
public_key_fingerprint (str) – The value to assign to the public_key_fingerprint property of this CreateSparkUserPrincipalOciObjectStorageConfigDetails.

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

bucket¶

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

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

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

path¶

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

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

private_key_file¶

Gets the private_key_file of this CreateSparkUserPrincipalOciObjectStorageConfigDetails. The base64 encoded 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 Deprecated: This field is deprecated and replaced by “privateKeyFileSecretId”. 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 private_key_file of this CreateSparkUserPrincipalOciObjectStorageConfigDetails.
Return type:	str

private_key_file_secret_id¶

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

private_key_passphrase¶

Gets the private_key_passphrase of this CreateSparkUserPrincipalOciObjectStorageConfigDetails. The passphrase of the private key. Deprecated: This field is deprecated and replaced by “privateKeyPassphraseSecretId”. 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 private_key_passphrase of this CreateSparkUserPrincipalOciObjectStorageConfigDetails.
Return type:	str

private_key_passphrase_secret_id¶

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

public_key_fingerprint¶

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

region¶

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

tenancy_id¶

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

Returns:	The tenancy_id of this CreateSparkUserPrincipalOciObjectStorageConfigDetails.
Return type:	str

user_id¶

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