Class SparkSqlBatch (4.28.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
TypeDescription
int

QUERY_FILE_URI_FIELD_NUMBER

public static final int QUERY_FILE_URI_FIELD_NUMBER
Field Value
TypeDescription
int

QUERY_VARIABLES_FIELD_NUMBER

public static final int QUERY_VARIABLES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SparkSqlBatch getDefaultInstance()
Returns
TypeDescription
SparkSqlBatch

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SparkSqlBatch.Builder newBuilder()
Returns
TypeDescription
SparkSqlBatch.Builder

newBuilder(SparkSqlBatch prototype)

public static SparkSqlBatch.Builder newBuilder(SparkSqlBatch prototype)
Parameter
NameDescription
prototypeSparkSqlBatch
Returns
TypeDescription
SparkSqlBatch.Builder

parseDelimitedFrom(InputStream input)

public static SparkSqlBatch parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SparkSqlBatch
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SparkSqlBatch parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SparkSqlBatch
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SparkSqlBatch parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SparkSqlBatch
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SparkSqlBatch parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SparkSqlBatch
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SparkSqlBatch parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SparkSqlBatch
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SparkSqlBatch parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SparkSqlBatch
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SparkSqlBatch parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SparkSqlBatch
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SparkSqlBatch parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SparkSqlBatch
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SparkSqlBatch parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SparkSqlBatch
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SparkSqlBatch parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SparkSqlBatch
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SparkSqlBatch parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SparkSqlBatch
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SparkSqlBatch parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SparkSqlBatch
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SparkSqlBatch> parser()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public SparkSqlBatch getDefaultInstanceForType()
Returns
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ProtocolStringList

A list containing the jarFileUris.

getParserForType()

public Parser<SparkSqlBatch> getParserForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for queryFileUri.

getQueryVariables() (deprecated)

public Map<String,String> getQueryVariables()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
String

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SparkSqlBatch.Builder newBuilderForType()
Returns
TypeDescription
SparkSqlBatch.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SparkSqlBatch.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SparkSqlBatch.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SparkSqlBatch.Builder toBuilder()
Returns
TypeDescription
SparkSqlBatch.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException