Package com.oracle.bmc.goldengate.model

Class CreateSparkUserPrincipalOciObjectStorageConfigDetails

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20200407")
public final class CreateSparkUserPrincipalOciObjectStorageConfigDetails
extends 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.
    Note: Objects should always be created or deserialized using the CreateSparkUserPrincipalOciObjectStorageConfigDetails.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 CreateSparkUserPrincipalOciObjectStorageConfigDetails.Builder, which maintain a set of all explicitly set fields called CreateSparkUserPrincipalOciObjectStorageConfigDetails.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).

    • Constructor Detail

      • CreateSparkUserPrincipalOciObjectStorageConfigDetails

        @Deprecated
public CreateSparkUserPrincipalOciObjectStorageConfigDetails​(String region,
                                                             String namespace,
                                                             String bucket,
                                                             String path,
                                                             String tenancyId,
                                                             String userId,
                                                             String privateKeyFile,
                                                             String privateKeyFileSecretId,
                                                             String privateKeyPassphrase,
                                                             String privateKeyPassphraseSecretId,
                                                             String publicKeyFingerprint)
        Deprecated.

      • CreateSparkUserPrincipalOciObjectStorageConfigDetails

        @Deprecated
public CreateSparkUserPrincipalOciObjectStorageConfigDetails​(String region,
                                                             String namespace,
                                                             String bucket,
                                                             String path,
                                                             String tenancyId,
                                                             String userId,
                                                             char[] privateKeyFile,
                                                             String privateKeyFileSecretId,
                                                             char[] privateKeyPassphrase,
                                                             String privateKeyPassphraseSecretId,
                                                             String publicKeyFingerprint)
        Deprecated.

    • Method Detail

      • 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

      • getPrivateKeyFile

        @Deprecated
public String getPrivateKeyFile()
        Deprecated.
        Use getPrivateKeyFile__AsCharArray() instead.
        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 value

      • getPrivateKeyFile__AsCharArray

        public char[] getPrivateKeyFile__AsCharArray()
        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 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

      • getPrivateKeyPassphrase

        @Deprecated
public String getPrivateKeyPassphrase()
        Deprecated.
        Use getPrivateKeyPassphrase__AsCharArray() instead.
        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 value

      • getPrivateKeyPassphrase__AsCharArray

        public char[] getPrivateKeyPassphrase__AsCharArray()
        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 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​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Overrides:
        toString in class CreateSparkOciObjectStorageConfigDetails
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation