Class RuntimeEnvironment (0.57.0) 

public final class RuntimeEnvironment extends GeneratedMessageV3 implements RuntimeEnvironmentOrBuilder

The environment values to set at runtime.

Protobuf type google.dataflow.v1beta3.RuntimeEnvironment

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > RuntimeEnvironment

Static Fields

ADDITIONAL_EXPERIMENTS_FIELD_NUMBER

public static final int ADDITIONAL_EXPERIMENTS_FIELD_NUMBER
Field Value
Type Description
int

ADDITIONAL_USER_LABELS_FIELD_NUMBER

public static final int ADDITIONAL_USER_LABELS_FIELD_NUMBER
Field Value
Type Description
int

BYPASS_TEMP_DIR_VALIDATION_FIELD_NUMBER

public static final int BYPASS_TEMP_DIR_VALIDATION_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_STREAMING_ENGINE_FIELD_NUMBER

public static final int ENABLE_STREAMING_ENGINE_FIELD_NUMBER
Field Value
Type Description
int

IP_CONFIGURATION_FIELD_NUMBER

public static final int IP_CONFIGURATION_FIELD_NUMBER
Field Value
Type Description
int

KMS_KEY_NAME_FIELD_NUMBER

public static final int KMS_KEY_NAME_FIELD_NUMBER
Field Value
Type Description
int

MACHINE_TYPE_FIELD_NUMBER

public static final int MACHINE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

MAX_WORKERS_FIELD_NUMBER

public static final int MAX_WORKERS_FIELD_NUMBER
Field Value
Type Description
int

NETWORK_FIELD_NUMBER

public static final int NETWORK_FIELD_NUMBER
Field Value
Type Description
int

NUM_WORKERS_FIELD_NUMBER

public static final int NUM_WORKERS_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER
Field Value
Type Description
int

SUBNETWORK_FIELD_NUMBER

public static final int SUBNETWORK_FIELD_NUMBER
Field Value
Type Description
int

TEMP_LOCATION_FIELD_NUMBER

public static final int TEMP_LOCATION_FIELD_NUMBER
Field Value
Type Description
int

WORKER_REGION_FIELD_NUMBER

public static final int WORKER_REGION_FIELD_NUMBER
Field Value
Type Description
int

WORKER_ZONE_FIELD_NUMBER

public static final int WORKER_ZONE_FIELD_NUMBER
Field Value
Type Description
int

ZONE_FIELD_NUMBER

public static final int ZONE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RuntimeEnvironment getDefaultInstance()
Returns
Type Description
RuntimeEnvironment

getDescriptor()

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

newBuilder()

public static RuntimeEnvironment.Builder newBuilder()
Returns
Type Description
RuntimeEnvironment.Builder

newBuilder(RuntimeEnvironment prototype)

public static RuntimeEnvironment.Builder newBuilder(RuntimeEnvironment prototype)
Parameter
Name Description
prototype RuntimeEnvironment
Returns
Type Description
RuntimeEnvironment.Builder

parseDelimitedFrom(InputStream input)

public static RuntimeEnvironment parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RuntimeEnvironment
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RuntimeEnvironment parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RuntimeEnvironment
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RuntimeEnvironment parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RuntimeEnvironment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RuntimeEnvironment parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RuntimeEnvironment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RuntimeEnvironment parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RuntimeEnvironment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RuntimeEnvironment parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RuntimeEnvironment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RuntimeEnvironment parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RuntimeEnvironment
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RuntimeEnvironment parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RuntimeEnvironment
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RuntimeEnvironment parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RuntimeEnvironment
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RuntimeEnvironment parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RuntimeEnvironment
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RuntimeEnvironment parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RuntimeEnvironment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RuntimeEnvironment parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RuntimeEnvironment
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RuntimeEnvironment> parser()
Returns
Type Description
Parser<RuntimeEnvironment>

Methods

containsAdditionalUserLabels(String key)

public boolean containsAdditionalUserLabels(String key)

Additional user labels to be specified for the job. Keys and values should 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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAdditionalExperiments(int index)

public String getAdditionalExperiments(int index)

Additional experiment flags for the job, specified with the --experiments option.

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, specified with the --experiments option.

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, specified with the --experiments option.

repeated string additional_experiments = 7;

Returns
Type Description
int

The count of additionalExperiments.

getAdditionalExperimentsList()

public ProtocolStringList getAdditionalExperimentsList()

Additional experiment flags for the job, specified with the --experiments option.

repeated string additional_experiments = 7;

Returns
Type Description
ProtocolStringList

A list containing the additionalExperiments.

getAdditionalUserLabels() (deprecated)

public Map<String,String> getAdditionalUserLabels()

Use #getAdditionalUserLabelsMap() instead.

Returns
Type Description
Map<String,String>

getAdditionalUserLabelsCount()

public int getAdditionalUserLabelsCount()

Additional user labels to be specified for the job. Keys and values should 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 Map<String,String> getAdditionalUserLabelsMap()

Additional user labels to be specified for the job. Keys and values should 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 String getAdditionalUserLabelsOrDefault(String key, String defaultValue)

Additional user labels to be specified for the job. Keys and values should 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 String getAdditionalUserLabelsOrThrow(String key)

Additional user labels to be specified for the job. Keys and values should 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

getBypassTempDirValidation()

public boolean getBypassTempDirValidation()

Whether to bypass the safety checks for the job's temporary directory. Use with caution.

bool bypass_temp_dir_validation = 5;

Returns
Type Description
boolean

The bypassTempDirValidation.

getDefaultInstanceForType()

public RuntimeEnvironment getDefaultInstanceForType()
Returns
Type Description
RuntimeEnvironment

getEnableStreamingEngine()

public boolean getEnableStreamingEngine()

Whether to enable Streaming Engine for the job.

bool enable_streaming_engine = 17;

Returns
Type Description
boolean

The enableStreamingEngine.

getIpConfiguration()

public WorkerIPAddressConfiguration getIpConfiguration()

Configuration for VM IPs.

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

Returns
Type Description
WorkerIPAddressConfiguration

The ipConfiguration.

getIpConfigurationValue()

public int getIpConfigurationValue()

Configuration for VM IPs.

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

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 = 12;

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 = 12;

Returns
Type Description
ByteString

The bytes for kmsKeyName.

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 = 1;

Returns
Type Description
int

The maxWorkers.

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 instnaces for the job.

int32 num_workers = 11;

Returns
Type Description
int

The numWorkers.

getParserForType()

public Parser<RuntimeEnvironment> getParserForType()
Returns
Type Description
Parser<RuntimeEnvironment>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServiceAccountEmail()

public String getServiceAccountEmail()

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

string service_account_email = 3;

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 = 3;

Returns
Type Description
ByteString

The bytes for serviceAccountEmail.

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;

Returns
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;

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 = 4;

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 = 4;

Returns
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 = 15;

Returns
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 = 15;

Returns
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 = 16;

Returns
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 = 16;

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 = 2;

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 = 2;

Returns
Type Description
ByteString

The bytes for zone.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RuntimeEnvironment.Builder newBuilderForType()
Returns
Type Description
RuntimeEnvironment.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RuntimeEnvironment.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RuntimeEnvironment.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RuntimeEnvironment.Builder toBuilder()
Returns
Type Description
RuntimeEnvironment.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException