Class RuntimeEnvironment.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<RuntimeEnvironment.Builder>
com.google.dataflow.v1beta3.RuntimeEnvironment.Builder
All Implemented Interfaces:
RuntimeEnvironmentOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
RuntimeEnvironment

public static final class RuntimeEnvironment.Builder extends com.google.protobuf.GeneratedMessage.Builder<RuntimeEnvironment.Builder> implements RuntimeEnvironmentOrBuilder
 The environment values to set at runtime.
 
Protobuf type google.dataflow.v1beta3.RuntimeEnvironment
  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<RuntimeEnvironment.Builder>
    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<RuntimeEnvironment.Builder>
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<RuntimeEnvironment.Builder>
    • clear

      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<RuntimeEnvironment.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<RuntimeEnvironment.Builder>
    • getDefaultInstanceForType

      public RuntimeEnvironment getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
    • build

      public RuntimeEnvironment build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder
    • buildPartial

      public RuntimeEnvironment buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder
    • mergeFrom

      public RuntimeEnvironment.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RuntimeEnvironment.Builder>
    • mergeFrom

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<RuntimeEnvironment.Builder>
    • mergeFrom

      public RuntimeEnvironment.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RuntimeEnvironment.Builder>
      Throws:
      IOException
    • getNumWorkers

      public int getNumWorkers()
       Optional. The initial number of Google Compute Engine instances for the
       job. The default value is 11.
       
      int32 num_workers = 11;
      Specified by:
      getNumWorkers in interface RuntimeEnvironmentOrBuilder
      Returns:
      The numWorkers.
    • setNumWorkers

      public RuntimeEnvironment.Builder setNumWorkers(int value)
       Optional. The initial number of Google Compute Engine instances for the
       job. The default value is 11.
       
      int32 num_workers = 11;
      Parameters:
      value - The numWorkers to set.
      Returns:
      This builder for chaining.
    • clearNumWorkers

      public RuntimeEnvironment.Builder clearNumWorkers()
       Optional. The initial number of Google Compute Engine instances for the
       job. The default value is 11.
       
      int32 num_workers = 11;
      Returns:
      This builder for chaining.
    • getMaxWorkers

      public int getMaxWorkers()
       Optional. The maximum number of Google Compute Engine instances to be made
       available to your pipeline during execution, from 1 to 1000. The default
       value is 1.
       
      int32 max_workers = 1;
      Specified by:
      getMaxWorkers in interface RuntimeEnvironmentOrBuilder
      Returns:
      The maxWorkers.
    • setMaxWorkers

      public RuntimeEnvironment.Builder setMaxWorkers(int value)
       Optional. The maximum number of Google Compute Engine instances to be made
       available to your pipeline during execution, from 1 to 1000. The default
       value is 1.
       
      int32 max_workers = 1;
      Parameters:
      value - The maxWorkers to set.
      Returns:
      This builder for chaining.
    • clearMaxWorkers

      public RuntimeEnvironment.Builder clearMaxWorkers()
       Optional. The maximum number of Google Compute Engine instances to be made
       available to your pipeline during execution, from 1 to 1000. The default
       value is 1.
       
      int32 max_workers = 1;
      Returns:
      This builder for chaining.
    • getZone

      public String getZone()
       Optional. The Compute Engine [availability
       zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones)
       for launching worker instances to run your pipeline.
       In the future, worker_zone will take precedence.
       
      string zone = 2;
      Specified by:
      getZone in interface RuntimeEnvironmentOrBuilder
      Returns:
      The zone.
    • getZoneBytes

      public com.google.protobuf.ByteString getZoneBytes()
       Optional. The Compute Engine [availability
       zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones)
       for launching worker instances to run your pipeline.
       In the future, worker_zone will take precedence.
       
      string zone = 2;
      Specified by:
      getZoneBytes in interface RuntimeEnvironmentOrBuilder
      Returns:
      The bytes for zone.
    • setZone

      public RuntimeEnvironment.Builder setZone(String value)
       Optional. The Compute Engine [availability
       zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones)
       for launching worker instances to run your pipeline.
       In the future, worker_zone will take precedence.
       
      string zone = 2;
      Parameters:
      value - The zone to set.
      Returns:
      This builder for chaining.
    • clearZone

      public RuntimeEnvironment.Builder clearZone()
       Optional. The Compute Engine [availability
       zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones)
       for launching worker instances to run your pipeline.
       In the future, worker_zone will take precedence.
       
      string zone = 2;
      Returns:
      This builder for chaining.
    • setZoneBytes

      public RuntimeEnvironment.Builder setZoneBytes(com.google.protobuf.ByteString value)
       Optional. The Compute Engine [availability
       zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones)
       for launching worker instances to run your pipeline.
       In the future, worker_zone will take precedence.
       
      string zone = 2;
      Parameters:
      value - The bytes for zone to set.
      Returns:
      This builder for chaining.
    • getServiceAccountEmail

      public String getServiceAccountEmail()
       Optional. The email address of the service account to run the job as.
       
      string service_account_email = 3;
      Specified by:
      getServiceAccountEmail in interface RuntimeEnvironmentOrBuilder
      Returns:
      The serviceAccountEmail.
    • getServiceAccountEmailBytes

      public com.google.protobuf.ByteString getServiceAccountEmailBytes()
       Optional. The email address of the service account to run the job as.
       
      string service_account_email = 3;
      Specified by:
      getServiceAccountEmailBytes in interface RuntimeEnvironmentOrBuilder
      Returns:
      The bytes for serviceAccountEmail.
    • setServiceAccountEmail

      public RuntimeEnvironment.Builder setServiceAccountEmail(String value)
       Optional. The email address of the service account to run the job as.
       
      string service_account_email = 3;
      Parameters:
      value - The serviceAccountEmail to set.
      Returns:
      This builder for chaining.
    • clearServiceAccountEmail

      public RuntimeEnvironment.Builder clearServiceAccountEmail()
       Optional. The email address of the service account to run the job as.
       
      string service_account_email = 3;
      Returns:
      This builder for chaining.
    • setServiceAccountEmailBytes

      public RuntimeEnvironment.Builder setServiceAccountEmailBytes(com.google.protobuf.ByteString value)
       Optional. The email address of the service account to run the job as.
       
      string service_account_email = 3;
      Parameters:
      value - The bytes for serviceAccountEmail to set.
      Returns:
      This builder for chaining.
    • getTempLocation

      public String getTempLocation()
       Required. The Cloud Storage path to use for temporary files.
       Must be a valid Cloud Storage URL, beginning with `gs://`.
       
      string temp_location = 4;
      Specified by:
      getTempLocation in interface RuntimeEnvironmentOrBuilder
      Returns:
      The tempLocation.
    • getTempLocationBytes

      public com.google.protobuf.ByteString getTempLocationBytes()
       Required. The Cloud Storage path to use for temporary files.
       Must be a valid Cloud Storage URL, beginning with `gs://`.
       
      string temp_location = 4;
      Specified by:
      getTempLocationBytes in interface RuntimeEnvironmentOrBuilder
      Returns:
      The bytes for tempLocation.
    • setTempLocation

      public RuntimeEnvironment.Builder setTempLocation(String value)
       Required. The Cloud Storage path to use for temporary files.
       Must be a valid Cloud Storage URL, beginning with `gs://`.
       
      string temp_location = 4;
      Parameters:
      value - The tempLocation to set.
      Returns:
      This builder for chaining.
    • clearTempLocation

      public RuntimeEnvironment.Builder clearTempLocation()
       Required. The Cloud Storage path to use for temporary files.
       Must be a valid Cloud Storage URL, beginning with `gs://`.
       
      string temp_location = 4;
      Returns:
      This builder for chaining.
    • setTempLocationBytes

      public RuntimeEnvironment.Builder setTempLocationBytes(com.google.protobuf.ByteString value)
       Required. The Cloud Storage path to use for temporary files.
       Must be a valid Cloud Storage URL, beginning with `gs://`.
       
      string temp_location = 4;
      Parameters:
      value - The bytes for tempLocation to set.
      Returns:
      This builder for chaining.
    • getBypassTempDirValidation

      public boolean getBypassTempDirValidation()
       Optional. Whether to bypass the safety checks for the job's temporary
       directory. Use with caution.
       
      bool bypass_temp_dir_validation = 5;
      Specified by:
      getBypassTempDirValidation in interface RuntimeEnvironmentOrBuilder
      Returns:
      The bypassTempDirValidation.
    • setBypassTempDirValidation

      public RuntimeEnvironment.Builder setBypassTempDirValidation(boolean value)
       Optional. Whether to bypass the safety checks for the job's temporary
       directory. Use with caution.
       
      bool bypass_temp_dir_validation = 5;
      Parameters:
      value - The bypassTempDirValidation to set.
      Returns:
      This builder for chaining.
    • clearBypassTempDirValidation

      public RuntimeEnvironment.Builder clearBypassTempDirValidation()
       Optional. Whether to bypass the safety checks for the job's temporary
       directory. Use with caution.
       
      bool bypass_temp_dir_validation = 5;
      Returns:
      This builder for chaining.
    • getMachineType

      public String getMachineType()
       Optional. The machine type to use for the job. Defaults to the value from
       the template if not specified.
       
      string machine_type = 6;
      Specified by:
      getMachineType in interface RuntimeEnvironmentOrBuilder
      Returns:
      The machineType.
    • getMachineTypeBytes

      public com.google.protobuf.ByteString getMachineTypeBytes()
       Optional. The machine type to use for the job. Defaults to the value from
       the template if not specified.
       
      string machine_type = 6;
      Specified by:
      getMachineTypeBytes in interface RuntimeEnvironmentOrBuilder
      Returns:
      The bytes for machineType.
    • setMachineType

      public RuntimeEnvironment.Builder setMachineType(String value)
       Optional. The machine type to use for the job. Defaults to the value from
       the template if not specified.
       
      string machine_type = 6;
      Parameters:
      value - The machineType to set.
      Returns:
      This builder for chaining.
    • clearMachineType

      public RuntimeEnvironment.Builder clearMachineType()
       Optional. The machine type to use for the job. Defaults to the value from
       the template if not specified.
       
      string machine_type = 6;
      Returns:
      This builder for chaining.
    • setMachineTypeBytes

      public RuntimeEnvironment.Builder setMachineTypeBytes(com.google.protobuf.ByteString value)
       Optional. The machine type to use for the job. Defaults to the value from
       the template if not specified.
       
      string machine_type = 6;
      Parameters:
      value - The bytes for machineType to set.
      Returns:
      This builder for chaining.
    • getAdditionalExperimentsList

      public com.google.protobuf.ProtocolStringList getAdditionalExperimentsList()
       Optional. Additional experiment flags for the job, specified with the
       `--experiments` option.
       
      repeated string additional_experiments = 7;
      Specified by:
      getAdditionalExperimentsList in interface RuntimeEnvironmentOrBuilder
      Returns:
      A list containing the additionalExperiments.
    • getAdditionalExperimentsCount

      public int getAdditionalExperimentsCount()
       Optional. Additional experiment flags for the job, specified with the
       `--experiments` option.
       
      repeated string additional_experiments = 7;
      Specified by:
      getAdditionalExperimentsCount in interface RuntimeEnvironmentOrBuilder
      Returns:
      The count of additionalExperiments.
    • getAdditionalExperiments

      public String getAdditionalExperiments(int index)
       Optional. Additional experiment flags for the job, specified with the
       `--experiments` option.
       
      repeated string additional_experiments = 7;
      Specified by:
      getAdditionalExperiments in interface RuntimeEnvironmentOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The additionalExperiments at the given index.
    • getAdditionalExperimentsBytes

      public com.google.protobuf.ByteString getAdditionalExperimentsBytes(int index)
       Optional. Additional experiment flags for the job, specified with the
       `--experiments` option.
       
      repeated string additional_experiments = 7;
      Specified by:
      getAdditionalExperimentsBytes in interface RuntimeEnvironmentOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the additionalExperiments at the given index.
    • setAdditionalExperiments

      public RuntimeEnvironment.Builder setAdditionalExperiments(int index, String value)
       Optional. Additional experiment flags for the job, specified with the
       `--experiments` option.
       
      repeated string additional_experiments = 7;
      Parameters:
      index - The index to set the value at.
      value - The additionalExperiments to set.
      Returns:
      This builder for chaining.
    • addAdditionalExperiments

      public RuntimeEnvironment.Builder addAdditionalExperiments(String value)
       Optional. Additional experiment flags for the job, specified with the
       `--experiments` option.
       
      repeated string additional_experiments = 7;
      Parameters:
      value - The additionalExperiments to add.
      Returns:
      This builder for chaining.
    • addAllAdditionalExperiments

      public RuntimeEnvironment.Builder addAllAdditionalExperiments(Iterable<String> values)
       Optional. Additional experiment flags for the job, specified with the
       `--experiments` option.
       
      repeated string additional_experiments = 7;
      Parameters:
      values - The additionalExperiments to add.
      Returns:
      This builder for chaining.
    • clearAdditionalExperiments

      public RuntimeEnvironment.Builder clearAdditionalExperiments()
       Optional. Additional experiment flags for the job, specified with the
       `--experiments` option.
       
      repeated string additional_experiments = 7;
      Returns:
      This builder for chaining.
    • addAdditionalExperimentsBytes

      public RuntimeEnvironment.Builder addAdditionalExperimentsBytes(com.google.protobuf.ByteString value)
       Optional. Additional experiment flags for the job, specified with the
       `--experiments` option.
       
      repeated string additional_experiments = 7;
      Parameters:
      value - The bytes of the additionalExperiments to add.
      Returns:
      This builder for chaining.
    • getNetwork

      public String getNetwork()
       Optional. Network to which VMs will be assigned.  If empty or unspecified,
       the service will use the network "default".
       
      string network = 8;
      Specified by:
      getNetwork in interface RuntimeEnvironmentOrBuilder
      Returns:
      The network.
    • getNetworkBytes

      public com.google.protobuf.ByteString getNetworkBytes()
       Optional. Network to which VMs will be assigned.  If empty or unspecified,
       the service will use the network "default".
       
      string network = 8;
      Specified by:
      getNetworkBytes in interface RuntimeEnvironmentOrBuilder
      Returns:
      The bytes for network.
    • setNetwork

      public RuntimeEnvironment.Builder setNetwork(String value)
       Optional. Network to which VMs will be assigned.  If empty or unspecified,
       the service will use the network "default".
       
      string network = 8;
      Parameters:
      value - The network to set.
      Returns:
      This builder for chaining.
    • clearNetwork

      public RuntimeEnvironment.Builder clearNetwork()
       Optional. Network to which VMs will be assigned.  If empty or unspecified,
       the service will use the network "default".
       
      string network = 8;
      Returns:
      This builder for chaining.
    • setNetworkBytes

      public RuntimeEnvironment.Builder setNetworkBytes(com.google.protobuf.ByteString value)
       Optional. Network to which VMs will be assigned.  If empty or unspecified,
       the service will use the network "default".
       
      string network = 8;
      Parameters:
      value - The bytes for network to set.
      Returns:
      This builder for chaining.
    • getSubnetwork

      public String getSubnetwork()
       Optional. 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;
      Specified by:
      getSubnetwork in interface RuntimeEnvironmentOrBuilder
      Returns:
      The subnetwork.
    • getSubnetworkBytes

      public com.google.protobuf.ByteString getSubnetworkBytes()
       Optional. 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;
      Specified by:
      getSubnetworkBytes in interface RuntimeEnvironmentOrBuilder
      Returns:
      The bytes for subnetwork.
    • setSubnetwork

      public RuntimeEnvironment.Builder setSubnetwork(String value)
       Optional. 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;
      Parameters:
      value - The subnetwork to set.
      Returns:
      This builder for chaining.
    • clearSubnetwork

      public RuntimeEnvironment.Builder clearSubnetwork()
       Optional. 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:
      This builder for chaining.
    • setSubnetworkBytes

      public RuntimeEnvironment.Builder setSubnetworkBytes(com.google.protobuf.ByteString value)
       Optional. 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;
      Parameters:
      value - The bytes for subnetwork to set.
      Returns:
      This builder for chaining.
    • getAdditionalUserLabelsCount

      public int getAdditionalUserLabelsCount()
      Description copied from interface: RuntimeEnvironmentOrBuilder
       Optional. Additional user labels to be specified for the job.
       Keys and values should follow the restrictions specified in the [labeling
       restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions)
       page.
       An object containing a list of "key": value pairs.
       Example: { "name": "wrench", "mass": "1kg", "count": "3" }.
       
      map<string, string> additional_user_labels = 10;
      Specified by:
      getAdditionalUserLabelsCount in interface RuntimeEnvironmentOrBuilder
    • containsAdditionalUserLabels

      public boolean containsAdditionalUserLabels(String key)
       Optional. Additional user labels to be specified for the job.
       Keys and values should follow the restrictions specified in the [labeling
       restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions)
       page.
       An object containing a list of "key": value pairs.
       Example: { "name": "wrench", "mass": "1kg", "count": "3" }.
       
      map<string, string> additional_user_labels = 10;
      Specified by:
      containsAdditionalUserLabels in interface RuntimeEnvironmentOrBuilder
    • getAdditionalUserLabels

      @Deprecated public Map<String,String> getAdditionalUserLabels()
      Deprecated.
      Specified by:
      getAdditionalUserLabels in interface RuntimeEnvironmentOrBuilder
    • getAdditionalUserLabelsMap

      public Map<String,String> getAdditionalUserLabelsMap()
       Optional. Additional user labels to be specified for the job.
       Keys and values should follow the restrictions specified in the [labeling
       restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions)
       page.
       An object containing a list of "key": value pairs.
       Example: { "name": "wrench", "mass": "1kg", "count": "3" }.
       
      map<string, string> additional_user_labels = 10;
      Specified by:
      getAdditionalUserLabelsMap in interface RuntimeEnvironmentOrBuilder
    • getAdditionalUserLabelsOrDefault

      public String getAdditionalUserLabelsOrDefault(String key, String defaultValue)
       Optional. Additional user labels to be specified for the job.
       Keys and values should follow the restrictions specified in the [labeling
       restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions)
       page.
       An object containing a list of "key": value pairs.
       Example: { "name": "wrench", "mass": "1kg", "count": "3" }.
       
      map<string, string> additional_user_labels = 10;
      Specified by:
      getAdditionalUserLabelsOrDefault in interface RuntimeEnvironmentOrBuilder
    • getAdditionalUserLabelsOrThrow

      public String getAdditionalUserLabelsOrThrow(String key)
       Optional. Additional user labels to be specified for the job.
       Keys and values should follow the restrictions specified in the [labeling
       restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions)
       page.
       An object containing a list of "key": value pairs.
       Example: { "name": "wrench", "mass": "1kg", "count": "3" }.
       
      map<string, string> additional_user_labels = 10;
      Specified by:
      getAdditionalUserLabelsOrThrow in interface RuntimeEnvironmentOrBuilder
    • clearAdditionalUserLabels

      public RuntimeEnvironment.Builder clearAdditionalUserLabels()
    • removeAdditionalUserLabels

      public RuntimeEnvironment.Builder removeAdditionalUserLabels(String key)
       Optional. Additional user labels to be specified for the job.
       Keys and values should follow the restrictions specified in the [labeling
       restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions)
       page.
       An object containing a list of "key": value pairs.
       Example: { "name": "wrench", "mass": "1kg", "count": "3" }.
       
      map<string, string> additional_user_labels = 10;
    • getMutableAdditionalUserLabels

      @Deprecated public Map<String,String> getMutableAdditionalUserLabels()
      Deprecated.
      Use alternate mutation accessors instead.
    • putAdditionalUserLabels

      public RuntimeEnvironment.Builder putAdditionalUserLabels(String key, String value)
       Optional. Additional user labels to be specified for the job.
       Keys and values should follow the restrictions specified in the [labeling
       restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions)
       page.
       An object containing a list of "key": value pairs.
       Example: { "name": "wrench", "mass": "1kg", "count": "3" }.
       
      map<string, string> additional_user_labels = 10;
    • putAllAdditionalUserLabels

      public RuntimeEnvironment.Builder putAllAdditionalUserLabels(Map<String,String> values)
       Optional. Additional user labels to be specified for the job.
       Keys and values should follow the restrictions specified in the [labeling
       restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions)
       page.
       An object containing a list of "key": value pairs.
       Example: { "name": "wrench", "mass": "1kg", "count": "3" }.
       
      map<string, string> additional_user_labels = 10;
    • getKmsKeyName

      public String getKmsKeyName()
       Optional. 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;
      Specified by:
      getKmsKeyName in interface RuntimeEnvironmentOrBuilder
      Returns:
      The kmsKeyName.
    • getKmsKeyNameBytes

      public com.google.protobuf.ByteString getKmsKeyNameBytes()
       Optional. 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;
      Specified by:
      getKmsKeyNameBytes in interface RuntimeEnvironmentOrBuilder
      Returns:
      The bytes for kmsKeyName.
    • setKmsKeyName

      public RuntimeEnvironment.Builder setKmsKeyName(String value)
       Optional. 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;
      Parameters:
      value - The kmsKeyName to set.
      Returns:
      This builder for chaining.
    • clearKmsKeyName

      public RuntimeEnvironment.Builder clearKmsKeyName()
       Optional. 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:
      This builder for chaining.
    • setKmsKeyNameBytes

      public RuntimeEnvironment.Builder setKmsKeyNameBytes(com.google.protobuf.ByteString value)
       Optional. 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;
      Parameters:
      value - The bytes for kmsKeyName to set.
      Returns:
      This builder for chaining.
    • getIpConfigurationValue

      public int getIpConfigurationValue()
       Optional. Configuration for VM IPs.
       
      .google.dataflow.v1beta3.WorkerIPAddressConfiguration ip_configuration = 14;
      Specified by:
      getIpConfigurationValue in interface RuntimeEnvironmentOrBuilder
      Returns:
      The enum numeric value on the wire for ipConfiguration.
    • setIpConfigurationValue

      public RuntimeEnvironment.Builder setIpConfigurationValue(int value)
       Optional. Configuration for VM IPs.
       
      .google.dataflow.v1beta3.WorkerIPAddressConfiguration ip_configuration = 14;
      Parameters:
      value - The enum numeric value on the wire for ipConfiguration to set.
      Returns:
      This builder for chaining.
    • getIpConfiguration

      public WorkerIPAddressConfiguration getIpConfiguration()
       Optional. Configuration for VM IPs.
       
      .google.dataflow.v1beta3.WorkerIPAddressConfiguration ip_configuration = 14;
      Specified by:
      getIpConfiguration in interface RuntimeEnvironmentOrBuilder
      Returns:
      The ipConfiguration.
    • setIpConfiguration

      public RuntimeEnvironment.Builder setIpConfiguration(WorkerIPAddressConfiguration value)
       Optional. Configuration for VM IPs.
       
      .google.dataflow.v1beta3.WorkerIPAddressConfiguration ip_configuration = 14;
      Parameters:
      value - The ipConfiguration to set.
      Returns:
      This builder for chaining.
    • clearIpConfiguration

      public RuntimeEnvironment.Builder clearIpConfiguration()
       Optional. Configuration for VM IPs.
       
      .google.dataflow.v1beta3.WorkerIPAddressConfiguration ip_configuration = 14;
      Returns:
      This builder for chaining.
    • getWorkerRegion

      public String getWorkerRegion()
       Required. 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;
      Specified by:
      getWorkerRegion in interface RuntimeEnvironmentOrBuilder
      Returns:
      The workerRegion.
    • getWorkerRegionBytes

      public com.google.protobuf.ByteString getWorkerRegionBytes()
       Required. 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;
      Specified by:
      getWorkerRegionBytes in interface RuntimeEnvironmentOrBuilder
      Returns:
      The bytes for workerRegion.
    • setWorkerRegion

      public RuntimeEnvironment.Builder setWorkerRegion(String value)
       Required. 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;
      Parameters:
      value - The workerRegion to set.
      Returns:
      This builder for chaining.
    • clearWorkerRegion

      public RuntimeEnvironment.Builder clearWorkerRegion()
       Required. 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:
      This builder for chaining.
    • setWorkerRegionBytes

      public RuntimeEnvironment.Builder setWorkerRegionBytes(com.google.protobuf.ByteString value)
       Required. 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;
      Parameters:
      value - The bytes for workerRegion to set.
      Returns:
      This builder for chaining.
    • getWorkerZone

      public String getWorkerZone()
       Optional. 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;
      Specified by:
      getWorkerZone in interface RuntimeEnvironmentOrBuilder
      Returns:
      The workerZone.
    • getWorkerZoneBytes

      public com.google.protobuf.ByteString getWorkerZoneBytes()
       Optional. 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;
      Specified by:
      getWorkerZoneBytes in interface RuntimeEnvironmentOrBuilder
      Returns:
      The bytes for workerZone.
    • setWorkerZone

      public RuntimeEnvironment.Builder setWorkerZone(String value)
       Optional. 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;
      Parameters:
      value - The workerZone to set.
      Returns:
      This builder for chaining.
    • clearWorkerZone

      public RuntimeEnvironment.Builder clearWorkerZone()
       Optional. 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:
      This builder for chaining.
    • setWorkerZoneBytes

      public RuntimeEnvironment.Builder setWorkerZoneBytes(com.google.protobuf.ByteString value)
       Optional. 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;
      Parameters:
      value - The bytes for workerZone to set.
      Returns:
      This builder for chaining.
    • getEnableStreamingEngine

      public boolean getEnableStreamingEngine()
       Optional. Whether to enable Streaming Engine for the job.
       
      bool enable_streaming_engine = 17;
      Specified by:
      getEnableStreamingEngine in interface RuntimeEnvironmentOrBuilder
      Returns:
      The enableStreamingEngine.
    • setEnableStreamingEngine

      public RuntimeEnvironment.Builder setEnableStreamingEngine(boolean value)
       Optional. Whether to enable Streaming Engine for the job.
       
      bool enable_streaming_engine = 17;
      Parameters:
      value - The enableStreamingEngine to set.
      Returns:
      This builder for chaining.
    • clearEnableStreamingEngine

      public RuntimeEnvironment.Builder clearEnableStreamingEngine()
       Optional. Whether to enable Streaming Engine for the job.
       
      bool enable_streaming_engine = 17;
      Returns:
      This builder for chaining.
    • getDiskSizeGb

      public int getDiskSizeGb()
       Optional. The disk size, in gigabytes, to use on each remote Compute Engine
       worker instance.
       
      int32 disk_size_gb = 18;
      Specified by:
      getDiskSizeGb in interface RuntimeEnvironmentOrBuilder
      Returns:
      The diskSizeGb.
    • setDiskSizeGb

      public RuntimeEnvironment.Builder setDiskSizeGb(int value)
       Optional. The disk size, in gigabytes, to use on each remote Compute Engine
       worker instance.
       
      int32 disk_size_gb = 18;
      Parameters:
      value - The diskSizeGb to set.
      Returns:
      This builder for chaining.
    • clearDiskSizeGb

      public RuntimeEnvironment.Builder clearDiskSizeGb()
       Optional. The disk size, in gigabytes, to use on each remote Compute Engine
       worker instance.
       
      int32 disk_size_gb = 18;
      Returns:
      This builder for chaining.
    • hasStreamingMode

      public boolean hasStreamingMode()
       Optional. Specifies the Streaming Engine message processing guarantees.
       Reduces cost and latency but might result in duplicate messages committed
       to storage. Designed to run simple mapping streaming ETL jobs at the lowest
       cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use
       case. For more information, see
       [Set the pipeline streaming
       mode](https://cloud.google.com/dataflow/docs/guides/streaming-modes).
       
      optional .google.dataflow.v1beta3.StreamingMode streaming_mode = 19 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasStreamingMode in interface RuntimeEnvironmentOrBuilder
      Returns:
      Whether the streamingMode field is set.
    • getStreamingModeValue

      public int getStreamingModeValue()
       Optional. Specifies the Streaming Engine message processing guarantees.
       Reduces cost and latency but might result in duplicate messages committed
       to storage. Designed to run simple mapping streaming ETL jobs at the lowest
       cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use
       case. For more information, see
       [Set the pipeline streaming
       mode](https://cloud.google.com/dataflow/docs/guides/streaming-modes).
       
      optional .google.dataflow.v1beta3.StreamingMode streaming_mode = 19 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getStreamingModeValue in interface RuntimeEnvironmentOrBuilder
      Returns:
      The enum numeric value on the wire for streamingMode.
    • setStreamingModeValue

      public RuntimeEnvironment.Builder setStreamingModeValue(int value)
       Optional. Specifies the Streaming Engine message processing guarantees.
       Reduces cost and latency but might result in duplicate messages committed
       to storage. Designed to run simple mapping streaming ETL jobs at the lowest
       cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use
       case. For more information, see
       [Set the pipeline streaming
       mode](https://cloud.google.com/dataflow/docs/guides/streaming-modes).
       
      optional .google.dataflow.v1beta3.StreamingMode streaming_mode = 19 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The enum numeric value on the wire for streamingMode to set.
      Returns:
      This builder for chaining.
    • getStreamingMode

      public StreamingMode getStreamingMode()
       Optional. Specifies the Streaming Engine message processing guarantees.
       Reduces cost and latency but might result in duplicate messages committed
       to storage. Designed to run simple mapping streaming ETL jobs at the lowest
       cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use
       case. For more information, see
       [Set the pipeline streaming
       mode](https://cloud.google.com/dataflow/docs/guides/streaming-modes).
       
      optional .google.dataflow.v1beta3.StreamingMode streaming_mode = 19 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getStreamingMode in interface RuntimeEnvironmentOrBuilder
      Returns:
      The streamingMode.
    • setStreamingMode

      public RuntimeEnvironment.Builder setStreamingMode(StreamingMode value)
       Optional. Specifies the Streaming Engine message processing guarantees.
       Reduces cost and latency but might result in duplicate messages committed
       to storage. Designed to run simple mapping streaming ETL jobs at the lowest
       cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use
       case. For more information, see
       [Set the pipeline streaming
       mode](https://cloud.google.com/dataflow/docs/guides/streaming-modes).
       
      optional .google.dataflow.v1beta3.StreamingMode streaming_mode = 19 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The streamingMode to set.
      Returns:
      This builder for chaining.
    • clearStreamingMode

      public RuntimeEnvironment.Builder clearStreamingMode()
       Optional. Specifies the Streaming Engine message processing guarantees.
       Reduces cost and latency but might result in duplicate messages committed
       to storage. Designed to run simple mapping streaming ETL jobs at the lowest
       cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use
       case. For more information, see
       [Set the pipeline streaming
       mode](https://cloud.google.com/dataflow/docs/guides/streaming-modes).
       
      optional .google.dataflow.v1beta3.StreamingMode streaming_mode = 19 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.
    • getAdditionalPipelineOptionsList

      public com.google.protobuf.ProtocolStringList getAdditionalPipelineOptionsList()
       Optional. Additional pipeline option flags for the job.
       
      repeated string additional_pipeline_options = 20 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAdditionalPipelineOptionsList in interface RuntimeEnvironmentOrBuilder
      Returns:
      A list containing the additionalPipelineOptions.
    • getAdditionalPipelineOptionsCount

      public int getAdditionalPipelineOptionsCount()
       Optional. Additional pipeline option flags for the job.
       
      repeated string additional_pipeline_options = 20 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAdditionalPipelineOptionsCount in interface RuntimeEnvironmentOrBuilder
      Returns:
      The count of additionalPipelineOptions.
    • getAdditionalPipelineOptions

      public String getAdditionalPipelineOptions(int index)
       Optional. Additional pipeline option flags for the job.
       
      repeated string additional_pipeline_options = 20 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAdditionalPipelineOptions in interface RuntimeEnvironmentOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The additionalPipelineOptions at the given index.
    • getAdditionalPipelineOptionsBytes

      public com.google.protobuf.ByteString getAdditionalPipelineOptionsBytes(int index)
       Optional. Additional pipeline option flags for the job.
       
      repeated string additional_pipeline_options = 20 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAdditionalPipelineOptionsBytes in interface RuntimeEnvironmentOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the additionalPipelineOptions at the given index.
    • setAdditionalPipelineOptions

      public RuntimeEnvironment.Builder setAdditionalPipelineOptions(int index, String value)
       Optional. Additional pipeline option flags for the job.
       
      repeated string additional_pipeline_options = 20 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index to set the value at.
      value - The additionalPipelineOptions to set.
      Returns:
      This builder for chaining.
    • addAdditionalPipelineOptions

      public RuntimeEnvironment.Builder addAdditionalPipelineOptions(String value)
       Optional. Additional pipeline option flags for the job.
       
      repeated string additional_pipeline_options = 20 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The additionalPipelineOptions to add.
      Returns:
      This builder for chaining.
    • addAllAdditionalPipelineOptions

      public RuntimeEnvironment.Builder addAllAdditionalPipelineOptions(Iterable<String> values)
       Optional. Additional pipeline option flags for the job.
       
      repeated string additional_pipeline_options = 20 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      values - The additionalPipelineOptions to add.
      Returns:
      This builder for chaining.
    • clearAdditionalPipelineOptions

      public RuntimeEnvironment.Builder clearAdditionalPipelineOptions()
       Optional. Additional pipeline option flags for the job.
       
      repeated string additional_pipeline_options = 20 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.
    • addAdditionalPipelineOptionsBytes

      public RuntimeEnvironment.Builder addAdditionalPipelineOptionsBytes(com.google.protobuf.ByteString value)
       Optional. Additional pipeline option flags for the job.
       
      repeated string additional_pipeline_options = 20 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes of the additionalPipelineOptions to add.
      Returns:
      This builder for chaining.