Class SparkSqlJob.Builder (4.46.0)

public static final class SparkSqlJob.Builder extends GeneratedMessageV3.Builder<SparkSqlJob.Builder> implements SparkSqlJobOrBuilder

A Dataproc job for running Apache Spark SQL queries.

Protobuf type google.cloud.dataproc.v1.SparkSqlJob

Static Methods

getDescriptor()

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

Methods

addAllJarFileUris(Iterable<String> values)

public SparkSqlJob.Builder addAllJarFileUris(Iterable<String> values)

Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

repeated string jar_file_uris = 56 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<String>

The jarFileUris to add.

Returns
Type Description
SparkSqlJob.Builder

This builder for chaining.

addJarFileUris(String value)

public SparkSqlJob.Builder addJarFileUris(String value)

Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

repeated string jar_file_uris = 56 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The jarFileUris to add.

Returns
Type Description
SparkSqlJob.Builder

This builder for chaining.

addJarFileUrisBytes(ByteString value)

public SparkSqlJob.Builder addJarFileUrisBytes(ByteString value)

Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

repeated string jar_file_uris = 56 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes of the jarFileUris to add.

Returns
Type Description
SparkSqlJob.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public SparkSqlJob build()
Returns
Type Description
SparkSqlJob

buildPartial()

public SparkSqlJob buildPartial()
Returns
Type Description
SparkSqlJob

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearJarFileUris()

public SparkSqlJob.Builder clearJarFileUris()

Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

repeated string jar_file_uris = 56 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SparkSqlJob.Builder

This builder for chaining.

clearLoggingConfig()

public SparkSqlJob.Builder clearLoggingConfig()

Optional. The runtime log config for job execution.

.google.cloud.dataproc.v1.LoggingConfig logging_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SparkSqlJob.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearProperties()

public SparkSqlJob.Builder clearProperties()
Returns
Type Description
SparkSqlJob.Builder

clearQueries()

public SparkSqlJob.Builder clearQueries()
Returns
Type Description
SparkSqlJob.Builder

clearQueryFileUri()

public SparkSqlJob.Builder clearQueryFileUri()

The HCFS URI of the script that contains SQL queries.

string query_file_uri = 1;

Returns
Type Description
SparkSqlJob.Builder

This builder for chaining.

clearQueryList()

public SparkSqlJob.Builder clearQueryList()

A list of queries.

.google.cloud.dataproc.v1.QueryList query_list = 2;

Returns
Type Description
SparkSqlJob.Builder

clearScriptVariables()

public SparkSqlJob.Builder clearScriptVariables()
Returns
Type Description
SparkSqlJob.Builder

clone()

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

containsProperties(String key)

public boolean containsProperties(String key)

Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.

map<string, string> properties = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

containsScriptVariables(String key)

public boolean containsScriptVariables(String key)

Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).

map<string, string> script_variables = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getDefaultInstanceForType()

public SparkSqlJob getDefaultInstanceForType()
Returns
Type Description
SparkSqlJob

getDescriptorForType()

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

getJarFileUris(int index)

public String getJarFileUris(int index)

Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

repeated string jar_file_uris = 56 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The jarFileUris at the given index.

getJarFileUrisBytes(int index)

public ByteString getJarFileUrisBytes(int index)

Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

repeated string jar_file_uris = 56 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the jarFileUris at the given index.

getJarFileUrisCount()

public int getJarFileUrisCount()

Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

repeated string jar_file_uris = 56 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of jarFileUris.

getJarFileUrisList()

public ProtocolStringList getJarFileUrisList()

Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

repeated string jar_file_uris = 56 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the jarFileUris.

getLoggingConfig()

public LoggingConfig getLoggingConfig()

Optional. The runtime log config for job execution.

.google.cloud.dataproc.v1.LoggingConfig logging_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LoggingConfig

The loggingConfig.

getLoggingConfigBuilder()

public LoggingConfig.Builder getLoggingConfigBuilder()

Optional. The runtime log config for job execution.

.google.cloud.dataproc.v1.LoggingConfig logging_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LoggingConfig.Builder

getLoggingConfigOrBuilder()

public LoggingConfigOrBuilder getLoggingConfigOrBuilder()

Optional. The runtime log config for job execution.

.google.cloud.dataproc.v1.LoggingConfig logging_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LoggingConfigOrBuilder

getMutableProperties() (deprecated)

public Map<String,String> getMutableProperties()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getMutableScriptVariables() (deprecated)

public Map<String,String> getMutableScriptVariables()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getProperties() (deprecated)

public Map<String,String> getProperties()

Use #getPropertiesMap() instead.

Returns
Type Description
Map<String,String>

getPropertiesCount()

public int getPropertiesCount()

Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.

map<string, string> properties = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getPropertiesMap()

public Map<String,String> getPropertiesMap()

Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.

map<string, string> properties = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getPropertiesOrDefault(String key, String defaultValue)

public String getPropertiesOrDefault(String key, String defaultValue)

Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.

map<string, string> properties = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getPropertiesOrThrow(String key)

public String getPropertiesOrThrow(String key)

Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.

map<string, string> properties = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getQueriesCase()

public SparkSqlJob.QueriesCase getQueriesCase()
Returns
Type Description
SparkSqlJob.QueriesCase

getQueryFileUri()

public String getQueryFileUri()

The HCFS URI of the script that contains SQL queries.

string query_file_uri = 1;

Returns
Type Description
String

The queryFileUri.

getQueryFileUriBytes()

public ByteString getQueryFileUriBytes()

The HCFS URI of the script that contains SQL queries.

string query_file_uri = 1;

Returns
Type Description
ByteString

The bytes for queryFileUri.

getQueryList()

public QueryList getQueryList()

A list of queries.

.google.cloud.dataproc.v1.QueryList query_list = 2;

Returns
Type Description
QueryList

The queryList.

getQueryListBuilder()

public QueryList.Builder getQueryListBuilder()

A list of queries.

.google.cloud.dataproc.v1.QueryList query_list = 2;

Returns
Type Description
QueryList.Builder

getQueryListOrBuilder()

public QueryListOrBuilder getQueryListOrBuilder()

A list of queries.

.google.cloud.dataproc.v1.QueryList query_list = 2;

Returns
Type Description
QueryListOrBuilder

getScriptVariables() (deprecated)

public Map<String,String> getScriptVariables()
Returns
Type Description
Map<String,String>

getScriptVariablesCount()

public int getScriptVariablesCount()

Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).

map<string, string> script_variables = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getScriptVariablesMap()

public Map<String,String> getScriptVariablesMap()

Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).

map<string, string> script_variables = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getScriptVariablesOrDefault(String key, String defaultValue)

public String getScriptVariablesOrDefault(String key, String defaultValue)

Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).

map<string, string> script_variables = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getScriptVariablesOrThrow(String key)

public String getScriptVariablesOrThrow(String key)

Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).

map<string, string> script_variables = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

hasLoggingConfig()

public boolean hasLoggingConfig()

Optional. The runtime log config for job execution.

.google.cloud.dataproc.v1.LoggingConfig logging_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the loggingConfig field is set.

hasQueryFileUri()

public boolean hasQueryFileUri()

The HCFS URI of the script that contains SQL queries.

string query_file_uri = 1;

Returns
Type Description
boolean

Whether the queryFileUri field is set.

hasQueryList()

public boolean hasQueryList()

A list of queries.

.google.cloud.dataproc.v1.QueryList query_list = 2;

Returns
Type Description
boolean

Whether the queryList field is set.

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SparkSqlJob other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeLoggingConfig(LoggingConfig value)

public SparkSqlJob.Builder mergeLoggingConfig(LoggingConfig value)

Optional. The runtime log config for job execution.

.google.cloud.dataproc.v1.LoggingConfig logging_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value LoggingConfig
Returns
Type Description
SparkSqlJob.Builder

mergeQueryList(QueryList value)

public SparkSqlJob.Builder mergeQueryList(QueryList value)

A list of queries.

.google.cloud.dataproc.v1.QueryList query_list = 2;

Parameter
Name Description
value QueryList
Returns
Type Description
SparkSqlJob.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

putAllProperties(Map<String,String> values)

public SparkSqlJob.Builder putAllProperties(Map<String,String> values)

Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.

map<string, string> properties = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Map<String,String>
Returns
Type Description
SparkSqlJob.Builder

putAllScriptVariables(Map<String,String> values)

public SparkSqlJob.Builder putAllScriptVariables(Map<String,String> values)

Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).

map<string, string> script_variables = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Map<String,String>
Returns
Type Description
SparkSqlJob.Builder

putProperties(String key, String value)

public SparkSqlJob.Builder putProperties(String key, String value)

Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.

map<string, string> properties = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
value String
Returns
Type Description
SparkSqlJob.Builder

putScriptVariables(String key, String value)

public SparkSqlJob.Builder putScriptVariables(String key, String value)

Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).

map<string, string> script_variables = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
value String
Returns
Type Description
SparkSqlJob.Builder

removeProperties(String key)

public SparkSqlJob.Builder removeProperties(String key)

Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.

map<string, string> properties = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
SparkSqlJob.Builder

removeScriptVariables(String key)

public SparkSqlJob.Builder removeScriptVariables(String key)

Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).

map<string, string> script_variables = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
SparkSqlJob.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setJarFileUris(int index, String value)

public SparkSqlJob.Builder setJarFileUris(int index, String value)

Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

repeated string jar_file_uris = 56 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.

value String

The jarFileUris to set.

Returns
Type Description
SparkSqlJob.Builder

This builder for chaining.

setLoggingConfig(LoggingConfig value)

public SparkSqlJob.Builder setLoggingConfig(LoggingConfig value)

Optional. The runtime log config for job execution.

.google.cloud.dataproc.v1.LoggingConfig logging_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value LoggingConfig
Returns
Type Description
SparkSqlJob.Builder

setLoggingConfig(LoggingConfig.Builder builderForValue)

public SparkSqlJob.Builder setLoggingConfig(LoggingConfig.Builder builderForValue)

Optional. The runtime log config for job execution.

.google.cloud.dataproc.v1.LoggingConfig logging_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue LoggingConfig.Builder
Returns
Type Description
SparkSqlJob.Builder

setQueryFileUri(String value)

public SparkSqlJob.Builder setQueryFileUri(String value)

The HCFS URI of the script that contains SQL queries.

string query_file_uri = 1;

Parameter
Name Description
value String

The queryFileUri to set.

Returns
Type Description
SparkSqlJob.Builder

This builder for chaining.

setQueryFileUriBytes(ByteString value)

public SparkSqlJob.Builder setQueryFileUriBytes(ByteString value)

The HCFS URI of the script that contains SQL queries.

string query_file_uri = 1;

Parameter
Name Description
value ByteString

The bytes for queryFileUri to set.

Returns
Type Description
SparkSqlJob.Builder

This builder for chaining.

setQueryList(QueryList value)

public SparkSqlJob.Builder setQueryList(QueryList value)

A list of queries.

.google.cloud.dataproc.v1.QueryList query_list = 2;

Parameter
Name Description
value QueryList
Returns
Type Description
SparkSqlJob.Builder

setQueryList(QueryList.Builder builderForValue)

public SparkSqlJob.Builder setQueryList(QueryList.Builder builderForValue)

A list of queries.

.google.cloud.dataproc.v1.QueryList query_list = 2;

Parameter
Name Description
builderForValue QueryList.Builder
Returns
Type Description
SparkSqlJob.Builder

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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