Class FlexTemplateRuntimeEnvironment.Builder (0.5.0)

public static final class FlexTemplateRuntimeEnvironment.Builder extends GeneratedMessageV3.Builder<FlexTemplateRuntimeEnvironment.Builder> implements FlexTemplateRuntimeEnvironmentOrBuilder

The environment values to be set at runtime for flex template.

Protobuf type google.dataflow.v1beta3.FlexTemplateRuntimeEnvironment

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > FlexTemplateRuntimeEnvironment.Builder

Implements

FlexTemplateRuntimeEnvironmentOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addAdditionalExperiments(String value)

public FlexTemplateRuntimeEnvironment.Builder addAdditionalExperiments(String value)

Additional experiment flags for the job.

repeated string additional_experiments = 7;

Parameter

Name	Description
value	`String` The additionalExperiments to add.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

addAdditionalExperimentsBytes(ByteString value)

public FlexTemplateRuntimeEnvironment.Builder addAdditionalExperimentsBytes(ByteString value)

Additional experiment flags for the job.

repeated string additional_experiments = 7;

Parameter

Name	Description
value	`ByteString` The bytes of the additionalExperiments to add.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

addAllAdditionalExperiments(Iterable<String> values)

public FlexTemplateRuntimeEnvironment.Builder addAllAdditionalExperiments(Iterable<String> values)

Additional experiment flags for the job.

repeated string additional_experiments = 7;

Parameter

Name	Description
values	`Iterable<String>` The additionalExperiments to add.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public FlexTemplateRuntimeEnvironment.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public FlexTemplateRuntimeEnvironment build()

Returns

Type	Description
FlexTemplateRuntimeEnvironment

buildPartial()

public FlexTemplateRuntimeEnvironment buildPartial()

Returns

Type	Description
FlexTemplateRuntimeEnvironment

clear()

public FlexTemplateRuntimeEnvironment.Builder clear()

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAdditionalExperiments()

public FlexTemplateRuntimeEnvironment.Builder clearAdditionalExperiments()

Additional experiment flags for the job.

repeated string additional_experiments = 7;

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

clearAdditionalUserLabels()

public FlexTemplateRuntimeEnvironment.Builder clearAdditionalUserLabels()

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder

clearAutoscalingAlgorithm()

public FlexTemplateRuntimeEnvironment.Builder clearAutoscalingAlgorithm()

The algorithm to use for autoscaling

.google.dataflow.v1beta3.AutoscalingAlgorithm autoscaling_algorithm = 21;

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

clearDiskSizeGb()

public FlexTemplateRuntimeEnvironment.Builder clearDiskSizeGb()

Worker disk size, in gigabytes.

int32 disk_size_gb = 20;

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

clearDumpHeapOnOom()

public FlexTemplateRuntimeEnvironment.Builder clearDumpHeapOnOom()

If true, save a heap dump before killing a thread or process which is GC thrashing or out of memory. The location of the heap file will either be echoed back to the user, or the user will be given the opportunity to download the heap file.

bool dump_heap_on_oom = 22;

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

clearEnableStreamingEngine()

public FlexTemplateRuntimeEnvironment.Builder clearEnableStreamingEngine()

Whether to enable Streaming Engine for the job.

bool enable_streaming_engine = 15;

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public FlexTemplateRuntimeEnvironment.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	`FieldDescriptor`

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFlexrsGoal()

public FlexTemplateRuntimeEnvironment.Builder clearFlexrsGoal()

Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs

.google.dataflow.v1beta3.FlexResourceSchedulingGoal flexrs_goal = 16;

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

clearIpConfiguration()

public FlexTemplateRuntimeEnvironment.Builder clearIpConfiguration()

Configuration for VM IPs.

.google.dataflow.v1beta3.WorkerIPAddressConfiguration ip_configuration = 12;

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

clearKmsKeyName()

public FlexTemplateRuntimeEnvironment.Builder clearKmsKeyName()

Name for the Cloud KMS key for the job. Key format is: projects/<project>/locations/<location>/keyRings/<keyring>/cryptoKeys/<key>

string kms_key_name = 11;

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

clearLauncherMachineType()

public FlexTemplateRuntimeEnvironment.Builder clearLauncherMachineType()

The machine type to use for launching the job. The default is n1-standard-1.

string launcher_machine_type = 24;

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

clearMachineType()

public FlexTemplateRuntimeEnvironment.Builder clearMachineType()

The machine type to use for the job. Defaults to the value from the template if not specified.

string machine_type = 6;

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

clearMaxWorkers()

public FlexTemplateRuntimeEnvironment.Builder clearMaxWorkers()

The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.

int32 max_workers = 2;

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

clearNetwork()

public FlexTemplateRuntimeEnvironment.Builder clearNetwork()

Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".

string network = 8;

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

clearNumWorkers()

public FlexTemplateRuntimeEnvironment.Builder clearNumWorkers()

The initial number of Google Compute Engine instances for the job.

int32 num_workers = 1;

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public FlexTemplateRuntimeEnvironment.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	`OneofDescriptor`

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearSaveHeapDumpsToGcsPath()

public FlexTemplateRuntimeEnvironment.Builder clearSaveHeapDumpsToGcsPath()

Cloud Storage bucket (directory) to upload heap dumps to the given location. Enabling this implies that heap dumps should be generated on OOM (dump_heap_on_oom is set to true).

string save_heap_dumps_to_gcs_path = 23;

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

clearSdkContainerImage()

public FlexTemplateRuntimeEnvironment.Builder clearSdkContainerImage()

Docker registry location of container image to use for the 'worker harness. Default is the container for the version of the SDK. Note this field is only valid for portable pipelines.

string sdk_container_image = 18;

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

clearServiceAccountEmail()

public FlexTemplateRuntimeEnvironment.Builder clearServiceAccountEmail()

The email address of the service account to run the job as.

string service_account_email = 4;

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

clearStagingLocation()

public FlexTemplateRuntimeEnvironment.Builder clearStagingLocation()

The Cloud Storage path for staging local files. Must be a valid Cloud Storage URL, beginning with gs://.

string staging_location = 17;

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

clearSubnetwork()

public FlexTemplateRuntimeEnvironment.Builder clearSubnetwork()

Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated path. Expected to be of the form "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK" or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is located in a Shared VPC network, you must use the complete URL.

string subnetwork = 9;

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

clearTempLocation()

public FlexTemplateRuntimeEnvironment.Builder clearTempLocation()

The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with gs://.

string temp_location = 5;

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

clearWorkerRegion()

public FlexTemplateRuntimeEnvironment.Builder clearWorkerRegion()

The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region.

string worker_region = 13;

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

clearWorkerZone()

public FlexTemplateRuntimeEnvironment.Builder clearWorkerZone()

The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity. If both worker_zone and zone are set, worker_zone takes precedence.

string worker_zone = 14;

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

clearZone()

public FlexTemplateRuntimeEnvironment.Builder clearZone()

The Compute Engine availability zone for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.

string zone = 3;

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

clone()

public FlexTemplateRuntimeEnvironment.Builder clone()

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

containsAdditionalUserLabels(String key)

public boolean containsAdditionalUserLabels(String key)

Additional user labels to be specified for the job. Keys and values must follow the restrictions specified in the labeling restrictions page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }.

map<string, string> additional_user_labels = 10;

Parameter

Name	Description
key	`String`

Returns

Type	Description
boolean

getAdditionalExperiments(int index)

public String getAdditionalExperiments(int index)

Additional experiment flags for the job.

repeated string additional_experiments = 7;

Parameter

Name	Description
index	`int` The index of the element to return.

Returns

Type	Description
String	The additionalExperiments at the given index.

getAdditionalExperimentsBytes(int index)

public ByteString getAdditionalExperimentsBytes(int index)

Additional experiment flags for the job.

repeated string additional_experiments = 7;

Parameter

Name	Description
index	`int` The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the additionalExperiments at the given index.

getAdditionalExperimentsCount()

public int getAdditionalExperimentsCount()

Additional experiment flags for the job.

repeated string additional_experiments = 7;

Returns

Type	Description
int	The count of additionalExperiments.

getAdditionalExperimentsList()

public ProtocolStringList getAdditionalExperimentsList()

Additional experiment flags for the job.

repeated string additional_experiments = 7;

Returns

Type	Description
ProtocolStringList	A list containing the additionalExperiments.

getAdditionalUserLabels()

public Map<String,String> getAdditionalUserLabels()

Use #getAdditionalUserLabelsMap() instead.

Returns

Type	Description
Map<String,String>

getAdditionalUserLabelsCount()

public int getAdditionalUserLabelsCount()

map<string, string> additional_user_labels = 10;

Returns

Type	Description
int

getAdditionalUserLabelsMap()

public Map<String,String> getAdditionalUserLabelsMap()

map<string, string> additional_user_labels = 10;

Returns

Type	Description
Map<String,String>

getAdditionalUserLabelsOrDefault(String key, String defaultValue)

public String getAdditionalUserLabelsOrDefault(String key, String defaultValue)

map<string, string> additional_user_labels = 10;

Parameters

Name	Description
key	`String`
defaultValue	`String`

Returns

Type	Description
String

getAdditionalUserLabelsOrThrow(String key)

public String getAdditionalUserLabelsOrThrow(String key)

map<string, string> additional_user_labels = 10;

Parameter

Name	Description
key	`String`

Returns

Type	Description
String

getAutoscalingAlgorithm()

public AutoscalingAlgorithm getAutoscalingAlgorithm()

The algorithm to use for autoscaling

.google.dataflow.v1beta3.AutoscalingAlgorithm autoscaling_algorithm = 21;

Returns

Type	Description
AutoscalingAlgorithm	The autoscalingAlgorithm.

getAutoscalingAlgorithmValue()

public int getAutoscalingAlgorithmValue()

The algorithm to use for autoscaling

.google.dataflow.v1beta3.AutoscalingAlgorithm autoscaling_algorithm = 21;

Returns

Type	Description
int	The enum numeric value on the wire for autoscalingAlgorithm.

getDefaultInstanceForType()

public FlexTemplateRuntimeEnvironment getDefaultInstanceForType()

Returns

Type	Description
FlexTemplateRuntimeEnvironment

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDiskSizeGb()

public int getDiskSizeGb()

Worker disk size, in gigabytes.

int32 disk_size_gb = 20;

Returns

Type	Description
int	The diskSizeGb.

getDumpHeapOnOom()

public boolean getDumpHeapOnOom()

bool dump_heap_on_oom = 22;

Returns

Type	Description
boolean	The dumpHeapOnOom.

getEnableStreamingEngine()

public boolean getEnableStreamingEngine()

Whether to enable Streaming Engine for the job.

bool enable_streaming_engine = 15;

Returns

Type	Description
boolean	The enableStreamingEngine.

getFlexrsGoal()

public FlexResourceSchedulingGoal getFlexrsGoal()

Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs

.google.dataflow.v1beta3.FlexResourceSchedulingGoal flexrs_goal = 16;

Returns

Type	Description
FlexResourceSchedulingGoal	The flexrsGoal.

getFlexrsGoalValue()

public int getFlexrsGoalValue()

Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs

.google.dataflow.v1beta3.FlexResourceSchedulingGoal flexrs_goal = 16;

Returns

Type	Description
int	The enum numeric value on the wire for flexrsGoal.

getIpConfiguration()

public WorkerIPAddressConfiguration getIpConfiguration()

Configuration for VM IPs.

.google.dataflow.v1beta3.WorkerIPAddressConfiguration ip_configuration = 12;

Returns

Type	Description
WorkerIPAddressConfiguration	The ipConfiguration.

getIpConfigurationValue()

public int getIpConfigurationValue()

Configuration for VM IPs.

.google.dataflow.v1beta3.WorkerIPAddressConfiguration ip_configuration = 12;

Returns

Type	Description
int	The enum numeric value on the wire for ipConfiguration.

getKmsKeyName()

public String getKmsKeyName()

Name for the Cloud KMS key for the job. Key format is: projects/<project>/locations/<location>/keyRings/<keyring>/cryptoKeys/<key>

string kms_key_name = 11;

Returns

Type	Description
String	The kmsKeyName.

getKmsKeyNameBytes()

public ByteString getKmsKeyNameBytes()

Name for the Cloud KMS key for the job. Key format is: projects/<project>/locations/<location>/keyRings/<keyring>/cryptoKeys/<key>

string kms_key_name = 11;

Returns

Type	Description
ByteString	The bytes for kmsKeyName.

getLauncherMachineType()

public String getLauncherMachineType()

The machine type to use for launching the job. The default is n1-standard-1.

string launcher_machine_type = 24;

Returns

Type	Description
String	The launcherMachineType.

getLauncherMachineTypeBytes()

public ByteString getLauncherMachineTypeBytes()

The machine type to use for launching the job. The default is n1-standard-1.

string launcher_machine_type = 24;

Returns

Type	Description
ByteString	The bytes for launcherMachineType.

getMachineType()

public String getMachineType()

The machine type to use for the job. Defaults to the value from the template if not specified.

string machine_type = 6;

Returns

Type	Description
String	The machineType.

getMachineTypeBytes()

public ByteString getMachineTypeBytes()

The machine type to use for the job. Defaults to the value from the template if not specified.

string machine_type = 6;

Returns

Type	Description
ByteString	The bytes for machineType.

getMaxWorkers()

public int getMaxWorkers()

The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.

int32 max_workers = 2;

Returns

Type	Description
int	The maxWorkers.

getMutableAdditionalUserLabels()

public Map<String,String> getMutableAdditionalUserLabels()

Use alternate mutation accessors instead.

Returns

Type	Description
Map<String,String>

getNetwork()

public String getNetwork()

Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".

string network = 8;

Returns

Type	Description
String	The network.

getNetworkBytes()

public ByteString getNetworkBytes()

Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".

string network = 8;

Returns

Type	Description
ByteString	The bytes for network.

getNumWorkers()

public int getNumWorkers()

The initial number of Google Compute Engine instances for the job.

int32 num_workers = 1;

Returns

Type	Description
int	The numWorkers.

getSaveHeapDumpsToGcsPath()

public String getSaveHeapDumpsToGcsPath()

Cloud Storage bucket (directory) to upload heap dumps to the given location. Enabling this implies that heap dumps should be generated on OOM (dump_heap_on_oom is set to true).

string save_heap_dumps_to_gcs_path = 23;

Returns

Type	Description
String	The saveHeapDumpsToGcsPath.

getSaveHeapDumpsToGcsPathBytes()

public ByteString getSaveHeapDumpsToGcsPathBytes()

Cloud Storage bucket (directory) to upload heap dumps to the given location. Enabling this implies that heap dumps should be generated on OOM (dump_heap_on_oom is set to true).

string save_heap_dumps_to_gcs_path = 23;

Returns

Type	Description
ByteString	The bytes for saveHeapDumpsToGcsPath.

getSdkContainerImage()

public String getSdkContainerImage()

Docker registry location of container image to use for the 'worker harness. Default is the container for the version of the SDK. Note this field is only valid for portable pipelines.

string sdk_container_image = 18;

Returns

Type	Description
String	The sdkContainerImage.

getSdkContainerImageBytes()

public ByteString getSdkContainerImageBytes()

Docker registry location of container image to use for the 'worker harness. Default is the container for the version of the SDK. Note this field is only valid for portable pipelines.

string sdk_container_image = 18;

Returns

Type	Description
ByteString	The bytes for sdkContainerImage.

getServiceAccountEmail()

public String getServiceAccountEmail()

The email address of the service account to run the job as.

string service_account_email = 4;

Returns

Type	Description
String	The serviceAccountEmail.

getServiceAccountEmailBytes()

public ByteString getServiceAccountEmailBytes()

The email address of the service account to run the job as.

string service_account_email = 4;

Returns

Type	Description
ByteString	The bytes for serviceAccountEmail.

getStagingLocation()

public String getStagingLocation()

The Cloud Storage path for staging local files. Must be a valid Cloud Storage URL, beginning with gs://.

string staging_location = 17;

Returns

Type	Description
String	The stagingLocation.

getStagingLocationBytes()

public ByteString getStagingLocationBytes()

The Cloud Storage path for staging local files. Must be a valid Cloud Storage URL, beginning with gs://.

string staging_location = 17;

Returns

Type	Description
ByteString	The bytes for stagingLocation.

getSubnetwork()

public String getSubnetwork()

string subnetwork = 9;

Returns

Type	Description
String	The subnetwork.

getSubnetworkBytes()

public ByteString getSubnetworkBytes()

string subnetwork = 9;

Returns

Type	Description
ByteString	The bytes for subnetwork.

getTempLocation()

public String getTempLocation()

The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with gs://.

string temp_location = 5;

Returns

Type	Description
String	The tempLocation.

getTempLocationBytes()

public ByteString getTempLocationBytes()

The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with gs://.

string temp_location = 5;

Returns

Type	Description
ByteString	The bytes for tempLocation.

getWorkerRegion()

public String getWorkerRegion()

string worker_region = 13;

Returns

Type	Description
String	The workerRegion.

getWorkerRegionBytes()

public ByteString getWorkerRegionBytes()

string worker_region = 13;

Returns

Type	Description
ByteString	The bytes for workerRegion.

getWorkerZone()

public String getWorkerZone()

string worker_zone = 14;

Returns

Type	Description
String	The workerZone.

getWorkerZoneBytes()

public ByteString getWorkerZoneBytes()

string worker_zone = 14;

Returns

Type	Description
ByteString	The bytes for workerZone.

getZone()

public String getZone()

The Compute Engine availability zone for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.

string zone = 3;

Returns

Type	Description
String	The zone.

getZoneBytes()

public ByteString getZoneBytes()

The Compute Engine availability zone for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.

string zone = 3;

Returns

Type	Description
ByteString	The bytes for zone.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter

Name	Description
number	`int`

Returns

Type	Description
MapField

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMapField(int fieldNumber)

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)

Parameter

Name	Description
number	`int`

Returns

Type	Description
MapField

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMutableMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(FlexTemplateRuntimeEnvironment other)

public FlexTemplateRuntimeEnvironment.Builder mergeFrom(FlexTemplateRuntimeEnvironment other)

Parameter

Name	Description
other	`FlexTemplateRuntimeEnvironment`

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public FlexTemplateRuntimeEnvironment.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	`CodedInputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public FlexTemplateRuntimeEnvironment.Builder mergeFrom(Message other)

Parameter

Name	Description
other	`Message`

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final FlexTemplateRuntimeEnvironment.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

putAdditionalUserLabels(String key, String value)

public FlexTemplateRuntimeEnvironment.Builder putAdditionalUserLabels(String key, String value)

map<string, string> additional_user_labels = 10;

Parameters

Name	Description
key	`String`
value	`String`

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder

putAllAdditionalUserLabels(Map<String,String> values)

public FlexTemplateRuntimeEnvironment.Builder putAllAdditionalUserLabels(Map<String,String> values)

map<string, string> additional_user_labels = 10;

Parameter

Name	Description
values	`Map<String,String>`

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder

removeAdditionalUserLabels(String key)

public FlexTemplateRuntimeEnvironment.Builder removeAdditionalUserLabels(String key)

map<string, string> additional_user_labels = 10;

Parameter

Name	Description
key	`String`

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder

setAdditionalExperiments(int index, String value)

public FlexTemplateRuntimeEnvironment.Builder setAdditionalExperiments(int index, String value)

Additional experiment flags for the job.

repeated string additional_experiments = 7;

Parameters

Name	Description
index	`int` The index to set the value at.
value	`String` The additionalExperiments to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setAutoscalingAlgorithm(AutoscalingAlgorithm value)

public FlexTemplateRuntimeEnvironment.Builder setAutoscalingAlgorithm(AutoscalingAlgorithm value)

The algorithm to use for autoscaling

.google.dataflow.v1beta3.AutoscalingAlgorithm autoscaling_algorithm = 21;

Parameter

Name	Description
value	`AutoscalingAlgorithm` The autoscalingAlgorithm to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setAutoscalingAlgorithmValue(int value)

public FlexTemplateRuntimeEnvironment.Builder setAutoscalingAlgorithmValue(int value)

The algorithm to use for autoscaling

.google.dataflow.v1beta3.AutoscalingAlgorithm autoscaling_algorithm = 21;

Parameter

Name	Description
value	`int` The enum numeric value on the wire for autoscalingAlgorithm to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setDiskSizeGb(int value)

public FlexTemplateRuntimeEnvironment.Builder setDiskSizeGb(int value)

Worker disk size, in gigabytes.

int32 disk_size_gb = 20;

Parameter

Name	Description
value	`int` The diskSizeGb to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setDumpHeapOnOom(boolean value)

public FlexTemplateRuntimeEnvironment.Builder setDumpHeapOnOom(boolean value)

bool dump_heap_on_oom = 22;

Parameter

Name	Description
value	`boolean` The dumpHeapOnOom to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setEnableStreamingEngine(boolean value)

public FlexTemplateRuntimeEnvironment.Builder setEnableStreamingEngine(boolean value)

Whether to enable Streaming Engine for the job.

bool enable_streaming_engine = 15;

Parameter

Name	Description
value	`boolean` The enableStreamingEngine to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public FlexTemplateRuntimeEnvironment.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFlexrsGoal(FlexResourceSchedulingGoal value)

public FlexTemplateRuntimeEnvironment.Builder setFlexrsGoal(FlexResourceSchedulingGoal value)

Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs

.google.dataflow.v1beta3.FlexResourceSchedulingGoal flexrs_goal = 16;

Parameter

Name	Description
value	`FlexResourceSchedulingGoal` The flexrsGoal to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setFlexrsGoalValue(int value)

public FlexTemplateRuntimeEnvironment.Builder setFlexrsGoalValue(int value)

Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs

.google.dataflow.v1beta3.FlexResourceSchedulingGoal flexrs_goal = 16;

Parameter

Name	Description
value	`int` The enum numeric value on the wire for flexrsGoal to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setIpConfiguration(WorkerIPAddressConfiguration value)

public FlexTemplateRuntimeEnvironment.Builder setIpConfiguration(WorkerIPAddressConfiguration value)

Configuration for VM IPs.

.google.dataflow.v1beta3.WorkerIPAddressConfiguration ip_configuration = 12;

Parameter

Name	Description
value	`WorkerIPAddressConfiguration` The ipConfiguration to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setIpConfigurationValue(int value)

public FlexTemplateRuntimeEnvironment.Builder setIpConfigurationValue(int value)

Configuration for VM IPs.

.google.dataflow.v1beta3.WorkerIPAddressConfiguration ip_configuration = 12;

Parameter

Name	Description
value	`int` The enum numeric value on the wire for ipConfiguration to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setKmsKeyName(String value)

public FlexTemplateRuntimeEnvironment.Builder setKmsKeyName(String value)

Name for the Cloud KMS key for the job. Key format is: projects/<project>/locations/<location>/keyRings/<keyring>/cryptoKeys/<key>

string kms_key_name = 11;

Parameter

Name	Description
value	`String` The kmsKeyName to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setKmsKeyNameBytes(ByteString value)

public FlexTemplateRuntimeEnvironment.Builder setKmsKeyNameBytes(ByteString value)

Name for the Cloud KMS key for the job. Key format is: projects/<project>/locations/<location>/keyRings/<keyring>/cryptoKeys/<key>

string kms_key_name = 11;

Parameter

Name	Description
value	`ByteString` The bytes for kmsKeyName to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setLauncherMachineType(String value)

public FlexTemplateRuntimeEnvironment.Builder setLauncherMachineType(String value)

The machine type to use for launching the job. The default is n1-standard-1.

string launcher_machine_type = 24;

Parameter

Name	Description
value	`String` The launcherMachineType to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setLauncherMachineTypeBytes(ByteString value)

public FlexTemplateRuntimeEnvironment.Builder setLauncherMachineTypeBytes(ByteString value)

The machine type to use for launching the job. The default is n1-standard-1.

string launcher_machine_type = 24;

Parameter

Name	Description
value	`ByteString` The bytes for launcherMachineType to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setMachineType(String value)

public FlexTemplateRuntimeEnvironment.Builder setMachineType(String value)

The machine type to use for the job. Defaults to the value from the template if not specified.

string machine_type = 6;

Parameter

Name	Description
value	`String` The machineType to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setMachineTypeBytes(ByteString value)

public FlexTemplateRuntimeEnvironment.Builder setMachineTypeBytes(ByteString value)

The machine type to use for the job. Defaults to the value from the template if not specified.

string machine_type = 6;

Parameter

Name	Description
value	`ByteString` The bytes for machineType to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setMaxWorkers(int value)

public FlexTemplateRuntimeEnvironment.Builder setMaxWorkers(int value)

The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.

int32 max_workers = 2;

Parameter

Name	Description
value	`int` The maxWorkers to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setNetwork(String value)

public FlexTemplateRuntimeEnvironment.Builder setNetwork(String value)

Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".

string network = 8;

Parameter

Name	Description
value	`String` The network to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setNetworkBytes(ByteString value)

public FlexTemplateRuntimeEnvironment.Builder setNetworkBytes(ByteString value)

Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".

string network = 8;

Parameter

Name	Description
value	`ByteString` The bytes for network to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setNumWorkers(int value)

public FlexTemplateRuntimeEnvironment.Builder setNumWorkers(int value)

The initial number of Google Compute Engine instances for the job.

int32 num_workers = 1;

Parameter

Name	Description
value	`int` The numWorkers to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

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

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

Parameters

Name	Description
field	`FieldDescriptor`
index	`int`
value	`Object`

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSaveHeapDumpsToGcsPath(String value)

public FlexTemplateRuntimeEnvironment.Builder setSaveHeapDumpsToGcsPath(String value)

Cloud Storage bucket (directory) to upload heap dumps to the given location. Enabling this implies that heap dumps should be generated on OOM (dump_heap_on_oom is set to true).

string save_heap_dumps_to_gcs_path = 23;

Parameter

Name	Description
value	`String` The saveHeapDumpsToGcsPath to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setSaveHeapDumpsToGcsPathBytes(ByteString value)

public FlexTemplateRuntimeEnvironment.Builder setSaveHeapDumpsToGcsPathBytes(ByteString value)

Cloud Storage bucket (directory) to upload heap dumps to the given location. Enabling this implies that heap dumps should be generated on OOM (dump_heap_on_oom is set to true).

string save_heap_dumps_to_gcs_path = 23;

Parameter

Name	Description
value	`ByteString` The bytes for saveHeapDumpsToGcsPath to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setSdkContainerImage(String value)

public FlexTemplateRuntimeEnvironment.Builder setSdkContainerImage(String value)

Docker registry location of container image to use for the 'worker harness. Default is the container for the version of the SDK. Note this field is only valid for portable pipelines.

string sdk_container_image = 18;

Parameter

Name	Description
value	`String` The sdkContainerImage to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setSdkContainerImageBytes(ByteString value)

public FlexTemplateRuntimeEnvironment.Builder setSdkContainerImageBytes(ByteString value)

Docker registry location of container image to use for the 'worker harness. Default is the container for the version of the SDK. Note this field is only valid for portable pipelines.

string sdk_container_image = 18;

Parameter

Name	Description
value	`ByteString` The bytes for sdkContainerImage to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setServiceAccountEmail(String value)

public FlexTemplateRuntimeEnvironment.Builder setServiceAccountEmail(String value)

The email address of the service account to run the job as.

string service_account_email = 4;

Parameter

Name	Description
value	`String` The serviceAccountEmail to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setServiceAccountEmailBytes(ByteString value)

public FlexTemplateRuntimeEnvironment.Builder setServiceAccountEmailBytes(ByteString value)

The email address of the service account to run the job as.

string service_account_email = 4;

Parameter

Name	Description
value	`ByteString` The bytes for serviceAccountEmail to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setStagingLocation(String value)

public FlexTemplateRuntimeEnvironment.Builder setStagingLocation(String value)

The Cloud Storage path for staging local files. Must be a valid Cloud Storage URL, beginning with gs://.

string staging_location = 17;

Parameter

Name	Description
value	`String` The stagingLocation to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setStagingLocationBytes(ByteString value)

public FlexTemplateRuntimeEnvironment.Builder setStagingLocationBytes(ByteString value)

The Cloud Storage path for staging local files. Must be a valid Cloud Storage URL, beginning with gs://.

string staging_location = 17;

Parameter

Name	Description
value	`ByteString` The bytes for stagingLocation to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setSubnetwork(String value)

public FlexTemplateRuntimeEnvironment.Builder setSubnetwork(String value)

string subnetwork = 9;

Parameter

Name	Description
value	`String` The subnetwork to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setSubnetworkBytes(ByteString value)

public FlexTemplateRuntimeEnvironment.Builder setSubnetworkBytes(ByteString value)

string subnetwork = 9;

Parameter

Name	Description
value	`ByteString` The bytes for subnetwork to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setTempLocation(String value)

public FlexTemplateRuntimeEnvironment.Builder setTempLocation(String value)

The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with gs://.

string temp_location = 5;

Parameter

Name	Description
value	`String` The tempLocation to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setTempLocationBytes(ByteString value)

public FlexTemplateRuntimeEnvironment.Builder setTempLocationBytes(ByteString value)

The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with gs://.

string temp_location = 5;

Parameter

Name	Description
value	`ByteString` The bytes for tempLocation to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final FlexTemplateRuntimeEnvironment.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setWorkerRegion(String value)

public FlexTemplateRuntimeEnvironment.Builder setWorkerRegion(String value)

string worker_region = 13;

Parameter

Name	Description
value	`String` The workerRegion to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setWorkerRegionBytes(ByteString value)

public FlexTemplateRuntimeEnvironment.Builder setWorkerRegionBytes(ByteString value)

string worker_region = 13;

Parameter

Name	Description
value	`ByteString` The bytes for workerRegion to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setWorkerZone(String value)

public FlexTemplateRuntimeEnvironment.Builder setWorkerZone(String value)

string worker_zone = 14;

Parameter

Name	Description
value	`String` The workerZone to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setWorkerZoneBytes(ByteString value)

public FlexTemplateRuntimeEnvironment.Builder setWorkerZoneBytes(ByteString value)

string worker_zone = 14;

Parameter

Name	Description
value	`ByteString` The bytes for workerZone to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setZone(String value)

public FlexTemplateRuntimeEnvironment.Builder setZone(String value)

The Compute Engine availability zone for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.

string zone = 3;

Parameter

Name	Description
value	`String` The zone to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.

setZoneBytes(ByteString value)

public FlexTemplateRuntimeEnvironment.Builder setZoneBytes(ByteString value)

The Compute Engine availability zone for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.

string zone = 3;

Parameter

Name	Description
value	`ByteString` The bytes for zone to set.

Returns

Type	Description
FlexTemplateRuntimeEnvironment.Builder	This builder for chaining.