Interface FlexTemplateRuntimeEnvironmentOrBuilder (0.17.0)

Version 0.17.0

• 0.57.0 (latest)
• 0.56.0
• 0.55.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.5.0

public interface FlexTemplateRuntimeEnvironmentOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAdditionalUserLabels(String key)

public abstract 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 abstract 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 abstract 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 abstract int getAdditionalExperimentsCount()

Additional experiment flags for the job.

repeated string additional_experiments = 7;

Returns
Type	Description
int	The count of additionalExperiments.

getAdditionalExperimentsList()

public abstract List<String> getAdditionalExperimentsList()

Additional experiment flags for the job.

repeated string additional_experiments = 7;

Returns
Type	Description
List<String>	A list containing the additionalExperiments.

getAdditionalUserLabels()

public abstract Map<String,String> getAdditionalUserLabels()

Use #getAdditionalUserLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getAdditionalUserLabelsCount()

public abstract 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;

Returns
Type	Description
int

getAdditionalUserLabelsMap()

public abstract 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;

Returns
Type	Description
Map<String,String>

getAdditionalUserLabelsOrDefault(String key, String defaultValue)

public abstract 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;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getAdditionalUserLabelsOrThrow(String key)

public abstract 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;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getAutoscalingAlgorithm()

public abstract AutoscalingAlgorithm getAutoscalingAlgorithm()

The algorithm to use for autoscaling

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

Returns
Type	Description
AutoscalingAlgorithm	The autoscalingAlgorithm.

getAutoscalingAlgorithmValue()

public abstract 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.

getDiskSizeGb()

public abstract int getDiskSizeGb()

Worker disk size, in gigabytes.

int32 disk_size_gb = 20;

Returns
Type	Description
int	The diskSizeGb.

getDumpHeapOnOom()

public abstract 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;

Returns
Type	Description
boolean	The dumpHeapOnOom.

getEnableStreamingEngine()

public abstract boolean getEnableStreamingEngine()

Whether to enable Streaming Engine for the job.

bool enable_streaming_engine = 15;

Returns
Type	Description
boolean	The enableStreamingEngine.

getFlexrsGoal()

public abstract 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 abstract 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 abstract WorkerIPAddressConfiguration getIpConfiguration()

Configuration for VM IPs.

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

Returns
Type	Description
WorkerIPAddressConfiguration	The ipConfiguration.

getIpConfigurationValue()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getNetwork()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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;

Returns
Type	Description
String	The subnetwork.

getSubnetworkBytes()

public abstract 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;

Returns
Type	Description
ByteString	The bytes for subnetwork.

getTempLocation()

public abstract 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 abstract 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 abstract 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;

Returns
Type	Description
String	The workerRegion.

getWorkerRegionBytes()

public abstract 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;

Returns
Type	Description
ByteString	The bytes for workerRegion.

getWorkerZone()

public abstract 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;

Returns
Type	Description
String	The workerZone.

getWorkerZoneBytes()

public abstract 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;

Returns
Type	Description
ByteString	The bytes for workerZone.

getZone()

public abstract 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 abstract 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.