Class FlexTemplateRuntimeEnvironment

public final class FlexTemplateRuntimeEnvironment extends GeneratedMessageV3 implements FlexTemplateRuntimeEnvironmentOrBuilder

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

Protobuf type google.dataflow.v1beta3.FlexTemplateRuntimeEnvironment

Inheritance

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

Fields

ADDITIONAL_EXPERIMENTS_FIELD_NUMBER

public static final int ADDITIONAL_EXPERIMENTS_FIELD_NUMBER
Field Value
TypeDescription
int

ADDITIONAL_USER_LABELS_FIELD_NUMBER

public static final int ADDITIONAL_USER_LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

ENABLE_STREAMING_ENGINE_FIELD_NUMBER

public static final int ENABLE_STREAMING_ENGINE_FIELD_NUMBER
Field Value
TypeDescription
int

FLEXRS_GOAL_FIELD_NUMBER

public static final int FLEXRS_GOAL_FIELD_NUMBER
Field Value
TypeDescription
int

IP_CONFIGURATION_FIELD_NUMBER

public static final int IP_CONFIGURATION_FIELD_NUMBER
Field Value
TypeDescription
int

KMS_KEY_NAME_FIELD_NUMBER

public static final int KMS_KEY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

MACHINE_TYPE_FIELD_NUMBER

public static final int MACHINE_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

MAX_WORKERS_FIELD_NUMBER

public static final int MAX_WORKERS_FIELD_NUMBER
Field Value
TypeDescription
int

NETWORK_FIELD_NUMBER

public static final int NETWORK_FIELD_NUMBER
Field Value
TypeDescription
int

NUM_WORKERS_FIELD_NUMBER

public static final int NUM_WORKERS_FIELD_NUMBER
Field Value
TypeDescription
int

SDK_CONTAINER_IMAGE_FIELD_NUMBER

public static final int SDK_CONTAINER_IMAGE_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER
Field Value
TypeDescription
int

STAGING_LOCATION_FIELD_NUMBER

public static final int STAGING_LOCATION_FIELD_NUMBER
Field Value
TypeDescription
int

SUBNETWORK_FIELD_NUMBER

public static final int SUBNETWORK_FIELD_NUMBER
Field Value
TypeDescription
int

TEMP_LOCATION_FIELD_NUMBER

public static final int TEMP_LOCATION_FIELD_NUMBER
Field Value
TypeDescription
int

WORKER_REGION_FIELD_NUMBER

public static final int WORKER_REGION_FIELD_NUMBER
Field Value
TypeDescription
int

WORKER_ZONE_FIELD_NUMBER

public static final int WORKER_ZONE_FIELD_NUMBER
Field Value
TypeDescription
int

ZONE_FIELD_NUMBER

public static final int ZONE_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

containsAdditionalUserLabels(String key)

public boolean containsAdditionalUserLabels(String key)

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

map<string, string> additional_user_labels = 10;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAdditionalExperiments(int index)

public String getAdditionalExperiments(int index)

Additional experiment flags for the job.

repeated string additional_experiments = 7;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The additionalExperiments at the given index.

getAdditionalExperimentsBytes(int index)

public ByteString getAdditionalExperimentsBytes(int index)

Additional experiment flags for the job.

repeated string additional_experiments = 7;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the additionalExperiments at the given index.

getAdditionalExperimentsCount()

public int getAdditionalExperimentsCount()

Additional experiment flags for the job.

repeated string additional_experiments = 7;

Returns
TypeDescription
int

The count of additionalExperiments.

getAdditionalExperimentsList()

public ProtocolStringList getAdditionalExperimentsList()

Additional experiment flags for the job.

repeated string additional_experiments = 7;

Returns
TypeDescription
ProtocolStringList

A list containing the additionalExperiments.

getAdditionalUserLabels()

public Map<String,String> getAdditionalUserLabels()
Returns
TypeDescription
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;

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

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

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getDefaultInstance()

public static FlexTemplateRuntimeEnvironment getDefaultInstance()
Returns
TypeDescription
FlexTemplateRuntimeEnvironment

getDefaultInstanceForType()

public FlexTemplateRuntimeEnvironment getDefaultInstanceForType()
Returns
TypeDescription
FlexTemplateRuntimeEnvironment

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getEnableStreamingEngine()

public boolean getEnableStreamingEngine()

Whether to enable Streaming Engine for the job.

bool enable_streaming_engine = 15;

Returns
TypeDescription
boolean

The enableStreamingEngine.

getFlexrsGoal()

public FlexResourceSchedulingGoal getFlexrsGoal()

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

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

Returns
TypeDescription
FlexResourceSchedulingGoal

The flexrsGoal.

getFlexrsGoalValue()

public int getFlexrsGoalValue()

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

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

Returns
TypeDescription
int

The enum numeric value on the wire for flexrsGoal.

getIpConfiguration()

public WorkerIPAddressConfiguration getIpConfiguration()

Configuration for VM IPs.

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

Returns
TypeDescription
WorkerIPAddressConfiguration

The ipConfiguration.

getIpConfigurationValue()

public int getIpConfigurationValue()

Configuration for VM IPs.

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

Returns
TypeDescription
int

The enum numeric value on the wire for ipConfiguration.

getKmsKeyName()

public String getKmsKeyName()

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

string kms_key_name = 11;

Returns
TypeDescription
String

The kmsKeyName.

getKmsKeyNameBytes()

public ByteString getKmsKeyNameBytes()

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

string kms_key_name = 11;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for machineType.

getMaxWorkers()

public int getMaxWorkers()

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

int32 max_workers = 2;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for network.

getNumWorkers()

public int getNumWorkers()

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

int32 num_workers = 1;

Returns
TypeDescription
int

The numWorkers.

getParserForType()

public Parser<FlexTemplateRuntimeEnvironment> getParserForType()
Returns
TypeDescription
Parser<FlexTemplateRuntimeEnvironment>
Overrides

getSdkContainerImage()

public String getSdkContainerImage()

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

string sdk_container_image = 18;

Returns
TypeDescription
String

The sdkContainerImage.

getSdkContainerImageBytes()

public ByteString getSdkContainerImageBytes()

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

string sdk_container_image = 18;

Returns
TypeDescription
ByteString

The bytes for sdkContainerImage.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getServiceAccountEmail()

public String getServiceAccountEmail()

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

string service_account_email = 4;

Returns
TypeDescription
String

The serviceAccountEmail.

getServiceAccountEmailBytes()

public ByteString getServiceAccountEmailBytes()

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

string service_account_email = 4;

Returns
TypeDescription
ByteString

The bytes for serviceAccountEmail.

getStagingLocation()

public String getStagingLocation()

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

string staging_location = 17;

Returns
TypeDescription
String

The stagingLocation.

getStagingLocationBytes()

public ByteString getStagingLocationBytes()

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

string staging_location = 17;

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

Returns
TypeDescription
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
TypeDescription
ByteString

The bytes for subnetwork.

getTempLocation()

public String getTempLocation()

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

string temp_location = 5;

Returns
TypeDescription
String

The tempLocation.

getTempLocationBytes()

public ByteString getTempLocationBytes()

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

string temp_location = 5;

Returns
TypeDescription
ByteString

The bytes for tempLocation.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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;

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

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

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

Returns
TypeDescription
ByteString

The bytes for workerZone.

getZone()

public String getZone()

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

string zone = 3;

Returns
TypeDescription
String

The zone.

getZoneBytes()

public ByteString getZoneBytes()

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

string zone = 3;

Returns
TypeDescription
ByteString

The bytes for zone.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static FlexTemplateRuntimeEnvironment.Builder newBuilder()
Returns
TypeDescription
FlexTemplateRuntimeEnvironment.Builder

newBuilder(FlexTemplateRuntimeEnvironment prototype)

public static FlexTemplateRuntimeEnvironment.Builder newBuilder(FlexTemplateRuntimeEnvironment prototype)
Parameter
NameDescription
prototypeFlexTemplateRuntimeEnvironment
Returns
TypeDescription
FlexTemplateRuntimeEnvironment.Builder

newBuilderForType()

public FlexTemplateRuntimeEnvironment.Builder newBuilderForType()
Returns
TypeDescription
FlexTemplateRuntimeEnvironment.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FlexTemplateRuntimeEnvironment.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
FlexTemplateRuntimeEnvironment.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static FlexTemplateRuntimeEnvironment parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
FlexTemplateRuntimeEnvironment
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FlexTemplateRuntimeEnvironment parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FlexTemplateRuntimeEnvironment
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static FlexTemplateRuntimeEnvironment parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
FlexTemplateRuntimeEnvironment
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FlexTemplateRuntimeEnvironment parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FlexTemplateRuntimeEnvironment
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FlexTemplateRuntimeEnvironment parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
FlexTemplateRuntimeEnvironment
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FlexTemplateRuntimeEnvironment parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FlexTemplateRuntimeEnvironment
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FlexTemplateRuntimeEnvironment parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
FlexTemplateRuntimeEnvironment
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FlexTemplateRuntimeEnvironment parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FlexTemplateRuntimeEnvironment
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static FlexTemplateRuntimeEnvironment parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
FlexTemplateRuntimeEnvironment
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FlexTemplateRuntimeEnvironment parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FlexTemplateRuntimeEnvironment
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static FlexTemplateRuntimeEnvironment parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
FlexTemplateRuntimeEnvironment
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FlexTemplateRuntimeEnvironment parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FlexTemplateRuntimeEnvironment
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<FlexTemplateRuntimeEnvironment> parser()
Returns
TypeDescription
Parser<FlexTemplateRuntimeEnvironment>

toBuilder()

public FlexTemplateRuntimeEnvironment.Builder toBuilder()
Returns
TypeDescription
FlexTemplateRuntimeEnvironment.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException