Class Environment.Builder (0.23.0)

public static final class Environment.Builder extends GeneratedMessageV3.Builder<Environment.Builder> implements EnvironmentOrBuilder

Describes the environment in which a Dataflow Job runs.

Protobuf type google.dataflow.v1beta3.Environment

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Environment.Builder

Implements

EnvironmentOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllExperiments(Iterable<String> values)

public Environment.Builder addAllExperiments(Iterable<String> values)

The list of experiments to enable. This field should be used for SDK related experiments and not for service related experiments. The proper field for service related experiments is service_options.

repeated string experiments = 3;

Parameter
Name	Description
`values`	`Iterable<String>` The experiments to add.

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

addAllServiceOptions(Iterable<String> values)

public Environment.Builder addAllServiceOptions(Iterable<String> values)

The list of service options to enable. This field should be used for service related experiments only. These experiments, when graduating to GA, should be replaced by dedicated fields or become default (i.e. always on).

repeated string service_options = 16;

Parameter
Name	Description
`values`	`Iterable<String>` The serviceOptions to add.

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

addAllWorkerPools(Iterable<? extends WorkerPool> values)

public Environment.Builder addAllWorkerPools(Iterable<? extends WorkerPool> values)

The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

repeated .google.dataflow.v1beta3.WorkerPool worker_pools = 4;

Parameter
Name	Description
`values`	`Iterable<? extends com.google.dataflow.v1beta3.WorkerPool>`

Returns
Type	Description
`Environment.Builder`

addExperiments(String value)

public Environment.Builder addExperiments(String value)

The list of experiments to enable. This field should be used for SDK related experiments and not for service related experiments. The proper field for service related experiments is service_options.

repeated string experiments = 3;

Parameter
Name	Description
`value`	`String` The experiments to add.

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

addExperimentsBytes(ByteString value)

public Environment.Builder addExperimentsBytes(ByteString value)

The list of experiments to enable. This field should be used for SDK related experiments and not for service related experiments. The proper field for service related experiments is service_options.

repeated string experiments = 3;

Parameter
Name	Description
`value`	`ByteString` The bytes of the experiments to add.

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Environment.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`Environment.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addServiceOptions(String value)

public Environment.Builder addServiceOptions(String value)

repeated string service_options = 16;

Parameter
Name	Description
`value`	`String` The serviceOptions to add.

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

addServiceOptionsBytes(ByteString value)

public Environment.Builder addServiceOptionsBytes(ByteString value)

repeated string service_options = 16;

Parameter
Name	Description
`value`	`ByteString` The bytes of the serviceOptions to add.

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

addWorkerPools(WorkerPool value)

public Environment.Builder addWorkerPools(WorkerPool value)

The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

repeated .google.dataflow.v1beta3.WorkerPool worker_pools = 4;

Parameter
Name	Description
`value`	`WorkerPool`

Returns
Type	Description
`Environment.Builder`

addWorkerPools(WorkerPool.Builder builderForValue)

public Environment.Builder addWorkerPools(WorkerPool.Builder builderForValue)

The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

repeated .google.dataflow.v1beta3.WorkerPool worker_pools = 4;

Parameter
Name	Description
`builderForValue`	`WorkerPool.Builder`

Returns
Type	Description
`Environment.Builder`

addWorkerPools(int index, WorkerPool value)

public Environment.Builder addWorkerPools(int index, WorkerPool value)

The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

repeated .google.dataflow.v1beta3.WorkerPool worker_pools = 4;

Parameters
Name	Description
`index`	`int`
`value`	`WorkerPool`

Returns
Type	Description
`Environment.Builder`

addWorkerPools(int index, WorkerPool.Builder builderForValue)

public Environment.Builder addWorkerPools(int index, WorkerPool.Builder builderForValue)

The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

repeated .google.dataflow.v1beta3.WorkerPool worker_pools = 4;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`WorkerPool.Builder`

Returns
Type	Description
`Environment.Builder`

addWorkerPoolsBuilder()

public WorkerPool.Builder addWorkerPoolsBuilder()

The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

repeated .google.dataflow.v1beta3.WorkerPool worker_pools = 4;

Returns
Type	Description
`WorkerPool.Builder`

addWorkerPoolsBuilder(int index)

public WorkerPool.Builder addWorkerPoolsBuilder(int index)

The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

repeated .google.dataflow.v1beta3.WorkerPool worker_pools = 4;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`WorkerPool.Builder`

build()

public Environment build()

Returns
Type	Description
`Environment`

buildPartial()

public Environment buildPartial()

Returns
Type	Description
`Environment`

clear()

public Environment.Builder clear()

Returns
Type	Description
`Environment.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearClusterManagerApiService()

public Environment.Builder clearClusterManagerApiService()

The type of cluster manager API to use. If unknown or unspecified, the service will attempt to choose a reasonable default. This should be in the form of the API service name, e.g. "compute.googleapis.com".

string cluster_manager_api_service = 2;

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

clearDataset()

public Environment.Builder clearDataset()

The dataset for the current project where various workflow related tables are stored.

The supported resource type is:

Google BigQuery: bigquery.googleapis.com/{dataset}

string dataset = 7;

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

clearDebugOptions()

public Environment.Builder clearDebugOptions()

Any debugging options to be supplied to the job.

.google.dataflow.v1beta3.DebugOptions debug_options = 17;

Returns
Type	Description
`Environment.Builder`

clearExperiments()

public Environment.Builder clearExperiments()

The list of experiments to enable. This field should be used for SDK related experiments and not for service related experiments. The proper field for service related experiments is service_options.

repeated string experiments = 3;

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Environment.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`Environment.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFlexResourceSchedulingGoal()

public Environment.Builder clearFlexResourceSchedulingGoal()

Which Flexible Resource Scheduling mode to run in.

.google.dataflow.v1beta3.FlexResourceSchedulingGoal flex_resource_scheduling_goal = 11;

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

clearInternalExperiments()

public Environment.Builder clearInternalExperiments()

Experimental settings.

.google.protobuf.Any internal_experiments = 9;

Returns
Type	Description
`Environment.Builder`

clearOneof(Descriptors.OneofDescriptor oneof)

public Environment.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`Environment.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearSdkPipelineOptions()

public Environment.Builder clearSdkPipelineOptions()

The Cloud Dataflow SDK pipeline options specified by the user. These options are passed through the service and are used to recreate the SDK pipeline options on the worker in a language agnostic and platform independent way.

.google.protobuf.Struct sdk_pipeline_options = 8;

Returns
Type	Description
`Environment.Builder`

clearServiceAccountEmail()

public Environment.Builder clearServiceAccountEmail()

Identity to run virtual machines as. Defaults to the default account.

string service_account_email = 10;

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

clearServiceKmsKeyName()

public Environment.Builder clearServiceKmsKeyName()

If set, contains the Cloud KMS key identifier used to encrypt data at rest, AKA a Customer Managed Encryption Key (CMEK).

Format: projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY

string service_kms_key_name = 12;

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

clearServiceOptions()

public Environment.Builder clearServiceOptions()

repeated string service_options = 16;

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

clearShuffleMode()

public Environment.Builder clearShuffleMode()

Output only. The shuffle mode used for the job.

.google.dataflow.v1beta3.ShuffleMode shuffle_mode = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

clearTempStoragePrefix()

public Environment.Builder clearTempStoragePrefix()

The prefix of the resources the system should use for temporary storage. The system will append the suffix "/temp-{JOBNAME} to this resource prefix, where {JOBNAME} is the value of the job_name field. The resulting bucket and object prefix is used as the prefix of the resources used to store temporary data needed during the job execution. NOTE: This will override the value in taskrunner_settings. The supported resource type is:

Google Cloud Storage:

storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}

string temp_storage_prefix = 1;

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

clearUserAgent()

public Environment.Builder clearUserAgent()

A description of the process that generated the request.

.google.protobuf.Struct user_agent = 5;

Returns
Type	Description
`Environment.Builder`

clearVersion()

public Environment.Builder clearVersion()

A structure describing which components and their versions of the service are required in order to run the job.

.google.protobuf.Struct version = 6;

Returns
Type	Description
`Environment.Builder`

clearWorkerPools()

public Environment.Builder clearWorkerPools()

The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

repeated .google.dataflow.v1beta3.WorkerPool worker_pools = 4;

Returns
Type	Description
`Environment.Builder`

clearWorkerRegion()

public Environment.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 = 13;

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

clearWorkerZone()

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

string worker_zone = 14;

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

clone()

public Environment.Builder clone()

Returns
Type	Description
`Environment.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getClusterManagerApiService()

public String getClusterManagerApiService()

string cluster_manager_api_service = 2;

Returns
Type	Description
`String`	The clusterManagerApiService.

getClusterManagerApiServiceBytes()

public ByteString getClusterManagerApiServiceBytes()

string cluster_manager_api_service = 2;

Returns
Type	Description
`ByteString`	The bytes for clusterManagerApiService.

getDataset()

public String getDataset()

The dataset for the current project where various workflow related tables are stored.

The supported resource type is:

Google BigQuery: bigquery.googleapis.com/{dataset}

string dataset = 7;

Returns
Type	Description
`String`	The dataset.

getDatasetBytes()

public ByteString getDatasetBytes()

The dataset for the current project where various workflow related tables are stored.

The supported resource type is:

Google BigQuery: bigquery.googleapis.com/{dataset}

string dataset = 7;

Returns
Type	Description
`ByteString`	The bytes for dataset.

getDebugOptions()

public DebugOptions getDebugOptions()

Any debugging options to be supplied to the job.

.google.dataflow.v1beta3.DebugOptions debug_options = 17;

Returns
Type	Description
`DebugOptions`	The debugOptions.

getDebugOptionsBuilder()

public DebugOptions.Builder getDebugOptionsBuilder()

Any debugging options to be supplied to the job.

.google.dataflow.v1beta3.DebugOptions debug_options = 17;

Returns
Type	Description
`DebugOptions.Builder`

getDebugOptionsOrBuilder()

public DebugOptionsOrBuilder getDebugOptionsOrBuilder()

Any debugging options to be supplied to the job.

.google.dataflow.v1beta3.DebugOptions debug_options = 17;

Returns
Type	Description
`DebugOptionsOrBuilder`

getDefaultInstanceForType()

public Environment getDefaultInstanceForType()

Returns
Type	Description
`Environment`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getExperiments(int index)

public String getExperiments(int index)

The list of experiments to enable. This field should be used for SDK related experiments and not for service related experiments. The proper field for service related experiments is service_options.

repeated string experiments = 3;

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The experiments at the given index.

getExperimentsBytes(int index)

public ByteString getExperimentsBytes(int index)

The list of experiments to enable. This field should be used for SDK related experiments and not for service related experiments. The proper field for service related experiments is service_options.

repeated string experiments = 3;

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the experiments at the given index.

getExperimentsCount()

public int getExperimentsCount()

The list of experiments to enable. This field should be used for SDK related experiments and not for service related experiments. The proper field for service related experiments is service_options.

repeated string experiments = 3;

Returns
Type	Description
`int`	The count of experiments.

getExperimentsList()

public ProtocolStringList getExperimentsList()

The list of experiments to enable. This field should be used for SDK related experiments and not for service related experiments. The proper field for service related experiments is service_options.

repeated string experiments = 3;

Returns
Type	Description
`ProtocolStringList`	A list containing the experiments.

getFlexResourceSchedulingGoal()

public FlexResourceSchedulingGoal getFlexResourceSchedulingGoal()

Which Flexible Resource Scheduling mode to run in.

.google.dataflow.v1beta3.FlexResourceSchedulingGoal flex_resource_scheduling_goal = 11;

Returns
Type	Description
`FlexResourceSchedulingGoal`	The flexResourceSchedulingGoal.

getFlexResourceSchedulingGoalValue()

public int getFlexResourceSchedulingGoalValue()

Which Flexible Resource Scheduling mode to run in.

.google.dataflow.v1beta3.FlexResourceSchedulingGoal flex_resource_scheduling_goal = 11;

Returns
Type	Description
`int`	The enum numeric value on the wire for flexResourceSchedulingGoal.

getInternalExperiments()

public Any getInternalExperiments()

Experimental settings.

.google.protobuf.Any internal_experiments = 9;

Returns
Type	Description
`Any`	The internalExperiments.

getInternalExperimentsBuilder()

public Any.Builder getInternalExperimentsBuilder()

Experimental settings.

.google.protobuf.Any internal_experiments = 9;

Returns
Type	Description
`Builder`

getInternalExperimentsOrBuilder()

public AnyOrBuilder getInternalExperimentsOrBuilder()

Experimental settings.

.google.protobuf.Any internal_experiments = 9;

Returns
Type	Description
`AnyOrBuilder`

getSdkPipelineOptions()

public Struct getSdkPipelineOptions()

.google.protobuf.Struct sdk_pipeline_options = 8;

Returns
Type	Description
`Struct`	The sdkPipelineOptions.

getSdkPipelineOptionsBuilder()

public Struct.Builder getSdkPipelineOptionsBuilder()

.google.protobuf.Struct sdk_pipeline_options = 8;

Returns
Type	Description
`Builder`

getSdkPipelineOptionsOrBuilder()

public StructOrBuilder getSdkPipelineOptionsOrBuilder()

.google.protobuf.Struct sdk_pipeline_options = 8;

Returns
Type	Description
`StructOrBuilder`

getServiceAccountEmail()

public String getServiceAccountEmail()

Identity to run virtual machines as. Defaults to the default account.

string service_account_email = 10;

Returns
Type	Description
`String`	The serviceAccountEmail.

getServiceAccountEmailBytes()

public ByteString getServiceAccountEmailBytes()

Identity to run virtual machines as. Defaults to the default account.

string service_account_email = 10;

Returns
Type	Description
`ByteString`	The bytes for serviceAccountEmail.

getServiceKmsKeyName()

public String getServiceKmsKeyName()

If set, contains the Cloud KMS key identifier used to encrypt data at rest, AKA a Customer Managed Encryption Key (CMEK).

Format: projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY

string service_kms_key_name = 12;

Returns
Type	Description
`String`	The serviceKmsKeyName.

getServiceKmsKeyNameBytes()

public ByteString getServiceKmsKeyNameBytes()

If set, contains the Cloud KMS key identifier used to encrypt data at rest, AKA a Customer Managed Encryption Key (CMEK).

Format: projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY

string service_kms_key_name = 12;

Returns
Type	Description
`ByteString`	The bytes for serviceKmsKeyName.

getServiceOptions(int index)

public String getServiceOptions(int index)

repeated string service_options = 16;

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The serviceOptions at the given index.

getServiceOptionsBytes(int index)

public ByteString getServiceOptionsBytes(int index)

repeated string service_options = 16;

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the serviceOptions at the given index.

getServiceOptionsCount()

public int getServiceOptionsCount()

repeated string service_options = 16;

Returns
Type	Description
`int`	The count of serviceOptions.

getServiceOptionsList()

public ProtocolStringList getServiceOptionsList()

repeated string service_options = 16;

Returns
Type	Description
`ProtocolStringList`	A list containing the serviceOptions.

getShuffleMode()

public ShuffleMode getShuffleMode()

Output only. The shuffle mode used for the job.

.google.dataflow.v1beta3.ShuffleMode shuffle_mode = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`ShuffleMode`	The shuffleMode.

getShuffleModeValue()

public int getShuffleModeValue()

Output only. The shuffle mode used for the job.

.google.dataflow.v1beta3.ShuffleMode shuffle_mode = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`int`	The enum numeric value on the wire for shuffleMode.

getTempStoragePrefix()

public String getTempStoragePrefix()

Google Cloud Storage:

storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}

string temp_storage_prefix = 1;

Returns
Type	Description
`String`	The tempStoragePrefix.

getTempStoragePrefixBytes()

public ByteString getTempStoragePrefixBytes()

Google Cloud Storage:

storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}

string temp_storage_prefix = 1;

Returns
Type	Description
`ByteString`	The bytes for tempStoragePrefix.

getUserAgent()

public Struct getUserAgent()

A description of the process that generated the request.

.google.protobuf.Struct user_agent = 5;

Returns
Type	Description
`Struct`	The userAgent.

getUserAgentBuilder()

public Struct.Builder getUserAgentBuilder()

A description of the process that generated the request.

.google.protobuf.Struct user_agent = 5;

Returns
Type	Description
`Builder`

getUserAgentOrBuilder()

public StructOrBuilder getUserAgentOrBuilder()

A description of the process that generated the request.

.google.protobuf.Struct user_agent = 5;

Returns
Type	Description
`StructOrBuilder`

getVersion()

public Struct getVersion()

A structure describing which components and their versions of the service are required in order to run the job.

.google.protobuf.Struct version = 6;

Returns
Type	Description
`Struct`	The version.

getVersionBuilder()

public Struct.Builder getVersionBuilder()

A structure describing which components and their versions of the service are required in order to run the job.

.google.protobuf.Struct version = 6;

Returns
Type	Description
`Builder`

getVersionOrBuilder()

public StructOrBuilder getVersionOrBuilder()

A structure describing which components and their versions of the service are required in order to run the job.

.google.protobuf.Struct version = 6;

Returns
Type	Description
`StructOrBuilder`

getWorkerPools(int index)

public WorkerPool getWorkerPools(int index)

The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

repeated .google.dataflow.v1beta3.WorkerPool worker_pools = 4;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`WorkerPool`

getWorkerPoolsBuilder(int index)

public WorkerPool.Builder getWorkerPoolsBuilder(int index)

The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

repeated .google.dataflow.v1beta3.WorkerPool worker_pools = 4;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`WorkerPool.Builder`

getWorkerPoolsBuilderList()

public List<WorkerPool.Builder> getWorkerPoolsBuilderList()

The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

repeated .google.dataflow.v1beta3.WorkerPool worker_pools = 4;

Returns
Type	Description
`List<Builder>`

getWorkerPoolsCount()

public int getWorkerPoolsCount()

The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

repeated .google.dataflow.v1beta3.WorkerPool worker_pools = 4;

Returns
Type	Description
`int`

getWorkerPoolsList()

public List<WorkerPool> getWorkerPoolsList()

The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

repeated .google.dataflow.v1beta3.WorkerPool worker_pools = 4;

Returns
Type	Description
`List<WorkerPool>`

getWorkerPoolsOrBuilder(int index)

public WorkerPoolOrBuilder getWorkerPoolsOrBuilder(int index)

The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

repeated .google.dataflow.v1beta3.WorkerPool worker_pools = 4;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`WorkerPoolOrBuilder`

getWorkerPoolsOrBuilderList()

public List<? extends WorkerPoolOrBuilder> getWorkerPoolsOrBuilderList()

The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

repeated .google.dataflow.v1beta3.WorkerPool worker_pools = 4;

Returns
Type	Description
`List<? extends com.google.dataflow.v1beta3.WorkerPoolOrBuilder>`

getWorkerRegion()

public String getWorkerRegion()

string worker_region = 13;

Returns
Type	Description
`String`	The workerRegion.

getWorkerRegionBytes()

public ByteString getWorkerRegionBytes()

string worker_region = 13;

Returns
Type	Description
`ByteString`	The bytes for workerRegion.

getWorkerZone()

public String getWorkerZone()

string worker_zone = 14;

Returns
Type	Description
`String`	The workerZone.

getWorkerZoneBytes()

public ByteString getWorkerZoneBytes()

string worker_zone = 14;

Returns
Type	Description
`ByteString`	The bytes for workerZone.

hasDebugOptions()

public boolean hasDebugOptions()

Any debugging options to be supplied to the job.

.google.dataflow.v1beta3.DebugOptions debug_options = 17;

Returns
Type	Description
`boolean`	Whether the debugOptions field is set.

hasInternalExperiments()

public boolean hasInternalExperiments()

Experimental settings.

.google.protobuf.Any internal_experiments = 9;

Returns
Type	Description
`boolean`	Whether the internalExperiments field is set.

hasSdkPipelineOptions()

public boolean hasSdkPipelineOptions()

.google.protobuf.Struct sdk_pipeline_options = 8;

Returns
Type	Description
`boolean`	Whether the sdkPipelineOptions field is set.

hasUserAgent()

public boolean hasUserAgent()

A description of the process that generated the request.

.google.protobuf.Struct user_agent = 5;

Returns
Type	Description
`boolean`	Whether the userAgent field is set.

hasVersion()

public boolean hasVersion()

A structure describing which components and their versions of the service are required in order to run the job.

.google.protobuf.Struct version = 6;

Returns
Type	Description
`boolean`	Whether the version field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeDebugOptions(DebugOptions value)

public Environment.Builder mergeDebugOptions(DebugOptions value)

Any debugging options to be supplied to the job.

.google.dataflow.v1beta3.DebugOptions debug_options = 17;

Parameter
Name	Description
`value`	`DebugOptions`

Returns
Type	Description
`Environment.Builder`

mergeFrom(Environment other)

public Environment.Builder mergeFrom(Environment other)

Parameter
Name	Description
`other`	`Environment`

Returns
Type	Description
`Environment.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Environment.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Environment.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public Environment.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`Environment.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeInternalExperiments(Any value)

public Environment.Builder mergeInternalExperiments(Any value)

Experimental settings.

.google.protobuf.Any internal_experiments = 9;

Parameter
Name	Description
`value`	`Any`

Returns
Type	Description
`Environment.Builder`

mergeSdkPipelineOptions(Struct value)

public Environment.Builder mergeSdkPipelineOptions(Struct value)

.google.protobuf.Struct sdk_pipeline_options = 8;

Parameter
Name	Description
`value`	`Struct`

Returns
Type	Description
`Environment.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Environment.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`Environment.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeUserAgent(Struct value)

public Environment.Builder mergeUserAgent(Struct value)

A description of the process that generated the request.

.google.protobuf.Struct user_agent = 5;

Parameter
Name	Description
`value`	`Struct`

Returns
Type	Description
`Environment.Builder`

mergeVersion(Struct value)

public Environment.Builder mergeVersion(Struct value)

A structure describing which components and their versions of the service are required in order to run the job.

.google.protobuf.Struct version = 6;

Parameter
Name	Description
`value`	`Struct`

Returns
Type	Description
`Environment.Builder`

removeWorkerPools(int index)

public Environment.Builder removeWorkerPools(int index)

The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

repeated .google.dataflow.v1beta3.WorkerPool worker_pools = 4;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Environment.Builder`

setClusterManagerApiService(String value)

public Environment.Builder setClusterManagerApiService(String value)

string cluster_manager_api_service = 2;

Parameter
Name	Description
`value`	`String` The clusterManagerApiService to set.

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

setClusterManagerApiServiceBytes(ByteString value)

public Environment.Builder setClusterManagerApiServiceBytes(ByteString value)

string cluster_manager_api_service = 2;

Parameter
Name	Description
`value`	`ByteString` The bytes for clusterManagerApiService to set.

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

setDataset(String value)

public Environment.Builder setDataset(String value)

The dataset for the current project where various workflow related tables are stored.

The supported resource type is:

Google BigQuery: bigquery.googleapis.com/{dataset}

string dataset = 7;

Parameter
Name	Description
`value`	`String` The dataset to set.

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

setDatasetBytes(ByteString value)

public Environment.Builder setDatasetBytes(ByteString value)

The dataset for the current project where various workflow related tables are stored.

The supported resource type is:

Google BigQuery: bigquery.googleapis.com/{dataset}

string dataset = 7;

Parameter
Name	Description
`value`	`ByteString` The bytes for dataset to set.

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

setDebugOptions(DebugOptions value)

public Environment.Builder setDebugOptions(DebugOptions value)

Any debugging options to be supplied to the job.

.google.dataflow.v1beta3.DebugOptions debug_options = 17;

Parameter
Name	Description
`value`	`DebugOptions`

Returns
Type	Description
`Environment.Builder`

setDebugOptions(DebugOptions.Builder builderForValue)

public Environment.Builder setDebugOptions(DebugOptions.Builder builderForValue)

Any debugging options to be supplied to the job.

.google.dataflow.v1beta3.DebugOptions debug_options = 17;

Parameter
Name	Description
`builderForValue`	`DebugOptions.Builder`

Returns
Type	Description
`Environment.Builder`

setExperiments(int index, String value)

public Environment.Builder setExperiments(int index, String value)

The list of experiments to enable. This field should be used for SDK related experiments and not for service related experiments. The proper field for service related experiments is service_options.

repeated string experiments = 3;

Parameters
Name	Description
`index`	`int` The index to set the value at.
`value`	`String` The experiments to set.

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Environment.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`Environment.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFlexResourceSchedulingGoal(FlexResourceSchedulingGoal value)

public Environment.Builder setFlexResourceSchedulingGoal(FlexResourceSchedulingGoal value)

Which Flexible Resource Scheduling mode to run in.

.google.dataflow.v1beta3.FlexResourceSchedulingGoal flex_resource_scheduling_goal = 11;

Parameter
Name	Description
`value`	`FlexResourceSchedulingGoal` The flexResourceSchedulingGoal to set.

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

setFlexResourceSchedulingGoalValue(int value)

public Environment.Builder setFlexResourceSchedulingGoalValue(int value)

Which Flexible Resource Scheduling mode to run in.

.google.dataflow.v1beta3.FlexResourceSchedulingGoal flex_resource_scheduling_goal = 11;

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for flexResourceSchedulingGoal to set.

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

setInternalExperiments(Any value)

public Environment.Builder setInternalExperiments(Any value)

Experimental settings.

.google.protobuf.Any internal_experiments = 9;

Parameter
Name	Description
`value`	`Any`

Returns
Type	Description
`Environment.Builder`

setInternalExperiments(Any.Builder builderForValue)

public Environment.Builder setInternalExperiments(Any.Builder builderForValue)

Experimental settings.

.google.protobuf.Any internal_experiments = 9;

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`Environment.Builder`

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Environment.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`Environment.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSdkPipelineOptions(Struct value)

public Environment.Builder setSdkPipelineOptions(Struct value)

.google.protobuf.Struct sdk_pipeline_options = 8;

Parameter
Name	Description
`value`	`Struct`

Returns
Type	Description
`Environment.Builder`

setSdkPipelineOptions(Struct.Builder builderForValue)

public Environment.Builder setSdkPipelineOptions(Struct.Builder builderForValue)

.google.protobuf.Struct sdk_pipeline_options = 8;

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`Environment.Builder`

setServiceAccountEmail(String value)

public Environment.Builder setServiceAccountEmail(String value)

Identity to run virtual machines as. Defaults to the default account.

string service_account_email = 10;

Parameter
Name	Description
`value`	`String` The serviceAccountEmail to set.

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

setServiceAccountEmailBytes(ByteString value)

public Environment.Builder setServiceAccountEmailBytes(ByteString value)

Identity to run virtual machines as. Defaults to the default account.

string service_account_email = 10;

Parameter
Name	Description
`value`	`ByteString` The bytes for serviceAccountEmail to set.

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

setServiceKmsKeyName(String value)

public Environment.Builder setServiceKmsKeyName(String value)

If set, contains the Cloud KMS key identifier used to encrypt data at rest, AKA a Customer Managed Encryption Key (CMEK).

Format: projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY

string service_kms_key_name = 12;

Parameter
Name	Description
`value`	`String` The serviceKmsKeyName to set.

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

setServiceKmsKeyNameBytes(ByteString value)

public Environment.Builder setServiceKmsKeyNameBytes(ByteString value)

If set, contains the Cloud KMS key identifier used to encrypt data at rest, AKA a Customer Managed Encryption Key (CMEK).

Format: projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY

string service_kms_key_name = 12;

Parameter
Name	Description
`value`	`ByteString` The bytes for serviceKmsKeyName to set.

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

setServiceOptions(int index, String value)

public Environment.Builder setServiceOptions(int index, String value)

repeated string service_options = 16;

Parameters
Name	Description
`index`	`int` The index to set the value at.
`value`	`String` The serviceOptions to set.

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

setShuffleMode(ShuffleMode value)

public Environment.Builder setShuffleMode(ShuffleMode value)

Output only. The shuffle mode used for the job.

.google.dataflow.v1beta3.ShuffleMode shuffle_mode = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`value`	`ShuffleMode` The shuffleMode to set.

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

setShuffleModeValue(int value)

public Environment.Builder setShuffleModeValue(int value)

Output only. The shuffle mode used for the job.

.google.dataflow.v1beta3.ShuffleMode shuffle_mode = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for shuffleMode to set.

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

setTempStoragePrefix(String value)

public Environment.Builder setTempStoragePrefix(String value)

Google Cloud Storage:

storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}

string temp_storage_prefix = 1;

Parameter
Name	Description
`value`	`String` The tempStoragePrefix to set.

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

setTempStoragePrefixBytes(ByteString value)

public Environment.Builder setTempStoragePrefixBytes(ByteString value)

Google Cloud Storage:

storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}

string temp_storage_prefix = 1;

Parameter
Name	Description
`value`	`ByteString` The bytes for tempStoragePrefix to set.

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Environment.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`Environment.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUserAgent(Struct value)

public Environment.Builder setUserAgent(Struct value)

A description of the process that generated the request.

.google.protobuf.Struct user_agent = 5;

Parameter
Name	Description
`value`	`Struct`

Returns
Type	Description
`Environment.Builder`

setUserAgent(Struct.Builder builderForValue)

public Environment.Builder setUserAgent(Struct.Builder builderForValue)

A description of the process that generated the request.

.google.protobuf.Struct user_agent = 5;

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`Environment.Builder`

setVersion(Struct value)

public Environment.Builder setVersion(Struct value)

A structure describing which components and their versions of the service are required in order to run the job.

.google.protobuf.Struct version = 6;

Parameter
Name	Description
`value`	`Struct`

Returns
Type	Description
`Environment.Builder`

setVersion(Struct.Builder builderForValue)

public Environment.Builder setVersion(Struct.Builder builderForValue)

A structure describing which components and their versions of the service are required in order to run the job.

.google.protobuf.Struct version = 6;

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`Environment.Builder`

setWorkerPools(int index, WorkerPool value)

public Environment.Builder setWorkerPools(int index, WorkerPool value)

The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

repeated .google.dataflow.v1beta3.WorkerPool worker_pools = 4;

Parameters
Name	Description
`index`	`int`
`value`	`WorkerPool`

Returns
Type	Description
`Environment.Builder`

setWorkerPools(int index, WorkerPool.Builder builderForValue)

public Environment.Builder setWorkerPools(int index, WorkerPool.Builder builderForValue)

The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

repeated .google.dataflow.v1beta3.WorkerPool worker_pools = 4;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`WorkerPool.Builder`

Returns
Type	Description
`Environment.Builder`

setWorkerRegion(String value)

public Environment.Builder setWorkerRegion(String value)

string worker_region = 13;

Parameter
Name	Description
`value`	`String` The workerRegion to set.

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

setWorkerRegionBytes(ByteString value)

public Environment.Builder setWorkerRegionBytes(ByteString value)

string worker_region = 13;

Parameter
Name	Description
`value`	`ByteString` The bytes for workerRegion to set.

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

setWorkerZone(String value)

public Environment.Builder setWorkerZone(String value)

string worker_zone = 14;

Parameter
Name	Description
`value`	`String` The workerZone to set.

Returns
Type	Description
`Environment.Builder`	This builder for chaining.

setWorkerZoneBytes(ByteString value)

public Environment.Builder setWorkerZoneBytes(ByteString value)

string worker_zone = 14;

Parameter
Name	Description
`value`	`ByteString` The bytes for workerZone to set.

Returns
Type	Description
`Environment.Builder`	This builder for chaining.