Class FlinkJob.Builder (4.48.0)

public static final class FlinkJob.Builder extends GeneratedMessageV3.Builder<FlinkJob.Builder> implements FlinkJobOrBuilder

A Dataproc job for running Apache Flink applications on YARN.

Protobuf type google.cloud.dataproc.v1.FlinkJob

Implements

FlinkJobOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllArgs(Iterable<String> values)

public FlinkJob.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 might occur that causes an incorrect job submission.

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

Parameter
Name Description
values Iterable<String>

The args to add.

Returns
Type Description
FlinkJob.Builder

This builder for chaining.

addAllJarFileUris(Iterable<String> values)

public FlinkJob.Builder addAllJarFileUris(Iterable<String> values)

Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Flink driver and tasks.

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

Parameter
Name Description
values Iterable<String>

The jarFileUris to add.

Returns
Type Description
FlinkJob.Builder

This builder for chaining.

addArgs(String value)

public FlinkJob.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 might occur that causes an incorrect job submission.

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

Parameter
Name Description
value String

The args to add.

Returns
Type Description
FlinkJob.Builder

This builder for chaining.

addArgsBytes(ByteString value)

public FlinkJob.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 might occur that causes an incorrect job submission.

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

Parameter
Name Description
value ByteString

The bytes of the args to add.

Returns
Type Description
FlinkJob.Builder

This builder for chaining.

addJarFileUris(String value)

public FlinkJob.Builder addJarFileUris(String value)

Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Flink driver and tasks.

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

Parameter
Name Description
value String

The jarFileUris to add.

Returns
Type Description
FlinkJob.Builder

This builder for chaining.

addJarFileUrisBytes(ByteString value)

public FlinkJob.Builder addJarFileUrisBytes(ByteString value)

Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Flink driver and tasks.

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

Parameter
Name Description
value ByteString

The bytes of the jarFileUris to add.

Returns
Type Description
FlinkJob.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public FlinkJob.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FlinkJob.Builder
Overrides

build()

public FlinkJob build()
Returns
Type Description
FlinkJob

buildPartial()

public FlinkJob buildPartial()
Returns
Type Description
FlinkJob

clear()

public FlinkJob.Builder clear()
Returns
Type Description
FlinkJob.Builder
Overrides

clearArgs()

public FlinkJob.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 might occur that causes an incorrect job submission.

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

Returns
Type Description
FlinkJob.Builder

This builder for chaining.

clearDriver()

public FlinkJob.Builder clearDriver()
Returns
Type Description
FlinkJob.Builder

clearField(Descriptors.FieldDescriptor field)

public FlinkJob.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
FlinkJob.Builder
Overrides

clearJarFileUris()

public FlinkJob.Builder clearJarFileUris()

Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Flink driver and tasks.

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

Returns
Type Description
FlinkJob.Builder

This builder for chaining.

clearLoggingConfig()

public FlinkJob.Builder clearLoggingConfig()

Optional. The runtime log config for job execution.

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

Returns
Type Description
FlinkJob.Builder

clearMainClass()

public FlinkJob.Builder clearMainClass()

The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jarFileUris.

string main_class = 2;

Returns
Type Description
FlinkJob.Builder

This builder for chaining.

clearMainJarFileUri()

public FlinkJob.Builder clearMainJarFileUri()

The HCFS URI of the jar file that contains the main class.

string main_jar_file_uri = 1;

Returns
Type Description
FlinkJob.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public FlinkJob.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
FlinkJob.Builder
Overrides

clearProperties()

public FlinkJob.Builder clearProperties()
Returns
Type Description
FlinkJob.Builder

clearSavepointUri()

public FlinkJob.Builder clearSavepointUri()

Optional. HCFS URI of the savepoint, which contains the last saved progress for starting the current job.

string savepoint_uri = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FlinkJob.Builder

This builder for chaining.

clone()

public FlinkJob.Builder clone()
Returns
Type Description
FlinkJob.Builder
Overrides

containsProperties(String key)

public boolean containsProperties(String key)

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

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

Parameter
Name Description
key String
Returns
Type Description
boolean

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 might occur that causes an incorrect job submission.

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

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
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 might occur that causes an incorrect job submission.

repeated string args = 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 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 might occur that causes an incorrect job submission.

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

Returns
Type Description
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 might occur that causes an incorrect job submission.

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

Returns
Type Description
ProtocolStringList

A list containing the args.

getDefaultInstanceForType()

public FlinkJob getDefaultInstanceForType()
Returns
Type Description
FlinkJob

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDriverCase()

public FlinkJob.DriverCase getDriverCase()
Returns
Type Description
FlinkJob.DriverCase

getJarFileUris(int index)

public String getJarFileUris(int index)

Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Flink driver and tasks.

repeated string jar_file_uris = 4 [(.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 add to the CLASSPATHs of the Flink driver and tasks.

repeated string jar_file_uris = 4 [(.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 add to the CLASSPATHs of the Flink driver and tasks.

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

Returns
Type Description
int

The count of jarFileUris.

getJarFileUrisList()

public ProtocolStringList getJarFileUrisList()

Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Flink driver and tasks.

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

Returns
Type Description
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 = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LoggingConfig

The loggingConfig.

getLoggingConfigBuilder()

public LoggingConfig.Builder getLoggingConfigBuilder()

Optional. The runtime log config for job execution.

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

Returns
Type Description
LoggingConfig.Builder

getLoggingConfigOrBuilder()

public LoggingConfigOrBuilder getLoggingConfigOrBuilder()

Optional. The runtime log config for job execution.

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

Returns
Type Description
LoggingConfigOrBuilder

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 jarFileUris.

string main_class = 2;

Returns
Type Description
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 jarFileUris.

string main_class = 2;

Returns
Type Description
ByteString

The bytes for mainClass.

getMainJarFileUri()

public String getMainJarFileUri()

The HCFS URI of the jar file that contains the main class.

string main_jar_file_uri = 1;

Returns
Type Description
String

The mainJarFileUri.

getMainJarFileUriBytes()

public ByteString getMainJarFileUriBytes()

The HCFS URI of the jar file that contains the main class.

string main_jar_file_uri = 1;

Returns
Type Description
ByteString

The bytes for mainJarFileUri.

getMutableProperties() (deprecated)

public Map<String,String> getMutableProperties()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getProperties() (deprecated)

public Map<String,String> getProperties()

Use #getPropertiesMap() instead.

Returns
Type Description
Map<String,String>

getPropertiesCount()

public int getPropertiesCount()

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

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

Returns
Type Description
int

getPropertiesMap()

public Map<String,String> getPropertiesMap()

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

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

Returns
Type Description
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 Flink. Properties that conflict with values set by the Dataproc API might be overwritten. Can include properties set in /etc/flink/conf/flink-defaults.conf and classes in user code.

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

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getPropertiesOrThrow(String key)

public String getPropertiesOrThrow(String key)

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

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

Parameter
Name Description
key String
Returns
Type Description
String

getSavepointUri()

public String getSavepointUri()

Optional. HCFS URI of the savepoint, which contains the last saved progress for starting the current job.

string savepoint_uri = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The savepointUri.

getSavepointUriBytes()

public ByteString getSavepointUriBytes()

Optional. HCFS URI of the savepoint, which contains the last saved progress for starting the current job.

string savepoint_uri = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for savepointUri.

hasLoggingConfig()

public boolean hasLoggingConfig()

Optional. The runtime log config for job execution.

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

Returns
Type Description
boolean

Whether the loggingConfig 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 jarFileUris.

string main_class = 2;

Returns
Type Description
boolean

Whether the mainClass field is set.

hasMainJarFileUri()

public boolean hasMainJarFileUri()

The HCFS URI of the jar file that contains the main class.

string main_jar_file_uri = 1;

Returns
Type Description
boolean

Whether the mainJarFileUri field is set.

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

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(FlinkJob other)

public FlinkJob.Builder mergeFrom(FlinkJob other)
Parameter
Name Description
other FlinkJob
Returns
Type Description
FlinkJob.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public FlinkJob.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FlinkJob.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public FlinkJob.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
FlinkJob.Builder
Overrides

mergeLoggingConfig(LoggingConfig value)

public FlinkJob.Builder mergeLoggingConfig(LoggingConfig value)

Optional. The runtime log config for job execution.

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

Parameter
Name Description
value LoggingConfig
Returns
Type Description
FlinkJob.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final FlinkJob.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FlinkJob.Builder
Overrides

putAllProperties(Map<String,String> values)

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

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

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

Parameter
Name Description
values Map<String,String>
Returns
Type Description
FlinkJob.Builder

putProperties(String key, String value)

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

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

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

Parameters
Name Description
key String
value String
Returns
Type Description
FlinkJob.Builder

removeProperties(String key)

public FlinkJob.Builder removeProperties(String key)

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

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

Parameter
Name Description
key String
Returns
Type Description
FlinkJob.Builder

setArgs(int index, String value)

public FlinkJob.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 might occur that causes an incorrect job submission.

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

Parameters
Name Description
index int

The index to set the value at.

value String

The args to set.

Returns
Type Description
FlinkJob.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public FlinkJob.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FlinkJob.Builder
Overrides

setJarFileUris(int index, String value)

public FlinkJob.Builder setJarFileUris(int index, String value)

Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Flink driver and tasks.

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

Parameters
Name Description
index int

The index to set the value at.

value String

The jarFileUris to set.

Returns
Type Description
FlinkJob.Builder

This builder for chaining.

setLoggingConfig(LoggingConfig value)

public FlinkJob.Builder setLoggingConfig(LoggingConfig value)

Optional. The runtime log config for job execution.

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

Parameter
Name Description
value LoggingConfig
Returns
Type Description
FlinkJob.Builder

setLoggingConfig(LoggingConfig.Builder builderForValue)

public FlinkJob.Builder setLoggingConfig(LoggingConfig.Builder builderForValue)

Optional. The runtime log config for job execution.

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

Parameter
Name Description
builderForValue LoggingConfig.Builder
Returns
Type Description
FlinkJob.Builder

setMainClass(String value)

public FlinkJob.Builder setMainClass(String value)

The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jarFileUris.

string main_class = 2;

Parameter
Name Description
value String

The mainClass to set.

Returns
Type Description
FlinkJob.Builder

This builder for chaining.

setMainClassBytes(ByteString value)

public FlinkJob.Builder setMainClassBytes(ByteString value)

The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jarFileUris.

string main_class = 2;

Parameter
Name Description
value ByteString

The bytes for mainClass to set.

Returns
Type Description
FlinkJob.Builder

This builder for chaining.

setMainJarFileUri(String value)

public FlinkJob.Builder setMainJarFileUri(String value)

The HCFS URI of the jar file that contains the main class.

string main_jar_file_uri = 1;

Parameter
Name Description
value String

The mainJarFileUri to set.

Returns
Type Description
FlinkJob.Builder

This builder for chaining.

setMainJarFileUriBytes(ByteString value)

public FlinkJob.Builder setMainJarFileUriBytes(ByteString value)

The HCFS URI of the jar file that contains the main class.

string main_jar_file_uri = 1;

Parameter
Name Description
value ByteString

The bytes for mainJarFileUri to set.

Returns
Type Description
FlinkJob.Builder

This builder for chaining.

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

public FlinkJob.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
FlinkJob.Builder
Overrides

setSavepointUri(String value)

public FlinkJob.Builder setSavepointUri(String value)

Optional. HCFS URI of the savepoint, which contains the last saved progress for starting the current job.

string savepoint_uri = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The savepointUri to set.

Returns
Type Description
FlinkJob.Builder

This builder for chaining.

setSavepointUriBytes(ByteString value)

public FlinkJob.Builder setSavepointUriBytes(ByteString value)

Optional. HCFS URI of the savepoint, which contains the last saved progress for starting the current job.

string savepoint_uri = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for savepointUri to set.

Returns
Type Description
FlinkJob.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final FlinkJob.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FlinkJob.Builder
Overrides