Class SparkRJob.Builder (4.25.0)

public static final class SparkRJob.Builder extends GeneratedMessageV3.Builder<SparkRJob.Builder> implements SparkRJobOrBuilder

A Dataproc job for running Apache SparkR applications on YARN.

Protobuf type google.cloud.dataproc.v1.SparkRJob

Implements

SparkRJobOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllArchiveUris(Iterable<String> values)

public SparkRJob.Builder addAllArchiveUris(Iterable<String> values)

Optional. HCFS 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
valuesIterable<String>

The archiveUris to add.

Returns
TypeDescription
SparkRJob.Builder

This builder for chaining.

addAllArgs(Iterable<String> values)

public SparkRJob.Builder addAllArgs(Iterable<String> values)

Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.

repeated string args = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valuesIterable<String>

The args to add.

Returns
TypeDescription
SparkRJob.Builder

This builder for chaining.

addAllFileUris(Iterable<String> values)

public SparkRJob.Builder addAllFileUris(Iterable<String> values)

Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

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

Parameter
NameDescription
valuesIterable<String>

The fileUris to add.

Returns
TypeDescription
SparkRJob.Builder

This builder for chaining.

addArchiveUris(String value)

public SparkRJob.Builder addArchiveUris(String value)

Optional. HCFS 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
valueString

The archiveUris to add.

Returns
TypeDescription
SparkRJob.Builder

This builder for chaining.

addArchiveUrisBytes(ByteString value)

public SparkRJob.Builder addArchiveUrisBytes(ByteString value)

Optional. HCFS 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
valueByteString

The bytes of the archiveUris to add.

Returns
TypeDescription
SparkRJob.Builder

This builder for chaining.

addArgs(String value)

public SparkRJob.Builder addArgs(String value)

Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.

repeated string args = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueString

The args to add.

Returns
TypeDescription
SparkRJob.Builder

This builder for chaining.

addArgsBytes(ByteString value)

public SparkRJob.Builder addArgsBytes(ByteString value)

Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.

repeated string args = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueByteString

The bytes of the args to add.

Returns
TypeDescription
SparkRJob.Builder

This builder for chaining.

addFileUris(String value)

public SparkRJob.Builder addFileUris(String value)

Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

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

Parameter
NameDescription
valueString

The fileUris to add.

Returns
TypeDescription
SparkRJob.Builder

This builder for chaining.

addFileUrisBytes(ByteString value)

public SparkRJob.Builder addFileUrisBytes(ByteString value)

Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

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

Parameter
NameDescription
valueByteString

The bytes of the fileUris to add.

Returns
TypeDescription
SparkRJob.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SparkRJob.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SparkRJob.Builder
Overrides

build()

public SparkRJob build()
Returns
TypeDescription
SparkRJob

buildPartial()

public SparkRJob buildPartial()
Returns
TypeDescription
SparkRJob

clear()

public SparkRJob.Builder clear()
Returns
TypeDescription
SparkRJob.Builder
Overrides

clearArchiveUris()

public SparkRJob.Builder clearArchiveUris()

Optional. HCFS 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
SparkRJob.Builder

This builder for chaining.

clearArgs()

public SparkRJob.Builder clearArgs()

Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.

repeated string args = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
SparkRJob.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SparkRJob.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
SparkRJob.Builder
Overrides

clearFileUris()

public SparkRJob.Builder clearFileUris()

Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

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

Returns
TypeDescription
SparkRJob.Builder

This builder for chaining.

clearLoggingConfig()

public SparkRJob.Builder clearLoggingConfig()

Optional. The runtime log config for job execution.

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

Returns
TypeDescription
SparkRJob.Builder

clearMainRFileUri()

public SparkRJob.Builder clearMainRFileUri()

Required. The HCFS URI of the main R file to use as the driver. Must be a .R file.

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

Returns
TypeDescription
SparkRJob.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SparkRJob.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
SparkRJob.Builder
Overrides

clearProperties()

public SparkRJob.Builder clearProperties()
Returns
TypeDescription
SparkRJob.Builder

clone()

public SparkRJob.Builder clone()
Returns
TypeDescription
SparkRJob.Builder
Overrides

containsProperties(String key)

public boolean containsProperties(String key)

Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

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

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getArchiveUris(int index)

public String getArchiveUris(int index)

Optional. HCFS 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. HCFS 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. HCFS 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. HCFS 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.

getArgs(int index)

public String getArgs(int index)

Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.

repeated string args = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The args at the given index.

getArgsBytes(int index)

public ByteString getArgsBytes(int index)

Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.

repeated string args = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the args at the given index.

getArgsCount()

public int getArgsCount()

Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.

repeated string args = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The count of args.

getArgsList()

public ProtocolStringList getArgsList()

Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.

repeated string args = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ProtocolStringList

A list containing the args.

getDefaultInstanceForType()

public SparkRJob getDefaultInstanceForType()
Returns
TypeDescription
SparkRJob

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFileUris(int index)

public String getFileUris(int index)

Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

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. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

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. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

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

Returns
TypeDescription
int

The count of fileUris.

getFileUrisList()

public ProtocolStringList getFileUrisList()

Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

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

Returns
TypeDescription
ProtocolStringList

A list containing the fileUris.

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.

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

getMainRFileUri()

public String getMainRFileUri()

Required. The HCFS URI of the main R file to use as the driver. Must be a .R file.

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

Returns
TypeDescription
String

The mainRFileUri.

getMainRFileUriBytes()

public ByteString getMainRFileUriBytes()

Required. The HCFS URI of the main R file to use as the driver. Must be a .R file.

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

Returns
TypeDescription
ByteString

The bytes for mainRFileUri.

getMutableProperties()

public Map<String,String> getMutableProperties()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

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 SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

map<string, string> properties = 5 [(.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 SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

map<string, string> properties = 5 [(.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 SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

map<string, string> properties = 5 [(.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 SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

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

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

Whether the loggingConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

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

internalGetMutableMapField(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(SparkRJob other)

public SparkRJob.Builder mergeFrom(SparkRJob other)
Parameter
NameDescription
otherSparkRJob
Returns
TypeDescription
SparkRJob.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SparkRJob.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SparkRJob.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public SparkRJob.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
SparkRJob.Builder
Overrides

mergeLoggingConfig(LoggingConfig value)

public SparkRJob.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
NameDescription
valueLoggingConfig
Returns
TypeDescription
SparkRJob.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SparkRJob.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SparkRJob.Builder
Overrides

putAllProperties(Map<String,String> values)

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

Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

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

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
SparkRJob.Builder

putProperties(String key, String value)

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

Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

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

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
SparkRJob.Builder

removeProperties(String key)

public SparkRJob.Builder removeProperties(String key)

Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

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

Parameter
NameDescription
keyString
Returns
TypeDescription
SparkRJob.Builder

setArchiveUris(int index, String value)

public SparkRJob.Builder setArchiveUris(int index, String value)

Optional. HCFS 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];

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The archiveUris to set.

Returns
TypeDescription
SparkRJob.Builder

This builder for chaining.

setArgs(int index, String value)

public SparkRJob.Builder setArgs(int index, String value)

Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.

repeated string args = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The args to set.

Returns
TypeDescription
SparkRJob.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public SparkRJob.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SparkRJob.Builder
Overrides

setFileUris(int index, String value)

public SparkRJob.Builder setFileUris(int index, String value)

Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

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

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The fileUris to set.

Returns
TypeDescription
SparkRJob.Builder

This builder for chaining.

setLoggingConfig(LoggingConfig value)

public SparkRJob.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
NameDescription
valueLoggingConfig
Returns
TypeDescription
SparkRJob.Builder

setLoggingConfig(LoggingConfig.Builder builderForValue)

public SparkRJob.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
NameDescription
builderForValueLoggingConfig.Builder
Returns
TypeDescription
SparkRJob.Builder

setMainRFileUri(String value)

public SparkRJob.Builder setMainRFileUri(String value)

Required. The HCFS URI of the main R file to use as the driver. Must be a .R file.

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

Parameter
NameDescription
valueString

The mainRFileUri to set.

Returns
TypeDescription
SparkRJob.Builder

This builder for chaining.

setMainRFileUriBytes(ByteString value)

public SparkRJob.Builder setMainRFileUriBytes(ByteString value)

Required. The HCFS URI of the main R file to use as the driver. Must be a .R file.

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

Parameter
NameDescription
valueByteString

The bytes for mainRFileUri to set.

Returns
TypeDescription
SparkRJob.Builder

This builder for chaining.

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

public SparkRJob.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
SparkRJob.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final SparkRJob.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SparkRJob.Builder
Overrides