Package com.oracle.bmc.goldengate.model

Class CreateSparkConnectionDetails

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

    • Method Detail

      • getSubmitMode

        public SparkConnection.SubmitMode getSubmitMode()
        Selects the submission channel.

        SUBMIT uses the Spark master RPC endpoint. REST uses the Spark standalone REST submission gateway.

        Returns:
        the value

      • getAuthenticationType

        public SparkConnection.AuthenticationType getAuthenticationType()
        Authentication type for Spark.

        AES_RPC and SASL_ENCRYPTED securityProtocol values require authenticationType to be SHARED_SECRET. Use SHARED_SECRET only when the target cluster is configured with spark.authenticate=true.

        Returns:
        the value

      • getSecurityProtocol

        public SparkConnection.SecurityProtocol getSecurityProtocol()
        Security protocol for Spark submission traffic.

        PLAINTEXT uses an unencrypted channel, TLS uses TLS for the selected submission endpoint, AES_RPC uses Spark RPC AES encryption, and SASL_ENCRYPTED uses legacy SASL encryption. AES_RPC and SASL_ENCRYPTED require authenticationType to be SHARED_SECRET.

        Returns:
        the value

      • getClusterEndpoint

        public String getClusterEndpoint()
        Spark master URL used for job submission.

        Required for both submitMode SUBMIT and REST. e.g.: ‘spark://spark-master.example.com:7077’ High availability can be configured with a comma-separated list, for example: ‘spark://h1.example.com:7077,h2.example.com:7077’

        Returns:
        the value

      • getRestEndpoint

        public String getRestEndpoint()
        Spark standalone REST submission base URL.

        e.g.: ‘https://spark-master.example.com:6066’ Applicable only and required when submitMode is REST.

        Returns:
        the value

      • getAuthSecret

        @Deprecated
public String getAuthSecret()
        Deprecated.
        Use getAuthSecret__AsCharArray() instead.
        The shared secret used for Spark authentication.

        Applicable when authenticationType is SHARED_SECRET. <p> Deprecated: This field is deprecated and replaced by "authSecretSecretId". 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

      • getAuthSecret__AsCharArray

        public char[] getAuthSecret__AsCharArray()
        The shared secret used for Spark authentication.

        Applicable when authenticationType is SHARED_SECRET.

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

      • getAuthSecretSecretId

        public String getAuthSecretSecretId()
        The OCID of the Secret that stores the Spark authentication shared secret.

        Applicable when authenticationType is SHARED_SECRET. Note: When provided, ‘authSecret’ field must not be provided.

        Returns:
        the value

      • getRpcCipher

        public SparkConnection.RpcCipher getRpcCipher()
        Cipher transform used for Spark RPC encryption.

        Applicable when securityProtocol is AES_RPC. Defaults to AES_CTR_NOPADDING when not provided.

        Returns:
        the value

      • getRestAuthSecretKey

        @Deprecated
public String getRestAuthSecretKey()
        Deprecated.
        Use getRestAuthSecretKey__AsCharArray() instead.
        The BASE64URL-encoded HMAC secret key used to sign REST submission requests when the Spark master's REST endpoint is protected by the JWS filter.

        Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType. <p> Deprecated: This field is deprecated and replaced by "restAuthSecretKeySecretId". 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

      • getRestAuthSecretKey__AsCharArray

        public char[] getRestAuthSecretKey__AsCharArray()
        The BASE64URL-encoded HMAC secret key used to sign REST submission requests when the Spark master’s REST endpoint is protected by the JWS filter.

        Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType.

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

      • getRestAuthSecretKeySecretId

        public String getRestAuthSecretKeySecretId()
        The OCID of the Secret that stores the REST submission signing key.

        Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType. Note: When provided, ‘restAuthSecretKey’ field must not be provided.

        Returns:
        the value

      • getTrustStore

        @Deprecated
public String getTrustStore()
        Deprecated.
        Use getTrustStore__AsCharArray() instead.
        The base64 encoded content of the trust store used to validate the Spark server certificate.

        Applicable when securityProtocol is TLS. Provide this when the server certificate is not already trusted by the JVM. <p> Deprecated: This field is deprecated and replaced by "trustStoreSecretId". 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

      • getTrustStore__AsCharArray

        public char[] getTrustStore__AsCharArray()
        The base64 encoded content of the trust store used to validate the Spark server certificate.

        Applicable when securityProtocol is TLS. Provide this when the server certificate is not already trusted by the JVM.

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

      • getTrustStoreSecretId

        public String getTrustStoreSecretId()
        The OCID of the Secret that stores the trust store content.

        Applicable when securityProtocol is TLS. Provide this when the server certificate is not already trusted by the JVM. Note: When provided, ‘trustStore’ field must not be provided.

        Returns:
        the value

      • getTrustStorePassword

        @Deprecated
public String getTrustStorePassword()
        Deprecated.
        Use getTrustStorePassword__AsCharArray() instead.
        Password for the trust store.

        Applicable when securityProtocol is TLS and a trust store is provided. Required when 'trustStore' is provided. <p> Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". 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

      • getTrustStorePassword__AsCharArray

        public char[] getTrustStorePassword__AsCharArray()
        Password for the trust store.

        Applicable when securityProtocol is TLS and a trust store is provided. Required when ‘trustStore’ is provided.

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

      • getTrustStorePasswordSecretId

        public String getTrustStorePasswordSecretId()
        The OCID of the Secret that stores the trust store password.

        Applicable when securityProtocol is TLS and a trust store is provided. Required when ‘trustStoreSecretId’ is provided. Note: When provided, ‘trustStorePassword’ field must not be provided.

        Returns:
        the value

      • getTrustStoreType

        public SparkConnection.TrustStoreType getTrustStoreType()
        Trust store format used by the Spark client.

        Applicable when securityProtocol is TLS and a trust store is provided. Defaults to JKS when not provided. Provide this only when a trust store is provided.

        Returns:
        the value

      • getKeyStore

        @Deprecated
public String getKeyStore()
        Deprecated.
        Use getKeyStore__AsCharArray() instead.
        The base64 encoded content of the client key store used for mutual TLS.

        Provide this only when the target cluster requires client certificate authentication. Applicable when securityProtocol is TLS. <p> Deprecated: This field is deprecated and replaced by "keyStoreSecretId". 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

      • getKeyStore__AsCharArray

        public char[] getKeyStore__AsCharArray()
        The base64 encoded content of the client key store used for mutual TLS.

        Provide this only when the target cluster requires client certificate authentication. Applicable when securityProtocol is TLS.

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

      • getKeyStoreSecretId

        public String getKeyStoreSecretId()
        The OCID of the Secret that stores the client key store content.

        Applicable when securityProtocol is TLS. Note: When provided, ‘keyStore’ field must not be provided.

        Returns:
        the value

      • getKeyStorePassword

        @Deprecated
public String getKeyStorePassword()
        Deprecated.
        Use getKeyStorePassword__AsCharArray() instead.
        Password for the client key store.

        Applicable when securityProtocol is TLS and a client key store is provided. Required when 'keyStore' is provided. <p> Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". 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

      • getKeyStorePassword__AsCharArray

        public char[] getKeyStorePassword__AsCharArray()
        Password for the client key store.

        Applicable when securityProtocol is TLS and a client key store is provided. Required when ‘keyStore’ is provided.

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

      • getKeyStorePasswordSecretId

        public String getKeyStorePasswordSecretId()
        The OCID of the Secret that stores the client key store password.

        Applicable when securityProtocol is TLS and a client key store is provided. Required when ‘keyStoreSecretId’ is provided. Note: When provided, ‘keyStorePassword’ field must not be provided.

        Returns:
        the value

      • getKeyStoreType

        public SparkConnection.KeyStoreType getKeyStoreType()
        Client key store format used for mutual TLS.

        Applicable when securityProtocol is TLS and a client key store is provided. Defaults to JKS when not provided. Provide this only when a client key store is provided.

        Returns:
        the value

      • getSslKeyPassword

        @Deprecated
public String getSslKeyPassword()
        Deprecated.
        Use getSslKeyPassword__AsCharArray() instead.
        Password for the certificate private key inside the client key store.

        Provide this only when it differs from the key store password. Applicable when securityProtocol is TLS and a client key store is provided. <p> Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". 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

      • getSslKeyPassword__AsCharArray

        public char[] getSslKeyPassword__AsCharArray()
        Password for the certificate private key inside the client key store.

        Provide this only when it differs from the key store password. Applicable when securityProtocol is TLS and a client key store is provided.

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

      • getSslKeyPasswordSecretId

        public String getSslKeyPasswordSecretId()
        The OCID of the Secret that stores the private key password.

        Applicable when securityProtocol is TLS and a client key store is provided. Note: When provided, ‘sslKeyPassword’ field must not be provided.

        Returns:
        the value

      • getTlsProtocol

        public SparkConnection.TlsProtocol getTlsProtocol()
        TLS protocol negotiated by the Spark client.

        Applicable when securityProtocol is TLS. Defaults to TLS_V1_3 when not provided. Must be supported by the target cluster.

        Returns:
        the value

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Overrides:
        toString in class CreateConnectionDetails
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation