- 0.59.0 (latest)
- 0.58.0
- 0.57.0
- 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 static final class RuntimeEnvironment.Builder extends GeneratedMessageV3.Builder<RuntimeEnvironment.Builder> implements RuntimeEnvironmentOrBuilderThe environment values to set at runtime.
Protobuf type google.dataflow.v1beta3.RuntimeEnvironment
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RuntimeEnvironment.BuilderImplements
RuntimeEnvironmentOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addAdditionalExperiments(String value)
public RuntimeEnvironment.Builder addAdditionalExperiments(String value) Additional experiment flags for the job, specified with the
--experiments option.
repeated string additional_experiments = 7;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe additionalExperiments to add. |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
addAdditionalExperimentsBytes(ByteString value)
public RuntimeEnvironment.Builder addAdditionalExperimentsBytes(ByteString value) Additional experiment flags for the job, specified with the
--experiments option.
repeated string additional_experiments = 7;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes of the additionalExperiments to add. |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
addAllAdditionalExperiments(Iterable<String> values)
public RuntimeEnvironment.Builder addAllAdditionalExperiments(Iterable<String> values) Additional experiment flags for the job, specified with the
--experiments option.
repeated string additional_experiments = 7;
| Parameter | |
|---|---|
| Name | Description |
values | Iterable<String>The additionalExperiments to add. |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public RuntimeEnvironment.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | |
build()
public RuntimeEnvironment build()| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment | |
buildPartial()
public RuntimeEnvironment buildPartial()| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment | |
clear()
public RuntimeEnvironment.Builder clear()| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | |
clearAdditionalExperiments()
public RuntimeEnvironment.Builder clearAdditionalExperiments() Additional experiment flags for the job, specified with the
--experiments option.
repeated string additional_experiments = 7;
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
clearAdditionalUserLabels()
public RuntimeEnvironment.Builder clearAdditionalUserLabels()| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | |
clearBypassTempDirValidation()
public RuntimeEnvironment.Builder clearBypassTempDirValidation()Whether to bypass the safety checks for the job's temporary directory. Use with caution.
bool bypass_temp_dir_validation = 5;
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
clearEnableStreamingEngine()
public RuntimeEnvironment.Builder clearEnableStreamingEngine()Whether to enable Streaming Engine for the job.
bool enable_streaming_engine = 17;
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public RuntimeEnvironment.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | |
clearIpConfiguration()
public RuntimeEnvironment.Builder clearIpConfiguration()Configuration for VM IPs.
.google.dataflow.v1beta3.WorkerIPAddressConfiguration ip_configuration = 14;
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
clearKmsKeyName()
public RuntimeEnvironment.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 = 12;
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
clearMachineType()
public RuntimeEnvironment.Builder clearMachineType()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 |
RuntimeEnvironment.Builder | This builder for chaining. |
clearMaxWorkers()
public RuntimeEnvironment.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 = 1;
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
clearNetwork()
public RuntimeEnvironment.Builder clearNetwork()Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
string network = 8;
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
clearNumWorkers()
public RuntimeEnvironment.Builder clearNumWorkers()The initial number of Google Compute Engine instnaces for the job.
int32 num_workers = 11;
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public RuntimeEnvironment.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | |
clearServiceAccountEmail()
public RuntimeEnvironment.Builder clearServiceAccountEmail()The email address of the service account to run the job as.
string service_account_email = 3;
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
clearSubnetwork()
public RuntimeEnvironment.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;
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
clearTempLocation()
public RuntimeEnvironment.Builder clearTempLocation() 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 |
RuntimeEnvironment.Builder | This builder for chaining. |
clearWorkerRegion()
public RuntimeEnvironment.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 = 15;
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
clearWorkerZone()
public RuntimeEnvironment.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 = 16;
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
clearZone()
public RuntimeEnvironment.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 = 2;
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
clone()
public RuntimeEnvironment.Builder clone()| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | |
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 | |
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 | intThe 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 | intThe 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 | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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. |
getMutableAdditionalUserLabels() (deprecated)
public Map<String,String> getMutableAdditionalUserLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| 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;
| 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. |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(RuntimeEnvironment other)
public RuntimeEnvironment.Builder mergeFrom(RuntimeEnvironment other)| Parameter | |
|---|---|
| Name | Description |
other | RuntimeEnvironment |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public RuntimeEnvironment.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public RuntimeEnvironment.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final RuntimeEnvironment.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | |
putAdditionalUserLabels(String key, String value)
public RuntimeEnvironment.Builder putAdditionalUserLabels(String key, String value)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 |
value | String |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | |
putAllAdditionalUserLabels(Map<String,String> values)
public RuntimeEnvironment.Builder putAllAdditionalUserLabels(Map<String,String> values)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 |
values | Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | |
removeAdditionalUserLabels(String key)
public RuntimeEnvironment.Builder removeAdditionalUserLabels(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 |
RuntimeEnvironment.Builder | |
setAdditionalExperiments(int index, String value)
public RuntimeEnvironment.Builder setAdditionalExperiments(int index, String value) Additional experiment flags for the job, specified with the
--experiments option.
repeated string additional_experiments = 7;
| Parameters | |
|---|---|
| Name | Description |
index | intThe index to set the value at. |
value | StringThe additionalExperiments to set. |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
setBypassTempDirValidation(boolean value)
public RuntimeEnvironment.Builder setBypassTempDirValidation(boolean value)Whether to bypass the safety checks for the job's temporary directory. Use with caution.
bool bypass_temp_dir_validation = 5;
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe bypassTempDirValidation to set. |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
setEnableStreamingEngine(boolean value)
public RuntimeEnvironment.Builder setEnableStreamingEngine(boolean value)Whether to enable Streaming Engine for the job.
bool enable_streaming_engine = 17;
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe enableStreamingEngine to set. |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public RuntimeEnvironment.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | |
setIpConfiguration(WorkerIPAddressConfiguration value)
public RuntimeEnvironment.Builder setIpConfiguration(WorkerIPAddressConfiguration value)Configuration for VM IPs.
.google.dataflow.v1beta3.WorkerIPAddressConfiguration ip_configuration = 14;
| Parameter | |
|---|---|
| Name | Description |
value | WorkerIPAddressConfigurationThe ipConfiguration to set. |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
setIpConfigurationValue(int value)
public RuntimeEnvironment.Builder setIpConfigurationValue(int value)Configuration for VM IPs.
.google.dataflow.v1beta3.WorkerIPAddressConfiguration ip_configuration = 14;
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for ipConfiguration to set. |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
setKmsKeyName(String value)
public RuntimeEnvironment.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 = 12;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe kmsKeyName to set. |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
setKmsKeyNameBytes(ByteString value)
public RuntimeEnvironment.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 = 12;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for kmsKeyName to set. |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
setMachineType(String value)
public RuntimeEnvironment.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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe machineType to set. |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
setMachineTypeBytes(ByteString value)
public RuntimeEnvironment.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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for machineType to set. |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
setMaxWorkers(int value)
public RuntimeEnvironment.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 = 1;
| Parameter | |
|---|---|
| Name | Description |
value | intThe maxWorkers to set. |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
setNetwork(String value)
public RuntimeEnvironment.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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe network to set. |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
setNetworkBytes(ByteString value)
public RuntimeEnvironment.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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for network to set. |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
setNumWorkers(int value)
public RuntimeEnvironment.Builder setNumWorkers(int value)The initial number of Google Compute Engine instnaces for the job.
int32 num_workers = 11;
| Parameter | |
|---|---|
| Name | Description |
value | intThe numWorkers to set. |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public RuntimeEnvironment.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | |
setServiceAccountEmail(String value)
public RuntimeEnvironment.Builder setServiceAccountEmail(String value)The email address of the service account to run the job as.
string service_account_email = 3;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe serviceAccountEmail to set. |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
setServiceAccountEmailBytes(ByteString value)
public RuntimeEnvironment.Builder setServiceAccountEmailBytes(ByteString value)The email address of the service account to run the job as.
string service_account_email = 3;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for serviceAccountEmail to set. |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
setSubnetwork(String value)
public RuntimeEnvironment.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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe subnetwork to set. |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
setSubnetworkBytes(ByteString value)
public RuntimeEnvironment.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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for subnetwork to set. |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
setTempLocation(String value)
public RuntimeEnvironment.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 = 4;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe tempLocation to set. |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
setTempLocationBytes(ByteString value)
public RuntimeEnvironment.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 = 4;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for tempLocation to set. |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final RuntimeEnvironment.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | |
setWorkerRegion(String value)
public RuntimeEnvironment.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 = 15;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe workerRegion to set. |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
setWorkerRegionBytes(ByteString value)
public RuntimeEnvironment.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 = 15;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for workerRegion to set. |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
setWorkerZone(String value)
public RuntimeEnvironment.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 = 16;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe workerZone to set. |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
setWorkerZoneBytes(ByteString value)
public RuntimeEnvironment.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 = 16;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for workerZone to set. |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
setZone(String value)
public RuntimeEnvironment.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 = 2;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe zone to set. |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |
setZoneBytes(ByteString value)
public RuntimeEnvironment.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 = 2;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for zone to set. |
| Returns | |
|---|---|
| Type | Description |
RuntimeEnvironment.Builder | This builder for chaining. |