Class SparkSqlBatch (4.42.0)

public final class SparkSqlBatch extends GeneratedMessageV3 implements SparkSqlBatchOrBuilder

A configuration for running Apache Spark SQL queries as a batch workload.

Protobuf type google.cloud.dataproc.v1.SparkSqlBatch

Static Fields

JAR_FILE_URIS_FIELD_NUMBER

public static final int JAR_FILE_URIS_FIELD_NUMBER
Field Value
Type Description
int

QUERY_FILE_URI_FIELD_NUMBER

public static final int QUERY_FILE_URI_FIELD_NUMBER
Field Value
Type Description
int

QUERY_VARIABLES_FIELD_NUMBER

public static final int QUERY_VARIABLES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SparkSqlBatch getDefaultInstance()
Returns
Type Description
SparkSqlBatch

getDescriptor()

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

newBuilder()

public static SparkSqlBatch.Builder newBuilder()
Returns
Type Description
SparkSqlBatch.Builder

newBuilder(SparkSqlBatch prototype)

public static SparkSqlBatch.Builder newBuilder(SparkSqlBatch prototype)
Parameter
Name Description
prototype SparkSqlBatch
Returns
Type Description
SparkSqlBatch.Builder

parseDelimitedFrom(InputStream input)

public static SparkSqlBatch parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SparkSqlBatch
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SparkSqlBatch parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SparkSqlBatch
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SparkSqlBatch parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SparkSqlBatch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SparkSqlBatch parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SparkSqlBatch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SparkSqlBatch parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SparkSqlBatch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SparkSqlBatch parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SparkSqlBatch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SparkSqlBatch parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SparkSqlBatch
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SparkSqlBatch parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SparkSqlBatch
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SparkSqlBatch parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SparkSqlBatch
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SparkSqlBatch parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SparkSqlBatch
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SparkSqlBatch parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SparkSqlBatch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SparkSqlBatch parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SparkSqlBatch
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SparkSqlBatch> parser()
Returns
Type Description
Parser<SparkSqlBatch>

Methods

containsQueryVariables(String key)

public boolean containsQueryVariables(String key)

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

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

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public SparkSqlBatch getDefaultInstanceForType()
Returns
Type Description
SparkSqlBatch

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 = 3 [(.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 = 3 [(.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 = 3 [(.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 = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the jarFileUris.

getParserForType()

public Parser<SparkSqlBatch> getParserForType()
Returns
Type Description
Parser<SparkSqlBatch>
Overrides

getQueryFileUri()

public String getQueryFileUri()

Required. The HCFS URI of the script that contains Spark SQL queries to execute.

string query_file_uri = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The queryFileUri.

getQueryFileUriBytes()

public ByteString getQueryFileUriBytes()

Required. The HCFS URI of the script that contains Spark SQL queries to execute.

string query_file_uri = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for queryFileUri.

getQueryVariables() (deprecated)

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

getQueryVariablesCount()

public int getQueryVariablesCount()

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

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

Returns
Type Description
int

getQueryVariablesMap()

public Map<String,String> getQueryVariablesMap()

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

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

Returns
Type Description
Map<String,String>

getQueryVariablesOrDefault(String key, String defaultValue)

public String getQueryVariablesOrDefault(String key, String defaultValue)

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

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

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getQueryVariablesOrThrow(String key)

public String getQueryVariablesOrThrow(String key)

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

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

Parameter
Name Description
key String
Returns
Type Description
String

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

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.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SparkSqlBatch.Builder newBuilderForType()
Returns
Type Description
SparkSqlBatch.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SparkSqlBatch.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SparkSqlBatch.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SparkSqlBatch.Builder toBuilder()
Returns
Type Description
SparkSqlBatch.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException