Package com.oracle.bmc.goldengate.model

Class SparkConnectionSummary

java.lang.Object

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

com.oracle.bmc.goldengate.model.ConnectionSummary

com.oracle.bmc.goldengate.model.SparkConnectionSummary

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200407")
public final class SparkConnectionSummary
extends ConnectionSummary

Summary of the Spark Connection.
Note: Objects should always be created or deserialized using the SparkConnectionSummary.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 SparkConnectionSummary.Builder, which maintain a set of all explicitly set fields called SparkConnectionSummary.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	SparkConnectionSummary.Builder

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

SparkConnectionSummary(String id, String displayName, String description, String compartmentId, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags, Connection.LifecycleState lifecycleState, String lifecycleDetails, Date timeCreated, Date timeUpdated, String vaultId, String keyId, List<IngressIpDetails> ingressIps, List<String> nsgIds, String subnetId, RoutingMethod routingMethod, List<ResourceLock> locks, Boolean doesUseSecretIds, String subscriptionId, String clusterPlacementGroupId, Map<String,Map<String,Object>> securityAttributes, SparkConnection.TechnologyType technologyType, SparkConnection.SubmitMode submitMode, SparkConnection.AuthenticationType authenticationType, SparkConnection.SecurityProtocol securityProtocol, String clusterEndpoint, String restEndpoint, String authSecretSecretId, SparkConnection.RpcCipher rpcCipher, String restAuthSecretKeySecretId, String trustStoreSecretId, String trustStorePasswordSecretId, SparkConnection.TrustStoreType trustStoreType, String keyStoreSecretId, String keyStorePasswordSecretId, SparkConnection.KeyStoreType keyStoreType, String sslKeyPasswordSecretId, SparkConnection.TlsProtocol tlsProtocol, SparkArtifactLocationSummary artifactLocation)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static SparkConnectionSummary.Builder	builder()	Create a new builder.
boolean	equals(Object o)
SparkArtifactLocationSummary	getArtifactLocation()
SparkConnection.AuthenticationType	getAuthenticationType()	Authentication type for Spark.
String	getAuthSecretSecretId()	The OCID of the Secret that stores the Spark authentication shared secret.
String	getClusterEndpoint()	Spark master URL used for job submission.
String	getKeyStorePasswordSecretId()	The OCID of the Secret that stores the client key store password.
String	getKeyStoreSecretId()	The OCID of the Secret that stores the client key store content.
SparkConnection.KeyStoreType	getKeyStoreType()	Client key store format used for mutual TLS.
String	getRestAuthSecretKeySecretId()	The OCID of the Secret that stores the REST submission signing key.
String	getRestEndpoint()	Spark standalone REST submission base URL.
SparkConnection.RpcCipher	getRpcCipher()	Cipher transform used for Spark RPC encryption.
SparkConnection.SecurityProtocol	getSecurityProtocol()	Security protocol for Spark submission traffic.
String	getSslKeyPasswordSecretId()	The OCID of the Secret that stores the private key password.
SparkConnection.SubmitMode	getSubmitMode()	Selects the submission channel.
SparkConnection.TechnologyType	getTechnologyType()	The Spark technology type.
SparkConnection.TlsProtocol	getTlsProtocol()	TLS protocol negotiated by the Spark client.
String	getTrustStorePasswordSecretId()	The OCID of the Secret that stores the trust store password.
String	getTrustStoreSecretId()	The OCID of the Secret that stores the trust store content.
SparkConnection.TrustStoreType	getTrustStoreType()	Trust store format used by the Spark client.
int	hashCode()
SparkConnectionSummary.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.goldengate.model.ConnectionSummary

getClusterPlacementGroupId, getCompartmentId, getDefinedTags, getDescription, getDisplayName, getDoesUseSecretIds, getFreeformTags, getId, getIngressIps, getKeyId, getLifecycleDetails, getLifecycleState, getLocks, getNsgIds, getRoutingMethod, getSecurityAttributes, getSubnetId, getSubscriptionId, getSystemTags, getTimeCreated, getTimeUpdated, getVaultId

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

SparkConnectionSummary

@Deprecated
public SparkConnectionSummary(String id,
                              String displayName,
                              String description,
                              String compartmentId,
                              Map<String,String> freeformTags,
                              Map<String,Map<String,Object>> definedTags,
                              Map<String,Map<String,Object>> systemTags,
                              Connection.LifecycleState lifecycleState,
                              String lifecycleDetails,
                              Date timeCreated,
                              Date timeUpdated,
                              String vaultId,
                              String keyId,
                              List<IngressIpDetails> ingressIps,
                              List<String> nsgIds,
                              String subnetId,
                              RoutingMethod routingMethod,
                              List<ResourceLock> locks,
                              Boolean doesUseSecretIds,
                              String subscriptionId,
                              String clusterPlacementGroupId,
                              Map<String,Map<String,Object>> securityAttributes,
                              SparkConnection.TechnologyType technologyType,
                              SparkConnection.SubmitMode submitMode,
                              SparkConnection.AuthenticationType authenticationType,
                              SparkConnection.SecurityProtocol securityProtocol,
                              String clusterEndpoint,
                              String restEndpoint,
                              String authSecretSecretId,
                              SparkConnection.RpcCipher rpcCipher,
                              String restAuthSecretKeySecretId,
                              String trustStoreSecretId,
                              String trustStorePasswordSecretId,
                              SparkConnection.TrustStoreType trustStoreType,
                              String keyStoreSecretId,
                              String keyStorePasswordSecretId,
                              SparkConnection.KeyStoreType keyStoreType,
                              String sslKeyPasswordSecretId,
                              SparkConnection.TlsProtocol tlsProtocol,
                              SparkArtifactLocationSummary artifactLocation)

Deprecated.

Method Detail

builder

public static SparkConnectionSummary.Builder builder()

Create a new builder.

toBuilder

public SparkConnectionSummary.Builder toBuilder()

getTechnologyType

public SparkConnection.TechnologyType getTechnologyType()

The Spark technology type.

Returns:

the value

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

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

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

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

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

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

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

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

getArtifactLocation

public SparkArtifactLocationSummary getArtifactLocation()

toString

public String toString()

Overrides:

toString in class ConnectionSummary

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class ConnectionSummary

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class ConnectionSummary

hashCode

public int hashCode()

Overrides:

hashCode in class ConnectionSummary