Class SparkSqlJob (4.17.0)

public final class SparkSqlJob extends GeneratedMessageV3 implements SparkSqlJobOrBuilder

A Dataproc job for running Apache Spark SQL queries.

Protobuf type google.cloud.dataproc.v1.SparkSqlJob

Static Fields

JAR_FILE_URIS_FIELD_NUMBER

public static final int JAR_FILE_URIS_FIELD_NUMBER
Field Value
TypeDescription
int

LOGGING_CONFIG_FIELD_NUMBER

public static final int LOGGING_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

PROPERTIES_FIELD_NUMBER

public static final int PROPERTIES_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_LIST_FIELD_NUMBER

public static final int QUERY_LIST_FIELD_NUMBER
Field Value
TypeDescription
int

SCRIPT_VARIABLES_FIELD_NUMBER

public static final int SCRIPT_VARIABLES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SparkSqlJob getDefaultInstance()
Returns
TypeDescription
SparkSqlJob

getDescriptor()

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

newBuilder()

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

newBuilder(SparkSqlJob prototype)

public static SparkSqlJob.Builder newBuilder(SparkSqlJob prototype)
Parameter
NameDescription
prototypeSparkSqlJob
Returns
TypeDescription
SparkSqlJob.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<SparkSqlJob> parser()
Returns
TypeDescription
Parser<SparkSqlJob>

Methods

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
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

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

getDefaultInstanceForType()

public SparkSqlJob getDefaultInstanceForType()
Returns
TypeDescription
SparkSqlJob

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

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

The loggingConfig.

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
TypeDescription
LoggingConfigOrBuilder

getParserForType()

public Parser<SparkSqlJob> getParserForType()
Returns
TypeDescription
Parser<SparkSqlJob>
Overrides

getProperties()

public Map<String,String> getProperties()

Use #getPropertiesMap() instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
String

getQueriesCase()

public SparkSqlJob.QueriesCase getQueriesCase()
Returns
TypeDescription
SparkSqlJob.QueriesCase

getQueryFileUri()

public String getQueryFileUri()

The HCFS URI of the script that contains SQL queries.

string query_file_uri = 1;

Returns
TypeDescription
String

The queryFileUri.

getQueryFileUriBytes()

public ByteString getQueryFileUriBytes()

The HCFS URI of the script that contains SQL queries.

string query_file_uri = 1;

Returns
TypeDescription
ByteString

The bytes for queryFileUri.

getQueryList()

public QueryList getQueryList()

A list of queries.

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

Returns
TypeDescription
QueryList

The queryList.

getQueryListOrBuilder()

public QueryListOrBuilder getQueryListOrBuilder()

A list of queries.

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

Returns
TypeDescription
QueryListOrBuilder

getScriptVariables()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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
TypeDescription
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
TypeDescription
boolean

Whether the queryFileUri field is set.

hasQueryList()

public boolean hasQueryList()

A list of queries.

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

Returns
TypeDescription
boolean

Whether the queryList field is set.

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 SparkSqlJob.Builder newBuilderForType()
Returns
TypeDescription
SparkSqlJob.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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