Class SparkConnectionSummary

Summary of the Spark Connection.

Inheritance
object
ConnectionSummary
SparkConnectionSummary
Inherited Members
Namespace: Oci.GoldengateService.Models
Assembly: OCI.DotNetSDK.Goldengate.dll
Syntax
public class SparkConnectionSummary : ConnectionSummary

Properties

ArtifactLocation

Declaration
[Required(ErrorMessage = "ArtifactLocation is required.")]
[JsonProperty(PropertyName = "artifactLocation")]
public SparkArtifactLocationSummary ArtifactLocation { get; set; }
Property Value
Type Description
SparkArtifactLocationSummary
Remarks

Required

AuthSecretSecretId

Declaration
[JsonProperty(PropertyName = "authSecretSecretId")]
public string AuthSecretSecretId { get; set; }
Property Value
Type Description
string

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.

AuthenticationType

Declaration
[Required(ErrorMessage = "AuthenticationType is required.")]
[JsonProperty(PropertyName = "authenticationType")]
[JsonConverter(typeof(StringEnumConverter))]
public SparkConnection.AuthenticationTypeEnum? AuthenticationType { get; set; }
Property Value
Type Description
SparkConnection.AuthenticationTypeEnum?

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.
Remarks

Required

ClusterEndpoint

Declaration
[Required(ErrorMessage = "ClusterEndpoint is required.")]
[JsonProperty(PropertyName = "clusterEndpoint")]
public string ClusterEndpoint { get; set; }
Property Value
Type Description
string

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'
Remarks

Required

KeyStorePasswordSecretId

Declaration
[JsonProperty(PropertyName = "keyStorePasswordSecretId")]
public string KeyStorePasswordSecretId { get; set; }
Property Value
Type Description
string

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.

KeyStoreSecretId

Declaration
[JsonProperty(PropertyName = "keyStoreSecretId")]
public string KeyStoreSecretId { get; set; }
Property Value
Type Description
string

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.

KeyStoreType

Declaration
[JsonProperty(PropertyName = "keyStoreType")]
[JsonConverter(typeof(StringEnumConverter))]
public SparkConnection.KeyStoreTypeEnum? KeyStoreType { get; set; }
Property Value
Type Description
SparkConnection.KeyStoreTypeEnum?

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.

RestAuthSecretKeySecretId

Declaration
[JsonProperty(PropertyName = "restAuthSecretKeySecretId")]
public string RestAuthSecretKeySecretId { get; set; }
Property Value
Type Description
string

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.

RestEndpoint

Declaration
[JsonProperty(PropertyName = "restEndpoint")]
public string RestEndpoint { get; set; }
Property Value
Type Description
string

Spark standalone REST submission base URL. e.g.: 'https://spark-master.example.com:6066' Applicable only and required when submitMode is REST.

RpcCipher

Declaration
[JsonProperty(PropertyName = "rpcCipher")]
[JsonConverter(typeof(StringEnumConverter))]
public SparkConnection.RpcCipherEnum? RpcCipher { get; set; }
Property Value
Type Description
SparkConnection.RpcCipherEnum?

Cipher transform used for Spark RPC encryption. Applicable when securityProtocol is AES_RPC. Defaults to AES_CTR_NOPADDING when not provided.

SecurityProtocol

Declaration
[Required(ErrorMessage = "SecurityProtocol is required.")]
[JsonProperty(PropertyName = "securityProtocol")]
[JsonConverter(typeof(StringEnumConverter))]
public SparkConnection.SecurityProtocolEnum? SecurityProtocol { get; set; }
Property Value
Type Description
SparkConnection.SecurityProtocolEnum?

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.
Remarks

Required

SslKeyPasswordSecretId

Declaration
[JsonProperty(PropertyName = "sslKeyPasswordSecretId")]
public string SslKeyPasswordSecretId { get; set; }
Property Value
Type Description
string

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.

SubmitMode

Declaration
[Required(ErrorMessage = "SubmitMode is required.")]
[JsonProperty(PropertyName = "submitMode")]
[JsonConverter(typeof(StringEnumConverter))]
public SparkConnection.SubmitModeEnum? SubmitMode { get; set; }
Property Value
Type Description
SparkConnection.SubmitModeEnum?

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

Required

TechnologyType

Declaration
[Required(ErrorMessage = "TechnologyType is required.")]
[JsonProperty(PropertyName = "technologyType")]
[JsonConverter(typeof(StringEnumConverter))]
public SparkConnection.TechnologyTypeEnum? TechnologyType { get; set; }
Property Value
Type Description
SparkConnection.TechnologyTypeEnum?

The Spark technology type.
Remarks

Required

TlsProtocol

Declaration
[JsonProperty(PropertyName = "tlsProtocol")]
[JsonConverter(typeof(StringEnumConverter))]
public SparkConnection.TlsProtocolEnum? TlsProtocol { get; set; }
Property Value
Type Description
SparkConnection.TlsProtocolEnum?

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.

TrustStorePasswordSecretId

Declaration
[JsonProperty(PropertyName = "trustStorePasswordSecretId")]
public string TrustStorePasswordSecretId { get; set; }
Property Value
Type Description
string

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.

TrustStoreSecretId

Declaration
[JsonProperty(PropertyName = "trustStoreSecretId")]
public string TrustStoreSecretId { get; set; }
Property Value
Type Description
string

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.

TrustStoreType

Declaration
[JsonProperty(PropertyName = "trustStoreType")]
[JsonConverter(typeof(StringEnumConverter))]
public SparkConnection.TrustStoreTypeEnum? TrustStoreType { get; set; }
Property Value
Type Description
SparkConnection.TrustStoreTypeEnum?

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.