/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/dataflow/v1beta3/templates.proto
package com.google.dataflow.v1beta3;
public interface RuntimeEnvironmentOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.dataflow.v1beta3.RuntimeEnvironment)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* The initial number of Google Compute Engine instnaces for the job.
*
*
* int32 num_workers = 11;
*
* @return The numWorkers.
*/
int getNumWorkers();
/**
*
*
*
* The maximum number of Google Compute Engine instances to be made
* available to your pipeline during execution, from 1 to 1000.
*
*
* int32 max_workers = 1;
*
* @return The maxWorkers.
*/
int getMaxWorkers();
/**
*
*
*
* The Compute Engine [availability
* zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones)
* for launching worker instances to run your pipeline.
* In the future, worker_zone will take precedence.
*
*
* string zone = 2;
*
* @return The zone.
*/
java.lang.String getZone();
/**
*
*
*
* The Compute Engine [availability
* zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones)
* for launching worker instances to run your pipeline.
* In the future, worker_zone will take precedence.
*
*
* string zone = 2;
*
* @return The bytes for zone.
*/
com.google.protobuf.ByteString getZoneBytes();
/**
*
*
*
* The email address of the service account to run the job as.
*
*
* string service_account_email = 3;
*
* @return The serviceAccountEmail.
*/
java.lang.String getServiceAccountEmail();
/**
*
*
*
* The email address of the service account to run the job as.
*
*
* string service_account_email = 3;
*
* @return The bytes for serviceAccountEmail.
*/
com.google.protobuf.ByteString getServiceAccountEmailBytes();
/**
*
*
*
* The Cloud Storage path to use for temporary files.
* Must be a valid Cloud Storage URL, beginning with `gs://`.
*
*
* string temp_location = 4;
*
* @return The tempLocation.
*/
java.lang.String getTempLocation();
/**
*
*
*
* The Cloud Storage path to use for temporary files.
* Must be a valid Cloud Storage URL, beginning with `gs://`.
*
*
* string temp_location = 4;
*
* @return The bytes for tempLocation.
*/
com.google.protobuf.ByteString getTempLocationBytes();
/**
*
*
*
* Whether to bypass the safety checks for the job's temporary directory.
* Use with caution.
*
*
* bool bypass_temp_dir_validation = 5;
*
* @return The bypassTempDirValidation.
*/
boolean getBypassTempDirValidation();
/**
*
*
*
* The machine type to use for the job. Defaults to the value from the
* template if not specified.
*
*
* string machine_type = 6;
*
* @return The machineType.
*/
java.lang.String getMachineType();
/**
*
*
*
* The machine type to use for the job. Defaults to the value from the
* template if not specified.
*
*
* string machine_type = 6;
*
* @return The bytes for machineType.
*/
com.google.protobuf.ByteString getMachineTypeBytes();
/**
*
*
*
* Additional experiment flags for the job, specified with the
* `--experiments` option.
*
*
* repeated string additional_experiments = 7;
*
* @return A list containing the additionalExperiments.
*/
java.util.List getAdditionalExperimentsList();
/**
*
*
*
* Additional experiment flags for the job, specified with the
* `--experiments` option.
*
*
* repeated string additional_experiments = 7;
*
* @return The count of additionalExperiments.
*/
int getAdditionalExperimentsCount();
/**
*
*
*
* Additional experiment flags for the job, specified with the
* `--experiments` option.
*
*
* repeated string additional_experiments = 7;
*
* @param index The index of the element to return.
* @return The additionalExperiments at the given index.
*/
java.lang.String getAdditionalExperiments(int index);
/**
*
*
*
* Additional experiment flags for the job, specified with the
* `--experiments` option.
*
*
* repeated string additional_experiments = 7;
*
* @param index The index of the value to return.
* @return The bytes of the additionalExperiments at the given index.
*/
com.google.protobuf.ByteString getAdditionalExperimentsBytes(int index);
/**
*
*
*
* Network to which VMs will be assigned. If empty or unspecified,
* the service will use the network "default".
*
*
* string network = 8;
*
* @return The network.
*/
java.lang.String getNetwork();
/**
*
*
*
* Network to which VMs will be assigned. If empty or unspecified,
* the service will use the network "default".
*
*
* string network = 8;
*
* @return The bytes for network.
*/
com.google.protobuf.ByteString getNetworkBytes();
/**
*
*
*
* 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;
*
* @return The subnetwork.
*/
java.lang.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;
*
* @return The bytes for subnetwork.
*/
com.google.protobuf.ByteString getSubnetworkBytes();
/**
*
*
*
* Additional user labels to be specified for the job.
* Keys and values should follow the restrictions specified in the [labeling
* restrictions](https://cloud.google.com/compute/docs/labeling-resources#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;
*/
int getAdditionalUserLabelsCount();
/**
*
*
*
* Additional user labels to be specified for the job.
* Keys and values should follow the restrictions specified in the [labeling
* restrictions](https://cloud.google.com/compute/docs/labeling-resources#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;
*/
boolean containsAdditionalUserLabels(java.lang.String key);
/** Use {@link #getAdditionalUserLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getAdditionalUserLabels();
/**
*
*
*
* Additional user labels to be specified for the job.
* Keys and values should follow the restrictions specified in the [labeling
* restrictions](https://cloud.google.com/compute/docs/labeling-resources#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;
*/
java.util.Map getAdditionalUserLabelsMap();
/**
*
*
*
* Additional user labels to be specified for the job.
* Keys and values should follow the restrictions specified in the [labeling
* restrictions](https://cloud.google.com/compute/docs/labeling-resources#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;
*/
/* nullable */
java.lang.String getAdditionalUserLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* Additional user labels to be specified for the job.
* Keys and values should follow the restrictions specified in the [labeling
* restrictions](https://cloud.google.com/compute/docs/labeling-resources#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;
*/
java.lang.String getAdditionalUserLabelsOrThrow(java.lang.String key);
/**
*
*
*
* Name for the Cloud KMS key for the job.
* Key format is:
* projects/<project>/locations/<location>/keyRings/<keyring>/cryptoKeys/<key>
*
*
* string kms_key_name = 12;
*
* @return The kmsKeyName.
*/
java.lang.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 = 12;
*
* @return The bytes for kmsKeyName.
*/
com.google.protobuf.ByteString getKmsKeyNameBytes();
/**
*
*
*
* Configuration for VM IPs.
*
*
* .google.dataflow.v1beta3.WorkerIPAddressConfiguration ip_configuration = 14;
*
* @return The enum numeric value on the wire for ipConfiguration.
*/
int getIpConfigurationValue();
/**
*
*
*
* Configuration for VM IPs.
*
*
* .google.dataflow.v1beta3.WorkerIPAddressConfiguration ip_configuration = 14;
*
* @return The ipConfiguration.
*/
com.google.dataflow.v1beta3.WorkerIPAddressConfiguration getIpConfiguration();
/**
*
*
*
* 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 = 15;
*
* @return The workerRegion.
*/
java.lang.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 = 15;
*
* @return The bytes for workerRegion.
*/
com.google.protobuf.ByteString getWorkerRegionBytes();
/**
*
*
*
* 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 = 16;
*
* @return The workerZone.
*/
java.lang.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 = 16;
*
* @return The bytes for workerZone.
*/
com.google.protobuf.ByteString getWorkerZoneBytes();
/**
*
*
*
* Whether to enable Streaming Engine for the job.
*
*
* bool enable_streaming_engine = 17;
*
* @return The enableStreamingEngine.
*/
boolean getEnableStreamingEngine();
}