Class Task.SparkTaskConfig (1.30.0)

public static final class Task.SparkTaskConfig extends GeneratedMessageV3 implements Task.SparkTaskConfigOrBuilder

User-specified config for running a Spark task.

Protobuf type google.cloud.dataplex.v1.Task.SparkTaskConfig

Static Fields

ARCHIVE_URIS_FIELD_NUMBER

public static final int ARCHIVE_URIS_FIELD_NUMBER
Field Value
TypeDescription
int

FILE_URIS_FIELD_NUMBER

public static final int FILE_URIS_FIELD_NUMBER
Field Value
TypeDescription
int

INFRASTRUCTURE_SPEC_FIELD_NUMBER

public static final int INFRASTRUCTURE_SPEC_FIELD_NUMBER
Field Value
TypeDescription
int

MAIN_CLASS_FIELD_NUMBER

public static final int MAIN_CLASS_FIELD_NUMBER
Field Value
TypeDescription
int

MAIN_JAR_FILE_URI_FIELD_NUMBER

public static final int MAIN_JAR_FILE_URI_FIELD_NUMBER
Field Value
TypeDescription
int

PYTHON_SCRIPT_FILE_FIELD_NUMBER

public static final int PYTHON_SCRIPT_FILE_FIELD_NUMBER
Field Value
TypeDescription
int

SQL_SCRIPT_FIELD_NUMBER

public static final int SQL_SCRIPT_FIELD_NUMBER
Field Value
TypeDescription
int

SQL_SCRIPT_FILE_FIELD_NUMBER

public static final int SQL_SCRIPT_FILE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Task.SparkTaskConfig getDefaultInstance()
Returns
TypeDescription
Task.SparkTaskConfig

getDescriptor()

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

newBuilder()

public static Task.SparkTaskConfig.Builder newBuilder()
Returns
TypeDescription
Task.SparkTaskConfig.Builder

newBuilder(Task.SparkTaskConfig prototype)

public static Task.SparkTaskConfig.Builder newBuilder(Task.SparkTaskConfig prototype)
Parameter
NameDescription
prototypeTask.SparkTaskConfig
Returns
TypeDescription
Task.SparkTaskConfig.Builder

parseDelimitedFrom(InputStream input)

public static Task.SparkTaskConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Task.SparkTaskConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static Task.SparkTaskConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Task.SparkTaskConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static Task.SparkTaskConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Task.SparkTaskConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static Task.SparkTaskConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Task.SparkTaskConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static Task.SparkTaskConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Task.SparkTaskConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<Task.SparkTaskConfig> parser()
Returns
TypeDescription
Parser<SparkTaskConfig>

Methods

equals(Object obj)

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

getArchiveUris(int index)

public String getArchiveUris(int index)

Optional. Cloud Storage URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

repeated string archive_uris = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The archiveUris at the given index.

getArchiveUrisBytes(int index)

public ByteString getArchiveUrisBytes(int index)

Optional. Cloud Storage URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

repeated string archive_uris = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the archiveUris at the given index.

getArchiveUrisCount()

public int getArchiveUrisCount()

Optional. Cloud Storage URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

repeated string archive_uris = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The count of archiveUris.

getArchiveUrisList()

public ProtocolStringList getArchiveUrisList()

Optional. Cloud Storage URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

repeated string archive_uris = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ProtocolStringList

A list containing the archiveUris.

getDefaultInstanceForType()

public Task.SparkTaskConfig getDefaultInstanceForType()
Returns
TypeDescription
Task.SparkTaskConfig

getDriverCase()

public Task.SparkTaskConfig.DriverCase getDriverCase()
Returns
TypeDescription
Task.SparkTaskConfig.DriverCase

getFileUris(int index)

public String getFileUris(int index)

Optional. Cloud Storage URIs of files to be placed in the working directory of each executor.

repeated string file_uris = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The fileUris at the given index.

getFileUrisBytes(int index)

public ByteString getFileUrisBytes(int index)

Optional. Cloud Storage URIs of files to be placed in the working directory of each executor.

repeated string 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 fileUris at the given index.

getFileUrisCount()

public int getFileUrisCount()

Optional. Cloud Storage URIs of files to be placed in the working directory of each executor.

repeated string file_uris = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The count of fileUris.

getFileUrisList()

public ProtocolStringList getFileUrisList()

Optional. Cloud Storage URIs of files to be placed in the working directory of each executor.

repeated string file_uris = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ProtocolStringList

A list containing the fileUris.

getInfrastructureSpec()

public Task.InfrastructureSpec getInfrastructureSpec()

Optional. Infrastructure specification for the execution.

.google.cloud.dataplex.v1.Task.InfrastructureSpec infrastructure_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Task.InfrastructureSpec

The infrastructureSpec.

getInfrastructureSpecOrBuilder()

public Task.InfrastructureSpecOrBuilder getInfrastructureSpecOrBuilder()

Optional. Infrastructure specification for the execution.

.google.cloud.dataplex.v1.Task.InfrastructureSpec infrastructure_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Task.InfrastructureSpecOrBuilder

getMainClass()

public String getMainClass()

The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris. The execution args are passed in as a sequence of named process arguments (--key=value).

string main_class = 101;

Returns
TypeDescription
String

The mainClass.

getMainClassBytes()

public ByteString getMainClassBytes()

The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris. The execution args are passed in as a sequence of named process arguments (--key=value).

string main_class = 101;

Returns
TypeDescription
ByteString

The bytes for mainClass.

getMainJarFileUri()

public String getMainJarFileUri()

The Cloud Storage URI of the jar file that contains the main class. The execution args are passed in as a sequence of named process arguments (--key=value).

string main_jar_file_uri = 100;

Returns
TypeDescription
String

The mainJarFileUri.

getMainJarFileUriBytes()

public ByteString getMainJarFileUriBytes()

The Cloud Storage URI of the jar file that contains the main class. The execution args are passed in as a sequence of named process arguments (--key=value).

string main_jar_file_uri = 100;

Returns
TypeDescription
ByteString

The bytes for mainJarFileUri.

getParserForType()

public Parser<Task.SparkTaskConfig> getParserForType()
Returns
TypeDescription
Parser<SparkTaskConfig>
Overrides

getPythonScriptFile()

public String getPythonScriptFile()

The Gcloud Storage URI of the main Python file to use as the driver. Must be a .py file. The execution args are passed in as a sequence of named process arguments (--key=value).

string python_script_file = 102;

Returns
TypeDescription
String

The pythonScriptFile.

getPythonScriptFileBytes()

public ByteString getPythonScriptFileBytes()

The Gcloud Storage URI of the main Python file to use as the driver. Must be a .py file. The execution args are passed in as a sequence of named process arguments (--key=value).

string python_script_file = 102;

Returns
TypeDescription
ByteString

The bytes for pythonScriptFile.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSqlScript()

public String getSqlScript()

The query text. The execution args are used to declare a set of script variables (set key="value";).

string sql_script = 105;

Returns
TypeDescription
String

The sqlScript.

getSqlScriptBytes()

public ByteString getSqlScriptBytes()

The query text. The execution args are used to declare a set of script variables (set key="value";).

string sql_script = 105;

Returns
TypeDescription
ByteString

The bytes for sqlScript.

getSqlScriptFile()

public String getSqlScriptFile()

A reference to a query file. This can be the Cloud Storage URI of the query file or it can the path to a SqlScript Content. The execution args are used to declare a set of script variables (set key="value";).

string sql_script_file = 104;

Returns
TypeDescription
String

The sqlScriptFile.

getSqlScriptFileBytes()

public ByteString getSqlScriptFileBytes()

A reference to a query file. This can be the Cloud Storage URI of the query file or it can the path to a SqlScript Content. The execution args are used to declare a set of script variables (set key="value";).

string sql_script_file = 104;

Returns
TypeDescription
ByteString

The bytes for sqlScriptFile.

hasInfrastructureSpec()

public boolean hasInfrastructureSpec()

Optional. Infrastructure specification for the execution.

.google.cloud.dataplex.v1.Task.InfrastructureSpec infrastructure_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the infrastructureSpec field is set.

hasMainClass()

public boolean hasMainClass()

The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris. The execution args are passed in as a sequence of named process arguments (--key=value).

string main_class = 101;

Returns
TypeDescription
boolean

Whether the mainClass field is set.

hasMainJarFileUri()

public boolean hasMainJarFileUri()

The Cloud Storage URI of the jar file that contains the main class. The execution args are passed in as a sequence of named process arguments (--key=value).

string main_jar_file_uri = 100;

Returns
TypeDescription
boolean

Whether the mainJarFileUri field is set.

hasPythonScriptFile()

public boolean hasPythonScriptFile()

The Gcloud Storage URI of the main Python file to use as the driver. Must be a .py file. The execution args are passed in as a sequence of named process arguments (--key=value).

string python_script_file = 102;

Returns
TypeDescription
boolean

Whether the pythonScriptFile field is set.

hasSqlScript()

public boolean hasSqlScript()

The query text. The execution args are used to declare a set of script variables (set key="value";).

string sql_script = 105;

Returns
TypeDescription
boolean

Whether the sqlScript field is set.

hasSqlScriptFile()

public boolean hasSqlScriptFile()

A reference to a query file. This can be the Cloud Storage URI of the query file or it can the path to a SqlScript Content. The execution args are used to declare a set of script variables (set key="value";).

string sql_script_file = 104;

Returns
TypeDescription
boolean

Whether the sqlScriptFile field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Task.SparkTaskConfig.Builder newBuilderForType()
Returns
TypeDescription
Task.SparkTaskConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public Task.SparkTaskConfig.Builder toBuilder()
Returns
TypeDescription
Task.SparkTaskConfig.Builder

writeTo(CodedOutputStream output)

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