Class SparkProperties.Builder (2.55.0)

public static final class SparkProperties.Builder extends GeneratedMessageV3.Builder<SparkProperties.Builder> implements SparkPropertiesOrBuilder

Container for connection properties to execute stored procedures for Apache Spark.

Protobuf type google.cloud.bigquery.connection.v1.SparkProperties

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SparkProperties.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SparkProperties.Builder
Overrides

build()

public SparkProperties build()
Returns
Type Description
SparkProperties

buildPartial()

public SparkProperties buildPartial()
Returns
Type Description
SparkProperties

clear()

public SparkProperties.Builder clear()
Returns
Type Description
SparkProperties.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public SparkProperties.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SparkProperties.Builder
Overrides

clearMetastoreServiceConfig()

public SparkProperties.Builder clearMetastoreServiceConfig()

Optional. Dataproc Metastore Service configuration for the connection.

.google.cloud.bigquery.connection.v1.MetastoreServiceConfig metastore_service_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SparkProperties.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public SparkProperties.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SparkProperties.Builder
Overrides

clearServiceAccountId()

public SparkProperties.Builder clearServiceAccountId()

Output only. The account ID of the service created for the purpose of this connection.

The service account does not have any permissions associated with it when it is created. After creation, customers delegate permissions to the service account. When the connection is used in the context of a stored procedure for Apache Spark in BigQuery, the service account is used to connect to the desired resources in Google Cloud.

The account ID is in the form of: bqcx-<projectnumber>-<uniqueid>@gcp-sa-bigquery-consp.iam.gserviceaccount.com

string service_account_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SparkProperties.Builder

This builder for chaining.

clearSparkHistoryServerConfig()

public SparkProperties.Builder clearSparkHistoryServerConfig()

Optional. Spark History Server configuration for the connection.

.google.cloud.bigquery.connection.v1.SparkHistoryServerConfig spark_history_server_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SparkProperties.Builder

clone()

public SparkProperties.Builder clone()
Returns
Type Description
SparkProperties.Builder
Overrides

getDefaultInstanceForType()

public SparkProperties getDefaultInstanceForType()
Returns
Type Description
SparkProperties

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getMetastoreServiceConfig()

public MetastoreServiceConfig getMetastoreServiceConfig()

Optional. Dataproc Metastore Service configuration for the connection.

.google.cloud.bigquery.connection.v1.MetastoreServiceConfig metastore_service_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetastoreServiceConfig

The metastoreServiceConfig.

getMetastoreServiceConfigBuilder()

public MetastoreServiceConfig.Builder getMetastoreServiceConfigBuilder()

Optional. Dataproc Metastore Service configuration for the connection.

.google.cloud.bigquery.connection.v1.MetastoreServiceConfig metastore_service_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetastoreServiceConfig.Builder

getMetastoreServiceConfigOrBuilder()

public MetastoreServiceConfigOrBuilder getMetastoreServiceConfigOrBuilder()

Optional. Dataproc Metastore Service configuration for the connection.

.google.cloud.bigquery.connection.v1.MetastoreServiceConfig metastore_service_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetastoreServiceConfigOrBuilder

getServiceAccountId()

public String getServiceAccountId()

Output only. The account ID of the service created for the purpose of this connection.

The service account does not have any permissions associated with it when it is created. After creation, customers delegate permissions to the service account. When the connection is used in the context of a stored procedure for Apache Spark in BigQuery, the service account is used to connect to the desired resources in Google Cloud.

The account ID is in the form of: bqcx-<projectnumber>-<uniqueid>@gcp-sa-bigquery-consp.iam.gserviceaccount.com

string service_account_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The serviceAccountId.

getServiceAccountIdBytes()

public ByteString getServiceAccountIdBytes()

Output only. The account ID of the service created for the purpose of this connection.

The service account does not have any permissions associated with it when it is created. After creation, customers delegate permissions to the service account. When the connection is used in the context of a stored procedure for Apache Spark in BigQuery, the service account is used to connect to the desired resources in Google Cloud.

The account ID is in the form of: bqcx-<projectnumber>-<uniqueid>@gcp-sa-bigquery-consp.iam.gserviceaccount.com

string service_account_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for serviceAccountId.

getSparkHistoryServerConfig()

public SparkHistoryServerConfig getSparkHistoryServerConfig()

Optional. Spark History Server configuration for the connection.

.google.cloud.bigquery.connection.v1.SparkHistoryServerConfig spark_history_server_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SparkHistoryServerConfig

The sparkHistoryServerConfig.

getSparkHistoryServerConfigBuilder()

public SparkHistoryServerConfig.Builder getSparkHistoryServerConfigBuilder()

Optional. Spark History Server configuration for the connection.

.google.cloud.bigquery.connection.v1.SparkHistoryServerConfig spark_history_server_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SparkHistoryServerConfig.Builder

getSparkHistoryServerConfigOrBuilder()

public SparkHistoryServerConfigOrBuilder getSparkHistoryServerConfigOrBuilder()

Optional. Spark History Server configuration for the connection.

.google.cloud.bigquery.connection.v1.SparkHistoryServerConfig spark_history_server_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SparkHistoryServerConfigOrBuilder

hasMetastoreServiceConfig()

public boolean hasMetastoreServiceConfig()

Optional. Dataproc Metastore Service configuration for the connection.

.google.cloud.bigquery.connection.v1.MetastoreServiceConfig metastore_service_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the metastoreServiceConfig field is set.

hasSparkHistoryServerConfig()

public boolean hasSparkHistoryServerConfig()

Optional. Spark History Server configuration for the connection.

.google.cloud.bigquery.connection.v1.SparkHistoryServerConfig spark_history_server_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the sparkHistoryServerConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SparkProperties other)

public SparkProperties.Builder mergeFrom(SparkProperties other)
Parameter
Name Description
other SparkProperties
Returns
Type Description
SparkProperties.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SparkProperties.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SparkProperties.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SparkProperties.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SparkProperties.Builder
Overrides

mergeMetastoreServiceConfig(MetastoreServiceConfig value)

public SparkProperties.Builder mergeMetastoreServiceConfig(MetastoreServiceConfig value)

Optional. Dataproc Metastore Service configuration for the connection.

.google.cloud.bigquery.connection.v1.MetastoreServiceConfig metastore_service_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value MetastoreServiceConfig
Returns
Type Description
SparkProperties.Builder

mergeSparkHistoryServerConfig(SparkHistoryServerConfig value)

public SparkProperties.Builder mergeSparkHistoryServerConfig(SparkHistoryServerConfig value)

Optional. Spark History Server configuration for the connection.

.google.cloud.bigquery.connection.v1.SparkHistoryServerConfig spark_history_server_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value SparkHistoryServerConfig
Returns
Type Description
SparkProperties.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SparkProperties.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SparkProperties.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public SparkProperties.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SparkProperties.Builder
Overrides

setMetastoreServiceConfig(MetastoreServiceConfig value)

public SparkProperties.Builder setMetastoreServiceConfig(MetastoreServiceConfig value)

Optional. Dataproc Metastore Service configuration for the connection.

.google.cloud.bigquery.connection.v1.MetastoreServiceConfig metastore_service_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value MetastoreServiceConfig
Returns
Type Description
SparkProperties.Builder

setMetastoreServiceConfig(MetastoreServiceConfig.Builder builderForValue)

public SparkProperties.Builder setMetastoreServiceConfig(MetastoreServiceConfig.Builder builderForValue)

Optional. Dataproc Metastore Service configuration for the connection.

.google.cloud.bigquery.connection.v1.MetastoreServiceConfig metastore_service_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue MetastoreServiceConfig.Builder
Returns
Type Description
SparkProperties.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SparkProperties.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
SparkProperties.Builder
Overrides

setServiceAccountId(String value)

public SparkProperties.Builder setServiceAccountId(String value)

Output only. The account ID of the service created for the purpose of this connection.

The service account does not have any permissions associated with it when it is created. After creation, customers delegate permissions to the service account. When the connection is used in the context of a stored procedure for Apache Spark in BigQuery, the service account is used to connect to the desired resources in Google Cloud.

The account ID is in the form of: bqcx-<projectnumber>-<uniqueid>@gcp-sa-bigquery-consp.iam.gserviceaccount.com

string service_account_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The serviceAccountId to set.

Returns
Type Description
SparkProperties.Builder

This builder for chaining.

setServiceAccountIdBytes(ByteString value)

public SparkProperties.Builder setServiceAccountIdBytes(ByteString value)

Output only. The account ID of the service created for the purpose of this connection.

The service account does not have any permissions associated with it when it is created. After creation, customers delegate permissions to the service account. When the connection is used in the context of a stored procedure for Apache Spark in BigQuery, the service account is used to connect to the desired resources in Google Cloud.

The account ID is in the form of: bqcx-<projectnumber>-<uniqueid>@gcp-sa-bigquery-consp.iam.gserviceaccount.com

string service_account_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for serviceAccountId to set.

Returns
Type Description
SparkProperties.Builder

This builder for chaining.

setSparkHistoryServerConfig(SparkHistoryServerConfig value)

public SparkProperties.Builder setSparkHistoryServerConfig(SparkHistoryServerConfig value)

Optional. Spark History Server configuration for the connection.

.google.cloud.bigquery.connection.v1.SparkHistoryServerConfig spark_history_server_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value SparkHistoryServerConfig
Returns
Type Description
SparkProperties.Builder

setSparkHistoryServerConfig(SparkHistoryServerConfig.Builder builderForValue)

public SparkProperties.Builder setSparkHistoryServerConfig(SparkHistoryServerConfig.Builder builderForValue)

Optional. Spark History Server configuration for the connection.

.google.cloud.bigquery.connection.v1.SparkHistoryServerConfig spark_history_server_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue SparkHistoryServerConfig.Builder
Returns
Type Description
SparkProperties.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final SparkProperties.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SparkProperties.Builder
Overrides