Package com.oracle.bmc.goldengate.model

Class SparkUserPrincipalOciObjectStorageConfig

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.goldengate.model.SparkOciObjectStorageConfig

com.oracle.bmc.goldengate.model.SparkUserPrincipalOciObjectStorageConfig

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200407")
public final class SparkUserPrincipalOciObjectStorageConfig
extends 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.
Note: Objects should always be created or deserialized using the SparkUserPrincipalOciObjectStorageConfig.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the SparkUserPrincipalOciObjectStorageConfig.Builder, which maintain a set of all explicitly set fields called SparkUserPrincipalOciObjectStorageConfig.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SparkUserPrincipalOciObjectStorageConfig.Builder

Nested classes/interfaces inherited from class com.oracle.bmc.goldengate.model.SparkOciObjectStorageConfig

SparkOciObjectStorageConfig.AuthenticationType

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
SparkUserPrincipalOciObjectStorageConfig(String region, String namespace, String bucket, String path, String tenancyId, String userId, String privateKeyFileSecretId, String privateKeyPassphraseSecretId, String publicKeyFingerprint)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static SparkUserPrincipalOciObjectStorageConfig.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getBucket()	Bucket containing Spark application artifacts.
String	getNamespace()	The OCI Object Storage namespace containing the bucket.
String	getPath()	Object path used for Spark application artifacts.
String	getPrivateKeyFileSecretId()	The OCID of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint.
String	getPrivateKeyPassphraseSecretId()	The OCID of the Secret that stores the passphrase of the private key.
String	getPublicKeyFingerprint()	The fingerprint of the API Key of the user specified by the userId.
String	getRegion()	The name of the region.
String	getTenancyId()	The OCID of the related OCI tenancy.
String	getUserId()	The OCID of the OCI user whose API key is used to access the artifact location.
int	hashCode()
SparkUserPrincipalOciObjectStorageConfig.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SparkUserPrincipalOciObjectStorageConfig

@Deprecated
public SparkUserPrincipalOciObjectStorageConfig(String region,
                                                String namespace,
                                                String bucket,
                                                String path,
                                                String tenancyId,
                                                String userId,
                                                String privateKeyFileSecretId,
                                                String privateKeyPassphraseSecretId,
                                                String publicKeyFingerprint)

Deprecated.

Method Detail

builder

public static SparkUserPrincipalOciObjectStorageConfig.Builder builder()

Create a new builder.

toBuilder

public SparkUserPrincipalOciObjectStorageConfig.Builder toBuilder()

getRegion

public String getRegion()

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 value

getNamespace

public String getNamespace()

The OCI Object Storage namespace containing the bucket.

Example: “mynamespace”

Returns:

the value

getBucket

public String getBucket()

Bucket containing Spark application artifacts.

Example: “spark-artifacts”

Returns:

the value

getPath

public String getPath()

Object path used for Spark application artifacts.

Example: “spark-apps/order-analysis/1.2.0”

Returns:

the value

getTenancyId

public String getTenancyId()

The OCID of the related OCI tenancy.

Returns:

the value

getUserId

public String getUserId()

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 value

getPrivateKeyFileSecretId

public String getPrivateKeyFileSecretId()

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 value

getPrivateKeyPassphraseSecretId

public String getPrivateKeyPassphraseSecretId()

The OCID of the Secret that stores the passphrase of the private key.

Note: When provided, ‘privateKeyPassphrase’ field must not be provided.

Returns:

the value

getPublicKeyFingerprint

public String getPublicKeyFingerprint()

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 value

toString

public String toString()

Overrides:

toString in class SparkOciObjectStorageConfig

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class SparkOciObjectStorageConfig

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class SparkOciObjectStorageConfig

hashCode

public int hashCode()

Overrides:

hashCode in class SparkOciObjectStorageConfig