Class CreateSparkSecretKeyOciObjectStorageConfigDetails


  • @Generated(value="OracleSDKGenerator",
               comments="API Version: 20200407")
    public final class CreateSparkSecretKeyOciObjectStorageConfigDetails
    extends CreateSparkOciObjectStorageConfigDetails
    Secret-key authentication and location details for creating an OCI Object Storage Spark artifact location.

    Provide exactly one of secretAccessKey or secretAccessKeySecretId.
    Note: Objects should always be created or deserialized using the CreateSparkSecretKeyOciObjectStorageConfigDetails.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 CreateSparkSecretKeyOciObjectStorageConfigDetails.Builder, which maintain a set of all explicitly set fields called CreateSparkSecretKeyOciObjectStorageConfigDetails.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

      • CreateSparkSecretKeyOciObjectStorageConfigDetails

        @Deprecated
        public CreateSparkSecretKeyOciObjectStorageConfigDetails​(String region,
                                                                 String namespace,
                                                                 String bucket,
                                                                 String path,
                                                                 String accessKeyId,
                                                                 String secretAccessKey,
                                                                 String secretAccessKeySecretId)
        Deprecated.
      • CreateSparkSecretKeyOciObjectStorageConfigDetails

        @Deprecated
        public CreateSparkSecretKeyOciObjectStorageConfigDetails​(String region,
                                                                 String namespace,
                                                                 String bucket,
                                                                 String path,
                                                                 String accessKeyId,
                                                                 char[] secretAccessKey,
                                                                 String secretAccessKeySecretId)
        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
      • getAccessKeyId

        public String getAccessKeyId()
        Access key identifier used for OCI Object Storage secret-key authentication.

        Note: Despite the “Id” suffix, this value is not an OCI OCID.

        Returns:
        the value
      • getSecretAccessKey

        @Deprecated
        public String getSecretAccessKey()
        Deprecated.
        Use getSecretAccessKey__AsCharArray() instead.
        Secret access key used for OCI Object Storage secret-key authentication.

        Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". 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
      • getSecretAccessKey__AsCharArray

        public char[] getSecretAccessKey__AsCharArray()
        Secret access key used for OCI Object Storage secret-key authentication.

        Deprecated: This field is deprecated and replaced by “secretAccessKeySecretId”. 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
      • getSecretAccessKeySecretId

        public String getSecretAccessKeySecretId()
        The OCID of the Secret that stores the secret access key.

        Note: When provided, secretAccessKey must not be provided.

        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