public static final class FlexTemplateRuntimeEnvironment.Builder extends GeneratedMessageV3.Builder<FlexTemplateRuntimeEnvironment.Builder> implements FlexTemplateRuntimeEnvironmentOrBuilderThe 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.BuilderImplements
FlexTemplateRuntimeEnvironmentOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
Methods
addAdditionalExperiments(String value)
public FlexTemplateRuntimeEnvironment.Builder addAdditionalExperiments(String value)Additional experiment flags for the job.
repeated string additional_experiments = 7;
| Name | Description |
| value | StringThe additionalExperiments to add. |
| 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;
| Name | Description |
| value | ByteStringThe bytes of the additionalExperiments to add. |
| 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;
| Name | Description |
| values | Iterable<String>The additionalExperiments to add. |
| Type | Description |
| FlexTemplateRuntimeEnvironment.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public FlexTemplateRuntimeEnvironment.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| FlexTemplateRuntimeEnvironment.Builder |
build()
public FlexTemplateRuntimeEnvironment build()| Type | Description |
| FlexTemplateRuntimeEnvironment |
buildPartial()
public FlexTemplateRuntimeEnvironment buildPartial()| Type | Description |
| FlexTemplateRuntimeEnvironment |
clear()
public FlexTemplateRuntimeEnvironment.Builder clear()| Type | Description |
| FlexTemplateRuntimeEnvironment.Builder |
clearAdditionalExperiments()
public FlexTemplateRuntimeEnvironment.Builder clearAdditionalExperiments()Additional experiment flags for the job.
repeated string additional_experiments = 7;
| Type | Description |
| FlexTemplateRuntimeEnvironment.Builder | This builder for chaining. |
clearAdditionalUserLabels()
public FlexTemplateRuntimeEnvironment.Builder clearAdditionalUserLabels()| Type | Description |
| FlexTemplateRuntimeEnvironment.Builder |
clearAutoscalingAlgorithm()
public FlexTemplateRuntimeEnvironment.Builder clearAutoscalingAlgorithm()The algorithm to use for autoscaling
.google.dataflow.v1beta3.AutoscalingAlgorithm autoscaling_algorithm = 21;
| Type | Description |
| FlexTemplateRuntimeEnvironment.Builder | This builder for chaining. |
clearDiskSizeGb()
public FlexTemplateRuntimeEnvironment.Builder clearDiskSizeGb()Worker disk size, in gigabytes.
int32 disk_size_gb = 20;
| 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;
| 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;
| Type | Description |
| FlexTemplateRuntimeEnvironment.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public FlexTemplateRuntimeEnvironment.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| FlexTemplateRuntimeEnvironment.Builder |
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;
| Type | Description |
| FlexTemplateRuntimeEnvironment.Builder | This builder for chaining. |
clearIpConfiguration()
public FlexTemplateRuntimeEnvironment.Builder clearIpConfiguration()Configuration for VM IPs.
.google.dataflow.v1beta3.WorkerIPAddressConfiguration ip_configuration = 12;
| 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;
| 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;
| 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;
| 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;
| 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;
| 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;
| Type | Description |
| FlexTemplateRuntimeEnvironment.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public FlexTemplateRuntimeEnvironment.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| FlexTemplateRuntimeEnvironment.Builder |
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;
| 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;
| 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;
| 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;
| 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;
| 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;
| 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;
| 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;
| 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;
| Type | Description |
| FlexTemplateRuntimeEnvironment.Builder | This builder for chaining. |
clone()
public FlexTemplateRuntimeEnvironment.Builder clone()| Type | Description |
| FlexTemplateRuntimeEnvironment.Builder |
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;
| Name | Description |
| key | String |
| Type | Description |
| boolean |
getAdditionalExperiments(int index)
public String getAdditionalExperiments(int index)Additional experiment flags for the job.
repeated string additional_experiments = 7;
| Name | Description |
| index | intThe index of the element to return. |
| 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;
| Name | Description |
| index | intThe index of the value to return. |
| 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;
| Type | Description |
| int | The count of additionalExperiments. |
getAdditionalExperimentsList()
public ProtocolStringList getAdditionalExperimentsList()Additional experiment flags for the job.
repeated string additional_experiments = 7;
| Type | Description |
| ProtocolStringList | A list containing the additionalExperiments. |
getAdditionalUserLabels()
public Map<String,String> getAdditionalUserLabels()Use #getAdditionalUserLabelsMap() instead.
| Type | Description |
| Map<String,String> |
getAdditionalUserLabelsCount()
public int getAdditionalUserLabelsCount()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;
| Type | Description |
| int |
getAdditionalUserLabelsMap()
public Map<String,String> getAdditionalUserLabelsMap()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;
| Type | Description |
| Map<String,String> |
getAdditionalUserLabelsOrDefault(String key, String defaultValue)
public String getAdditionalUserLabelsOrDefault(String key, String defaultValue)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;
| Name | Description |
| key | String |
| defaultValue | String |
| Type | Description |
| String |
getAdditionalUserLabelsOrThrow(String key)
public String getAdditionalUserLabelsOrThrow(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;
| Name | Description |
| key | String |
| Type | Description |
| String |
getAutoscalingAlgorithm()
public AutoscalingAlgorithm getAutoscalingAlgorithm()The algorithm to use for autoscaling
.google.dataflow.v1beta3.AutoscalingAlgorithm autoscaling_algorithm = 21;
| Type | Description |
| AutoscalingAlgorithm | The autoscalingAlgorithm. |
getAutoscalingAlgorithmValue()
public int getAutoscalingAlgorithmValue()The algorithm to use for autoscaling
.google.dataflow.v1beta3.AutoscalingAlgorithm autoscaling_algorithm = 21;
| Type | Description |
| int | The enum numeric value on the wire for autoscalingAlgorithm. |
getDefaultInstanceForType()
public FlexTemplateRuntimeEnvironment getDefaultInstanceForType()| Type | Description |
| FlexTemplateRuntimeEnvironment |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
getDiskSizeGb()
public int getDiskSizeGb()Worker disk size, in gigabytes.
int32 disk_size_gb = 20;
| Type | Description |
| int | The diskSizeGb. |
getDumpHeapOnOom()
public boolean getDumpHeapOnOom()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;
| Type | Description |
| boolean | The dumpHeapOnOom. |
getEnableStreamingEngine()
public boolean getEnableStreamingEngine()Whether to enable Streaming Engine for the job.
bool enable_streaming_engine = 15;
| 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;
| 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;
| 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;
| Type | Description |
| WorkerIPAddressConfiguration | The ipConfiguration. |
getIpConfigurationValue()
public int getIpConfigurationValue()Configuration for VM IPs.
.google.dataflow.v1beta3.WorkerIPAddressConfiguration ip_configuration = 12;
| 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;
| 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;
| 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;
| 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;
| 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;
| 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;
| 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;
| Type | Description |
| int | The maxWorkers. |
getMutableAdditionalUserLabels()
public Map<String,String> getMutableAdditionalUserLabels()Use alternate mutation accessors instead.
| 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;
| 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;
| 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;
| 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;
| 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;
| 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;
| 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;
| 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;
| 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;
| 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;
| 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;
| Type | Description |
| ByteString | The bytes for stagingLocation. |
getSubnetwork()
public String getSubnetwork()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;
| Type | Description |
| String | The subnetwork. |
getSubnetworkBytes()
public ByteString getSubnetworkBytes()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;
| 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;
| 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;
| Type | Description |
| ByteString | The bytes for tempLocation. |
getWorkerRegion()
public String getWorkerRegion()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;
| Type | Description |
| String | The workerRegion. |
getWorkerRegionBytes()
public ByteString getWorkerRegionBytes()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;
| Type | Description |
| ByteString | The bytes for workerRegion. |
getWorkerZone()
public String getWorkerZone() 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;
| Type | Description |
| String | The workerZone. |
getWorkerZoneBytes()
public ByteString getWorkerZoneBytes() 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;
| 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;
| 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;
| Type | Description |
| ByteString | The bytes for zone. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)| Name | Description |
| number | int |
| Type | Description |
| MapField |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)| Name | Description |
| number | int |
| Type | Description |
| MapField |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
mergeFrom(FlexTemplateRuntimeEnvironment other)
public FlexTemplateRuntimeEnvironment.Builder mergeFrom(FlexTemplateRuntimeEnvironment other)| Name | Description |
| other | FlexTemplateRuntimeEnvironment |
| Type | Description |
| FlexTemplateRuntimeEnvironment.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public FlexTemplateRuntimeEnvironment.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| FlexTemplateRuntimeEnvironment.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public FlexTemplateRuntimeEnvironment.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| FlexTemplateRuntimeEnvironment.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final FlexTemplateRuntimeEnvironment.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| FlexTemplateRuntimeEnvironment.Builder |
putAdditionalUserLabels(String key, String value)
public FlexTemplateRuntimeEnvironment.Builder putAdditionalUserLabels(String key, String value)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;
| Name | Description |
| key | String |
| value | String |
| Type | Description |
| FlexTemplateRuntimeEnvironment.Builder |
putAllAdditionalUserLabels(Map<String,String> values)
public FlexTemplateRuntimeEnvironment.Builder putAllAdditionalUserLabels(Map<String,String> values)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;
| Name | Description |
| values | Map<String,String> |
| Type | Description |
| FlexTemplateRuntimeEnvironment.Builder |
removeAdditionalUserLabels(String key)
public FlexTemplateRuntimeEnvironment.Builder removeAdditionalUserLabels(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;
| Name | Description |
| key | String |
| 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;
| Name | Description |
| index | intThe index to set the value at. |
| value | StringThe additionalExperiments to set. |
| 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;
| Name | Description |
| value | AutoscalingAlgorithmThe autoscalingAlgorithm to set. |
| 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;
| Name | Description |
| value | intThe enum numeric value on the wire for autoscalingAlgorithm to set. |
| 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;
| Name | Description |
| value | intThe diskSizeGb to set. |
| Type | Description |
| FlexTemplateRuntimeEnvironment.Builder | This builder for chaining. |
setDumpHeapOnOom(boolean value)
public FlexTemplateRuntimeEnvironment.Builder setDumpHeapOnOom(boolean value)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;
| Name | Description |
| value | booleanThe dumpHeapOnOom to set. |
| 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;
| Name | Description |
| value | booleanThe enableStreamingEngine to set. |
| Type | Description |
| FlexTemplateRuntimeEnvironment.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public FlexTemplateRuntimeEnvironment.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| FlexTemplateRuntimeEnvironment.Builder |
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;
| Name | Description |
| value | FlexResourceSchedulingGoalThe flexrsGoal to set. |
| 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;
| Name | Description |
| value | intThe enum numeric value on the wire for flexrsGoal to set. |
| 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;
| Name | Description |
| value | WorkerIPAddressConfigurationThe ipConfiguration to set. |
| 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;
| Name | Description |
| value | intThe enum numeric value on the wire for ipConfiguration to set. |
| 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;
| Name | Description |
| value | StringThe kmsKeyName to set. |
| 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;
| Name | Description |
| value | ByteStringThe bytes for kmsKeyName to set. |
| 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;
| Name | Description |
| value | StringThe launcherMachineType to set. |
| 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;
| Name | Description |
| value | ByteStringThe bytes for launcherMachineType to set. |
| 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;
| Name | Description |
| value | StringThe machineType to set. |
| 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;
| Name | Description |
| value | ByteStringThe bytes for machineType to set. |
| 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;
| Name | Description |
| value | intThe maxWorkers to set. |
| 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;
| Name | Description |
| value | StringThe network to set. |
| 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;
| Name | Description |
| value | ByteStringThe bytes for network to set. |
| 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;
| Name | Description |
| value | intThe numWorkers to set. |
| 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)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| FlexTemplateRuntimeEnvironment.Builder |
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;
| Name | Description |
| value | StringThe saveHeapDumpsToGcsPath to set. |
| 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;
| Name | Description |
| value | ByteStringThe bytes for saveHeapDumpsToGcsPath to set. |
| 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;
| Name | Description |
| value | StringThe sdkContainerImage to set. |
| 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;
| Name | Description |
| value | ByteStringThe bytes for sdkContainerImage to set. |
| 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;
| Name | Description |
| value | StringThe serviceAccountEmail to set. |
| 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;
| Name | Description |
| value | ByteStringThe bytes for serviceAccountEmail to set. |
| 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;
| Name | Description |
| value | StringThe stagingLocation to set. |
| 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;
| Name | Description |
| value | ByteStringThe bytes for stagingLocation to set. |
| Type | Description |
| FlexTemplateRuntimeEnvironment.Builder | This builder for chaining. |
setSubnetwork(String value)
public FlexTemplateRuntimeEnvironment.Builder setSubnetwork(String value)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;
| Name | Description |
| value | StringThe subnetwork to set. |
| Type | Description |
| FlexTemplateRuntimeEnvironment.Builder | This builder for chaining. |
setSubnetworkBytes(ByteString value)
public FlexTemplateRuntimeEnvironment.Builder setSubnetworkBytes(ByteString value)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;
| Name | Description |
| value | ByteStringThe bytes for subnetwork to set. |
| 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;
| Name | Description |
| value | StringThe tempLocation to set. |
| 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;
| Name | Description |
| value | ByteStringThe bytes for tempLocation to set. |
| Type | Description |
| FlexTemplateRuntimeEnvironment.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final FlexTemplateRuntimeEnvironment.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| FlexTemplateRuntimeEnvironment.Builder |
setWorkerRegion(String value)
public FlexTemplateRuntimeEnvironment.Builder setWorkerRegion(String value)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;
| Name | Description |
| value | StringThe workerRegion to set. |
| Type | Description |
| FlexTemplateRuntimeEnvironment.Builder | This builder for chaining. |
setWorkerRegionBytes(ByteString value)
public FlexTemplateRuntimeEnvironment.Builder setWorkerRegionBytes(ByteString value)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;
| Name | Description |
| value | ByteStringThe bytes for workerRegion to set. |
| Type | Description |
| FlexTemplateRuntimeEnvironment.Builder | This builder for chaining. |
setWorkerZone(String value)
public FlexTemplateRuntimeEnvironment.Builder setWorkerZone(String value) 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;
| Name | Description |
| value | StringThe workerZone to set. |
| Type | Description |
| FlexTemplateRuntimeEnvironment.Builder | This builder for chaining. |
setWorkerZoneBytes(ByteString value)
public FlexTemplateRuntimeEnvironment.Builder setWorkerZoneBytes(ByteString value) 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;
| Name | Description |
| value | ByteStringThe bytes for workerZone to set. |
| 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;
| Name | Description |
| value | StringThe zone to set. |
| 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;
| Name | Description |
| value | ByteStringThe bytes for zone to set. |
| Type | Description |
| FlexTemplateRuntimeEnvironment.Builder | This builder for chaining. |