Class UpdateEnvironmentRequest.Builder (1.41.0)

public static final class UpdateEnvironmentRequest.Builder extends GeneratedMessageV3.Builder<UpdateEnvironmentRequest.Builder> implements UpdateEnvironmentRequestOrBuilder

Update an environment.

Protobuf type google.cloud.orchestration.airflow.service.v1.UpdateEnvironmentRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UpdateEnvironmentRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
UpdateEnvironmentRequest.Builder
Overrides

build()

public UpdateEnvironmentRequest build()
Returns
TypeDescription
UpdateEnvironmentRequest

buildPartial()

public UpdateEnvironmentRequest buildPartial()
Returns
TypeDescription
UpdateEnvironmentRequest

clear()

public UpdateEnvironmentRequest.Builder clear()
Returns
TypeDescription
UpdateEnvironmentRequest.Builder
Overrides

clearEnvironment()

public UpdateEnvironmentRequest.Builder clearEnvironment()

A patch environment. Fields specified by the updateMask will be copied from the patch environment into the environment under update.

.google.cloud.orchestration.airflow.service.v1.Environment environment = 1;

Returns
TypeDescription
UpdateEnvironmentRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public UpdateEnvironmentRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
UpdateEnvironmentRequest.Builder
Overrides

clearName()

public UpdateEnvironmentRequest.Builder clearName()

The relative resource name of the environment to update, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

string name = 2;

Returns
TypeDescription
UpdateEnvironmentRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public UpdateEnvironmentRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
UpdateEnvironmentRequest.Builder
Overrides

clearUpdateMask()

public UpdateEnvironmentRequest.Builder clearUpdateMask()

Required. A comma-separated list of paths, relative to Environment, of fields to update. For example, to set the version of scikit-learn to install in the environment to 0.19.0 and to remove an existing installation of numpy, the updateMask parameter would include the following two paths values: "config.softwareConfig.pypiPackages.scikit-learn" and "config.softwareConfig.pypiPackages.numpy". The included patch environment would specify the scikit-learn version as follows:

 {
   "config":{
     "softwareConfig":{
       "pypiPackages":{
         "scikit-learn":"==0.19.0"
       }
     }
   }
 }

Note that in the above example, any existing PyPI packages other than scikit-learn and numpy will be unaffected.

Only one update type may be included in a single request's updateMask. For example, one cannot update both the PyPI packages and labels in the same request. However, it is possible to update multiple members of a map field simultaneously in the same request. For example, to set the labels "label1" and "label2" while clearing "label3" (assuming it already exists), one can provide the paths "labels.label1", "labels.label2", and "labels.label3" and populate the patch environment as follows:

 {
   "labels":{
     "label1":"new-label1-value"
     "label2":"new-label2-value"
   }
 }

Note that in the above example, any existing labels that are not included in the updateMask will be unaffected.

It is also possible to replace an entire map field by providing the map field's path in the updateMask. The new value of the field will be that which is provided in the patch environment. For example, to delete all pre-existing user-specified PyPI packages and install botocore at version 1.7.14, the updateMask would contain the path "config.softwareConfig.pypiPackages", and the patch environment would be the following:

 {
   "config":{
     "softwareConfig":{
       "pypiPackages":{
         "botocore":"==1.7.14"
       }
     }
   }
 }

Note: Only the following fields can be updated:

  • config.softwareConfig.pypiPackages
    • Replace all custom custom PyPI packages. If a replacement package map is not included in environment, all custom PyPI packages are cleared. It is an error to provide both this mask and a mask specifying an individual package.
  • config.softwareConfig.pypiPackages.packagename
    • Update the custom PyPI package packagename, preserving other packages. To delete the package, include it in updateMask, and omit the mapping for it in environment.config.softwareConfig.pypiPackages. It is an error to provide both a mask of this form and the config.softwareConfig.pypiPackages mask.
  • labels
    • Replace all environment labels. If a replacement labels map is not included in environment, all labels are cleared. It is an error to provide both this mask and a mask specifying one or more individual labels.
  • labels.labelName
    • Set the label named labelName, while preserving other labels. To delete the label, include it in updateMask and omit its mapping in environment.labels. It is an error to provide both a mask of this form and the labels mask.
  • config.nodeCount
    • Horizontally scale the number of nodes in the environment. An integer greater than or equal to 3 must be provided in the config.nodeCount field. Supported for Cloud Composer environments in versions composer-1..-airflow-..*.
  • config.webServerNetworkAccessControl
    • Replace the environment's current WebServerNetworkAccessControl.
  • config.softwareConfig.airflowConfigOverrides
    • Replace all Apache Airflow config overrides. If a replacement config overrides map is not included in environment, all config overrides are cleared. It is an error to provide both this mask and a mask specifying one or more individual config overrides.
  • config.softwareConfig.airflowConfigOverrides.section-name
    • Override the Apache Airflow config property name in the section named section, preserving other properties. To delete the property override, include it in updateMask and omit its mapping in environment.config.softwareConfig.airflowConfigOverrides. It is an error to provide both a mask of this form and the config.softwareConfig.airflowConfigOverrides mask.
  • config.softwareConfig.envVariables
    • Replace all environment variables. If a replacement environment variable map is not included in environment, all custom environment variables are cleared.
  • config.softwareConfig.schedulerCount
    • Horizontally scale the number of schedulers in Airflow. A positive integer not greater than the number of nodes must be provided in the config.softwareConfig.schedulerCount field. Supported for Cloud Composer environments in versions composer-1..-airflow-2...
  • config.databaseConfig.machineType
    • Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. Supported for Cloud Composer environments in versions composer-1..-airflow-..*.
  • config.webServerConfig.machineType
    • Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. Supported for Cloud Composer environments in versions composer-1..-airflow-..*.

.google.protobuf.FieldMask update_mask = 3;

Returns
TypeDescription
UpdateEnvironmentRequest.Builder

clone()

public UpdateEnvironmentRequest.Builder clone()
Returns
TypeDescription
UpdateEnvironmentRequest.Builder
Overrides

getDefaultInstanceForType()

public UpdateEnvironmentRequest getDefaultInstanceForType()
Returns
TypeDescription
UpdateEnvironmentRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEnvironment()

public Environment getEnvironment()

A patch environment. Fields specified by the updateMask will be copied from the patch environment into the environment under update.

.google.cloud.orchestration.airflow.service.v1.Environment environment = 1;

Returns
TypeDescription
Environment

The environment.

getEnvironmentBuilder()

public Environment.Builder getEnvironmentBuilder()

A patch environment. Fields specified by the updateMask will be copied from the patch environment into the environment under update.

.google.cloud.orchestration.airflow.service.v1.Environment environment = 1;

Returns
TypeDescription
Environment.Builder

getEnvironmentOrBuilder()

public EnvironmentOrBuilder getEnvironmentOrBuilder()

A patch environment. Fields specified by the updateMask will be copied from the patch environment into the environment under update.

.google.cloud.orchestration.airflow.service.v1.Environment environment = 1;

Returns
TypeDescription
EnvironmentOrBuilder

getName()

public String getName()

The relative resource name of the environment to update, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

string name = 2;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The relative resource name of the environment to update, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

string name = 2;

Returns
TypeDescription
ByteString

The bytes for name.

getUpdateMask()

public FieldMask getUpdateMask()

Required. A comma-separated list of paths, relative to Environment, of fields to update. For example, to set the version of scikit-learn to install in the environment to 0.19.0 and to remove an existing installation of numpy, the updateMask parameter would include the following two paths values: "config.softwareConfig.pypiPackages.scikit-learn" and "config.softwareConfig.pypiPackages.numpy". The included patch environment would specify the scikit-learn version as follows:

 {
   "config":{
     "softwareConfig":{
       "pypiPackages":{
         "scikit-learn":"==0.19.0"
       }
     }
   }
 }

Note that in the above example, any existing PyPI packages other than scikit-learn and numpy will be unaffected.

Only one update type may be included in a single request's updateMask. For example, one cannot update both the PyPI packages and labels in the same request. However, it is possible to update multiple members of a map field simultaneously in the same request. For example, to set the labels "label1" and "label2" while clearing "label3" (assuming it already exists), one can provide the paths "labels.label1", "labels.label2", and "labels.label3" and populate the patch environment as follows:

 {
   "labels":{
     "label1":"new-label1-value"
     "label2":"new-label2-value"
   }
 }

Note that in the above example, any existing labels that are not included in the updateMask will be unaffected.

It is also possible to replace an entire map field by providing the map field's path in the updateMask. The new value of the field will be that which is provided in the patch environment. For example, to delete all pre-existing user-specified PyPI packages and install botocore at version 1.7.14, the updateMask would contain the path "config.softwareConfig.pypiPackages", and the patch environment would be the following:

 {
   "config":{
     "softwareConfig":{
       "pypiPackages":{
         "botocore":"==1.7.14"
       }
     }
   }
 }

Note: Only the following fields can be updated:

  • config.softwareConfig.pypiPackages
    • Replace all custom custom PyPI packages. If a replacement package map is not included in environment, all custom PyPI packages are cleared. It is an error to provide both this mask and a mask specifying an individual package.
  • config.softwareConfig.pypiPackages.packagename
    • Update the custom PyPI package packagename, preserving other packages. To delete the package, include it in updateMask, and omit the mapping for it in environment.config.softwareConfig.pypiPackages. It is an error to provide both a mask of this form and the config.softwareConfig.pypiPackages mask.
  • labels
    • Replace all environment labels. If a replacement labels map is not included in environment, all labels are cleared. It is an error to provide both this mask and a mask specifying one or more individual labels.
  • labels.labelName
    • Set the label named labelName, while preserving other labels. To delete the label, include it in updateMask and omit its mapping in environment.labels. It is an error to provide both a mask of this form and the labels mask.
  • config.nodeCount
    • Horizontally scale the number of nodes in the environment. An integer greater than or equal to 3 must be provided in the config.nodeCount field. Supported for Cloud Composer environments in versions composer-1..-airflow-..*.
  • config.webServerNetworkAccessControl
    • Replace the environment's current WebServerNetworkAccessControl.
  • config.softwareConfig.airflowConfigOverrides
    • Replace all Apache Airflow config overrides. If a replacement config overrides map is not included in environment, all config overrides are cleared. It is an error to provide both this mask and a mask specifying one or more individual config overrides.
  • config.softwareConfig.airflowConfigOverrides.section-name
    • Override the Apache Airflow config property name in the section named section, preserving other properties. To delete the property override, include it in updateMask and omit its mapping in environment.config.softwareConfig.airflowConfigOverrides. It is an error to provide both a mask of this form and the config.softwareConfig.airflowConfigOverrides mask.
  • config.softwareConfig.envVariables
    • Replace all environment variables. If a replacement environment variable map is not included in environment, all custom environment variables are cleared.
  • config.softwareConfig.schedulerCount
    • Horizontally scale the number of schedulers in Airflow. A positive integer not greater than the number of nodes must be provided in the config.softwareConfig.schedulerCount field. Supported for Cloud Composer environments in versions composer-1..-airflow-2...
  • config.databaseConfig.machineType
    • Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. Supported for Cloud Composer environments in versions composer-1..-airflow-..*.
  • config.webServerConfig.machineType
    • Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. Supported for Cloud Composer environments in versions composer-1..-airflow-..*.

.google.protobuf.FieldMask update_mask = 3;

Returns
TypeDescription
FieldMask

The updateMask.

getUpdateMaskBuilder()

public FieldMask.Builder getUpdateMaskBuilder()

Required. A comma-separated list of paths, relative to Environment, of fields to update. For example, to set the version of scikit-learn to install in the environment to 0.19.0 and to remove an existing installation of numpy, the updateMask parameter would include the following two paths values: "config.softwareConfig.pypiPackages.scikit-learn" and "config.softwareConfig.pypiPackages.numpy". The included patch environment would specify the scikit-learn version as follows:

 {
   "config":{
     "softwareConfig":{
       "pypiPackages":{
         "scikit-learn":"==0.19.0"
       }
     }
   }
 }

Note that in the above example, any existing PyPI packages other than scikit-learn and numpy will be unaffected.

Only one update type may be included in a single request's updateMask. For example, one cannot update both the PyPI packages and labels in the same request. However, it is possible to update multiple members of a map field simultaneously in the same request. For example, to set the labels "label1" and "label2" while clearing "label3" (assuming it already exists), one can provide the paths "labels.label1", "labels.label2", and "labels.label3" and populate the patch environment as follows:

 {
   "labels":{
     "label1":"new-label1-value"
     "label2":"new-label2-value"
   }
 }

Note that in the above example, any existing labels that are not included in the updateMask will be unaffected.

It is also possible to replace an entire map field by providing the map field's path in the updateMask. The new value of the field will be that which is provided in the patch environment. For example, to delete all pre-existing user-specified PyPI packages and install botocore at version 1.7.14, the updateMask would contain the path "config.softwareConfig.pypiPackages", and the patch environment would be the following:

 {
   "config":{
     "softwareConfig":{
       "pypiPackages":{
         "botocore":"==1.7.14"
       }
     }
   }
 }

Note: Only the following fields can be updated:

  • config.softwareConfig.pypiPackages
    • Replace all custom custom PyPI packages. If a replacement package map is not included in environment, all custom PyPI packages are cleared. It is an error to provide both this mask and a mask specifying an individual package.
  • config.softwareConfig.pypiPackages.packagename
    • Update the custom PyPI package packagename, preserving other packages. To delete the package, include it in updateMask, and omit the mapping for it in environment.config.softwareConfig.pypiPackages. It is an error to provide both a mask of this form and the config.softwareConfig.pypiPackages mask.
  • labels
    • Replace all environment labels. If a replacement labels map is not included in environment, all labels are cleared. It is an error to provide both this mask and a mask specifying one or more individual labels.
  • labels.labelName
    • Set the label named labelName, while preserving other labels. To delete the label, include it in updateMask and omit its mapping in environment.labels. It is an error to provide both a mask of this form and the labels mask.
  • config.nodeCount
    • Horizontally scale the number of nodes in the environment. An integer greater than or equal to 3 must be provided in the config.nodeCount field. Supported for Cloud Composer environments in versions composer-1..-airflow-..*.
  • config.webServerNetworkAccessControl
    • Replace the environment's current WebServerNetworkAccessControl.
  • config.softwareConfig.airflowConfigOverrides
    • Replace all Apache Airflow config overrides. If a replacement config overrides map is not included in environment, all config overrides are cleared. It is an error to provide both this mask and a mask specifying one or more individual config overrides.
  • config.softwareConfig.airflowConfigOverrides.section-name
    • Override the Apache Airflow config property name in the section named section, preserving other properties. To delete the property override, include it in updateMask and omit its mapping in environment.config.softwareConfig.airflowConfigOverrides. It is an error to provide both a mask of this form and the config.softwareConfig.airflowConfigOverrides mask.
  • config.softwareConfig.envVariables
    • Replace all environment variables. If a replacement environment variable map is not included in environment, all custom environment variables are cleared.
  • config.softwareConfig.schedulerCount
    • Horizontally scale the number of schedulers in Airflow. A positive integer not greater than the number of nodes must be provided in the config.softwareConfig.schedulerCount field. Supported for Cloud Composer environments in versions composer-1..-airflow-2...
  • config.databaseConfig.machineType
    • Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. Supported for Cloud Composer environments in versions composer-1..-airflow-..*.
  • config.webServerConfig.machineType
    • Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. Supported for Cloud Composer environments in versions composer-1..-airflow-..*.

.google.protobuf.FieldMask update_mask = 3;

Returns
TypeDescription
Builder

getUpdateMaskOrBuilder()

public FieldMaskOrBuilder getUpdateMaskOrBuilder()

Required. A comma-separated list of paths, relative to Environment, of fields to update. For example, to set the version of scikit-learn to install in the environment to 0.19.0 and to remove an existing installation of numpy, the updateMask parameter would include the following two paths values: "config.softwareConfig.pypiPackages.scikit-learn" and "config.softwareConfig.pypiPackages.numpy". The included patch environment would specify the scikit-learn version as follows:

 {
   "config":{
     "softwareConfig":{
       "pypiPackages":{
         "scikit-learn":"==0.19.0"
       }
     }
   }
 }

Note that in the above example, any existing PyPI packages other than scikit-learn and numpy will be unaffected.

Only one update type may be included in a single request's updateMask. For example, one cannot update both the PyPI packages and labels in the same request. However, it is possible to update multiple members of a map field simultaneously in the same request. For example, to set the labels "label1" and "label2" while clearing "label3" (assuming it already exists), one can provide the paths "labels.label1", "labels.label2", and "labels.label3" and populate the patch environment as follows:

 {
   "labels":{
     "label1":"new-label1-value"
     "label2":"new-label2-value"
   }
 }

Note that in the above example, any existing labels that are not included in the updateMask will be unaffected.

It is also possible to replace an entire map field by providing the map field's path in the updateMask. The new value of the field will be that which is provided in the patch environment. For example, to delete all pre-existing user-specified PyPI packages and install botocore at version 1.7.14, the updateMask would contain the path "config.softwareConfig.pypiPackages", and the patch environment would be the following:

 {
   "config":{
     "softwareConfig":{
       "pypiPackages":{
         "botocore":"==1.7.14"
       }
     }
   }
 }

Note: Only the following fields can be updated:

  • config.softwareConfig.pypiPackages
    • Replace all custom custom PyPI packages. If a replacement package map is not included in environment, all custom PyPI packages are cleared. It is an error to provide both this mask and a mask specifying an individual package.
  • config.softwareConfig.pypiPackages.packagename
    • Update the custom PyPI package packagename, preserving other packages. To delete the package, include it in updateMask, and omit the mapping for it in environment.config.softwareConfig.pypiPackages. It is an error to provide both a mask of this form and the config.softwareConfig.pypiPackages mask.
  • labels
    • Replace all environment labels. If a replacement labels map is not included in environment, all labels are cleared. It is an error to provide both this mask and a mask specifying one or more individual labels.
  • labels.labelName
    • Set the label named labelName, while preserving other labels. To delete the label, include it in updateMask and omit its mapping in environment.labels. It is an error to provide both a mask of this form and the labels mask.
  • config.nodeCount
    • Horizontally scale the number of nodes in the environment. An integer greater than or equal to 3 must be provided in the config.nodeCount field. Supported for Cloud Composer environments in versions composer-1..-airflow-..*.
  • config.webServerNetworkAccessControl
    • Replace the environment's current WebServerNetworkAccessControl.
  • config.softwareConfig.airflowConfigOverrides
    • Replace all Apache Airflow config overrides. If a replacement config overrides map is not included in environment, all config overrides are cleared. It is an error to provide both this mask and a mask specifying one or more individual config overrides.
  • config.softwareConfig.airflowConfigOverrides.section-name
    • Override the Apache Airflow config property name in the section named section, preserving other properties. To delete the property override, include it in updateMask and omit its mapping in environment.config.softwareConfig.airflowConfigOverrides. It is an error to provide both a mask of this form and the config.softwareConfig.airflowConfigOverrides mask.
  • config.softwareConfig.envVariables
    • Replace all environment variables. If a replacement environment variable map is not included in environment, all custom environment variables are cleared.
  • config.softwareConfig.schedulerCount
    • Horizontally scale the number of schedulers in Airflow. A positive integer not greater than the number of nodes must be provided in the config.softwareConfig.schedulerCount field. Supported for Cloud Composer environments in versions composer-1..-airflow-2...
  • config.databaseConfig.machineType
    • Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. Supported for Cloud Composer environments in versions composer-1..-airflow-..*.
  • config.webServerConfig.machineType
    • Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. Supported for Cloud Composer environments in versions composer-1..-airflow-..*.

.google.protobuf.FieldMask update_mask = 3;

Returns
TypeDescription
FieldMaskOrBuilder

hasEnvironment()

public boolean hasEnvironment()

A patch environment. Fields specified by the updateMask will be copied from the patch environment into the environment under update.

.google.cloud.orchestration.airflow.service.v1.Environment environment = 1;

Returns
TypeDescription
boolean

Whether the environment field is set.

hasUpdateMask()

public boolean hasUpdateMask()

Required. A comma-separated list of paths, relative to Environment, of fields to update. For example, to set the version of scikit-learn to install in the environment to 0.19.0 and to remove an existing installation of numpy, the updateMask parameter would include the following two paths values: "config.softwareConfig.pypiPackages.scikit-learn" and "config.softwareConfig.pypiPackages.numpy". The included patch environment would specify the scikit-learn version as follows:

 {
   "config":{
     "softwareConfig":{
       "pypiPackages":{
         "scikit-learn":"==0.19.0"
       }
     }
   }
 }

Note that in the above example, any existing PyPI packages other than scikit-learn and numpy will be unaffected.

Only one update type may be included in a single request's updateMask. For example, one cannot update both the PyPI packages and labels in the same request. However, it is possible to update multiple members of a map field simultaneously in the same request. For example, to set the labels "label1" and "label2" while clearing "label3" (assuming it already exists), one can provide the paths "labels.label1", "labels.label2", and "labels.label3" and populate the patch environment as follows:

 {
   "labels":{
     "label1":"new-label1-value"
     "label2":"new-label2-value"
   }
 }

Note that in the above example, any existing labels that are not included in the updateMask will be unaffected.

It is also possible to replace an entire map field by providing the map field's path in the updateMask. The new value of the field will be that which is provided in the patch environment. For example, to delete all pre-existing user-specified PyPI packages and install botocore at version 1.7.14, the updateMask would contain the path "config.softwareConfig.pypiPackages", and the patch environment would be the following:

 {
   "config":{
     "softwareConfig":{
       "pypiPackages":{
         "botocore":"==1.7.14"
       }
     }
   }
 }

Note: Only the following fields can be updated:

  • config.softwareConfig.pypiPackages
    • Replace all custom custom PyPI packages. If a replacement package map is not included in environment, all custom PyPI packages are cleared. It is an error to provide both this mask and a mask specifying an individual package.
  • config.softwareConfig.pypiPackages.packagename
    • Update the custom PyPI package packagename, preserving other packages. To delete the package, include it in updateMask, and omit the mapping for it in environment.config.softwareConfig.pypiPackages. It is an error to provide both a mask of this form and the config.softwareConfig.pypiPackages mask.
  • labels
    • Replace all environment labels. If a replacement labels map is not included in environment, all labels are cleared. It is an error to provide both this mask and a mask specifying one or more individual labels.
  • labels.labelName
    • Set the label named labelName, while preserving other labels. To delete the label, include it in updateMask and omit its mapping in environment.labels. It is an error to provide both a mask of this form and the labels mask.
  • config.nodeCount
    • Horizontally scale the number of nodes in the environment. An integer greater than or equal to 3 must be provided in the config.nodeCount field. Supported for Cloud Composer environments in versions composer-1..-airflow-..*.
  • config.webServerNetworkAccessControl
    • Replace the environment's current WebServerNetworkAccessControl.
  • config.softwareConfig.airflowConfigOverrides
    • Replace all Apache Airflow config overrides. If a replacement config overrides map is not included in environment, all config overrides are cleared. It is an error to provide both this mask and a mask specifying one or more individual config overrides.
  • config.softwareConfig.airflowConfigOverrides.section-name
    • Override the Apache Airflow config property name in the section named section, preserving other properties. To delete the property override, include it in updateMask and omit its mapping in environment.config.softwareConfig.airflowConfigOverrides. It is an error to provide both a mask of this form and the config.softwareConfig.airflowConfigOverrides mask.
  • config.softwareConfig.envVariables
    • Replace all environment variables. If a replacement environment variable map is not included in environment, all custom environment variables are cleared.
  • config.softwareConfig.schedulerCount
    • Horizontally scale the number of schedulers in Airflow. A positive integer not greater than the number of nodes must be provided in the config.softwareConfig.schedulerCount field. Supported for Cloud Composer environments in versions composer-1..-airflow-2...
  • config.databaseConfig.machineType
    • Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. Supported for Cloud Composer environments in versions composer-1..-airflow-..*.
  • config.webServerConfig.machineType
    • Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. Supported for Cloud Composer environments in versions composer-1..-airflow-..*.

.google.protobuf.FieldMask update_mask = 3;

Returns
TypeDescription
boolean

Whether the updateMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeEnvironment(Environment value)

public UpdateEnvironmentRequest.Builder mergeEnvironment(Environment value)

A patch environment. Fields specified by the updateMask will be copied from the patch environment into the environment under update.

.google.cloud.orchestration.airflow.service.v1.Environment environment = 1;

Parameter
NameDescription
valueEnvironment
Returns
TypeDescription
UpdateEnvironmentRequest.Builder

mergeFrom(UpdateEnvironmentRequest other)

public UpdateEnvironmentRequest.Builder mergeFrom(UpdateEnvironmentRequest other)
Parameter
NameDescription
otherUpdateEnvironmentRequest
Returns
TypeDescription
UpdateEnvironmentRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UpdateEnvironmentRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateEnvironmentRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public UpdateEnvironmentRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
UpdateEnvironmentRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UpdateEnvironmentRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
UpdateEnvironmentRequest.Builder
Overrides

mergeUpdateMask(FieldMask value)

public UpdateEnvironmentRequest.Builder mergeUpdateMask(FieldMask value)

Required. A comma-separated list of paths, relative to Environment, of fields to update. For example, to set the version of scikit-learn to install in the environment to 0.19.0 and to remove an existing installation of numpy, the updateMask parameter would include the following two paths values: "config.softwareConfig.pypiPackages.scikit-learn" and "config.softwareConfig.pypiPackages.numpy". The included patch environment would specify the scikit-learn version as follows:

 {
   "config":{
     "softwareConfig":{
       "pypiPackages":{
         "scikit-learn":"==0.19.0"
       }
     }
   }
 }

Note that in the above example, any existing PyPI packages other than scikit-learn and numpy will be unaffected.

Only one update type may be included in a single request's updateMask. For example, one cannot update both the PyPI packages and labels in the same request. However, it is possible to update multiple members of a map field simultaneously in the same request. For example, to set the labels "label1" and "label2" while clearing "label3" (assuming it already exists), one can provide the paths "labels.label1", "labels.label2", and "labels.label3" and populate the patch environment as follows:

 {
   "labels":{
     "label1":"new-label1-value"
     "label2":"new-label2-value"
   }
 }

Note that in the above example, any existing labels that are not included in the updateMask will be unaffected.

It is also possible to replace an entire map field by providing the map field's path in the updateMask. The new value of the field will be that which is provided in the patch environment. For example, to delete all pre-existing user-specified PyPI packages and install botocore at version 1.7.14, the updateMask would contain the path "config.softwareConfig.pypiPackages", and the patch environment would be the following:

 {
   "config":{
     "softwareConfig":{
       "pypiPackages":{
         "botocore":"==1.7.14"
       }
     }
   }
 }

Note: Only the following fields can be updated:

  • config.softwareConfig.pypiPackages
    • Replace all custom custom PyPI packages. If a replacement package map is not included in environment, all custom PyPI packages are cleared. It is an error to provide both this mask and a mask specifying an individual package.
  • config.softwareConfig.pypiPackages.packagename
    • Update the custom PyPI package packagename, preserving other packages. To delete the package, include it in updateMask, and omit the mapping for it in environment.config.softwareConfig.pypiPackages. It is an error to provide both a mask of this form and the config.softwareConfig.pypiPackages mask.
  • labels
    • Replace all environment labels. If a replacement labels map is not included in environment, all labels are cleared. It is an error to provide both this mask and a mask specifying one or more individual labels.
  • labels.labelName
    • Set the label named labelName, while preserving other labels. To delete the label, include it in updateMask and omit its mapping in environment.labels. It is an error to provide both a mask of this form and the labels mask.
  • config.nodeCount
    • Horizontally scale the number of nodes in the environment. An integer greater than or equal to 3 must be provided in the config.nodeCount field. Supported for Cloud Composer environments in versions composer-1..-airflow-..*.
  • config.webServerNetworkAccessControl
    • Replace the environment's current WebServerNetworkAccessControl.
  • config.softwareConfig.airflowConfigOverrides
    • Replace all Apache Airflow config overrides. If a replacement config overrides map is not included in environment, all config overrides are cleared. It is an error to provide both this mask and a mask specifying one or more individual config overrides.
  • config.softwareConfig.airflowConfigOverrides.section-name
    • Override the Apache Airflow config property name in the section named section, preserving other properties. To delete the property override, include it in updateMask and omit its mapping in environment.config.softwareConfig.airflowConfigOverrides. It is an error to provide both a mask of this form and the config.softwareConfig.airflowConfigOverrides mask.
  • config.softwareConfig.envVariables
    • Replace all environment variables. If a replacement environment variable map is not included in environment, all custom environment variables are cleared.
  • config.softwareConfig.schedulerCount
    • Horizontally scale the number of schedulers in Airflow. A positive integer not greater than the number of nodes must be provided in the config.softwareConfig.schedulerCount field. Supported for Cloud Composer environments in versions composer-1..-airflow-2...
  • config.databaseConfig.machineType
    • Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. Supported for Cloud Composer environments in versions composer-1..-airflow-..*.
  • config.webServerConfig.machineType
    • Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. Supported for Cloud Composer environments in versions composer-1..-airflow-..*.

.google.protobuf.FieldMask update_mask = 3;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
UpdateEnvironmentRequest.Builder

setEnvironment(Environment value)

public UpdateEnvironmentRequest.Builder setEnvironment(Environment value)

A patch environment. Fields specified by the updateMask will be copied from the patch environment into the environment under update.

.google.cloud.orchestration.airflow.service.v1.Environment environment = 1;

Parameter
NameDescription
valueEnvironment
Returns
TypeDescription
UpdateEnvironmentRequest.Builder

setEnvironment(Environment.Builder builderForValue)

public UpdateEnvironmentRequest.Builder setEnvironment(Environment.Builder builderForValue)

A patch environment. Fields specified by the updateMask will be copied from the patch environment into the environment under update.

.google.cloud.orchestration.airflow.service.v1.Environment environment = 1;

Parameter
NameDescription
builderForValueEnvironment.Builder
Returns
TypeDescription
UpdateEnvironmentRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public UpdateEnvironmentRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
UpdateEnvironmentRequest.Builder
Overrides

setName(String value)

public UpdateEnvironmentRequest.Builder setName(String value)

The relative resource name of the environment to update, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

string name = 2;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
UpdateEnvironmentRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public UpdateEnvironmentRequest.Builder setNameBytes(ByteString value)

The relative resource name of the environment to update, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

string name = 2;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
UpdateEnvironmentRequest.Builder

This builder for chaining.

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

public UpdateEnvironmentRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
UpdateEnvironmentRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final UpdateEnvironmentRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
UpdateEnvironmentRequest.Builder
Overrides

setUpdateMask(FieldMask value)

public UpdateEnvironmentRequest.Builder setUpdateMask(FieldMask value)

Required. A comma-separated list of paths, relative to Environment, of fields to update. For example, to set the version of scikit-learn to install in the environment to 0.19.0 and to remove an existing installation of numpy, the updateMask parameter would include the following two paths values: "config.softwareConfig.pypiPackages.scikit-learn" and "config.softwareConfig.pypiPackages.numpy". The included patch environment would specify the scikit-learn version as follows:

 {
   "config":{
     "softwareConfig":{
       "pypiPackages":{
         "scikit-learn":"==0.19.0"
       }
     }
   }
 }

Note that in the above example, any existing PyPI packages other than scikit-learn and numpy will be unaffected.

Only one update type may be included in a single request's updateMask. For example, one cannot update both the PyPI packages and labels in the same request. However, it is possible to update multiple members of a map field simultaneously in the same request. For example, to set the labels "label1" and "label2" while clearing "label3" (assuming it already exists), one can provide the paths "labels.label1", "labels.label2", and "labels.label3" and populate the patch environment as follows:

 {
   "labels":{
     "label1":"new-label1-value"
     "label2":"new-label2-value"
   }
 }

Note that in the above example, any existing labels that are not included in the updateMask will be unaffected.

It is also possible to replace an entire map field by providing the map field's path in the updateMask. The new value of the field will be that which is provided in the patch environment. For example, to delete all pre-existing user-specified PyPI packages and install botocore at version 1.7.14, the updateMask would contain the path "config.softwareConfig.pypiPackages", and the patch environment would be the following:

 {
   "config":{
     "softwareConfig":{
       "pypiPackages":{
         "botocore":"==1.7.14"
       }
     }
   }
 }

Note: Only the following fields can be updated:

  • config.softwareConfig.pypiPackages
    • Replace all custom custom PyPI packages. If a replacement package map is not included in environment, all custom PyPI packages are cleared. It is an error to provide both this mask and a mask specifying an individual package.
  • config.softwareConfig.pypiPackages.packagename
    • Update the custom PyPI package packagename, preserving other packages. To delete the package, include it in updateMask, and omit the mapping for it in environment.config.softwareConfig.pypiPackages. It is an error to provide both a mask of this form and the config.softwareConfig.pypiPackages mask.
  • labels
    • Replace all environment labels. If a replacement labels map is not included in environment, all labels are cleared. It is an error to provide both this mask and a mask specifying one or more individual labels.
  • labels.labelName
    • Set the label named labelName, while preserving other labels. To delete the label, include it in updateMask and omit its mapping in environment.labels. It is an error to provide both a mask of this form and the labels mask.
  • config.nodeCount
    • Horizontally scale the number of nodes in the environment. An integer greater than or equal to 3 must be provided in the config.nodeCount field. Supported for Cloud Composer environments in versions composer-1..-airflow-..*.
  • config.webServerNetworkAccessControl
    • Replace the environment's current WebServerNetworkAccessControl.
  • config.softwareConfig.airflowConfigOverrides
    • Replace all Apache Airflow config overrides. If a replacement config overrides map is not included in environment, all config overrides are cleared. It is an error to provide both this mask and a mask specifying one or more individual config overrides.
  • config.softwareConfig.airflowConfigOverrides.section-name
    • Override the Apache Airflow config property name in the section named section, preserving other properties. To delete the property override, include it in updateMask and omit its mapping in environment.config.softwareConfig.airflowConfigOverrides. It is an error to provide both a mask of this form and the config.softwareConfig.airflowConfigOverrides mask.
  • config.softwareConfig.envVariables
    • Replace all environment variables. If a replacement environment variable map is not included in environment, all custom environment variables are cleared.
  • config.softwareConfig.schedulerCount
    • Horizontally scale the number of schedulers in Airflow. A positive integer not greater than the number of nodes must be provided in the config.softwareConfig.schedulerCount field. Supported for Cloud Composer environments in versions composer-1..-airflow-2...
  • config.databaseConfig.machineType
    • Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. Supported for Cloud Composer environments in versions composer-1..-airflow-..*.
  • config.webServerConfig.machineType
    • Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. Supported for Cloud Composer environments in versions composer-1..-airflow-..*.

.google.protobuf.FieldMask update_mask = 3;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
UpdateEnvironmentRequest.Builder

setUpdateMask(FieldMask.Builder builderForValue)

public UpdateEnvironmentRequest.Builder setUpdateMask(FieldMask.Builder builderForValue)

Required. A comma-separated list of paths, relative to Environment, of fields to update. For example, to set the version of scikit-learn to install in the environment to 0.19.0 and to remove an existing installation of numpy, the updateMask parameter would include the following two paths values: "config.softwareConfig.pypiPackages.scikit-learn" and "config.softwareConfig.pypiPackages.numpy". The included patch environment would specify the scikit-learn version as follows:

 {
   "config":{
     "softwareConfig":{
       "pypiPackages":{
         "scikit-learn":"==0.19.0"
       }
     }
   }
 }

Note that in the above example, any existing PyPI packages other than scikit-learn and numpy will be unaffected.

Only one update type may be included in a single request's updateMask. For example, one cannot update both the PyPI packages and labels in the same request. However, it is possible to update multiple members of a map field simultaneously in the same request. For example, to set the labels "label1" and "label2" while clearing "label3" (assuming it already exists), one can provide the paths "labels.label1", "labels.label2", and "labels.label3" and populate the patch environment as follows:

 {
   "labels":{
     "label1":"new-label1-value"
     "label2":"new-label2-value"
   }
 }

Note that in the above example, any existing labels that are not included in the updateMask will be unaffected.

It is also possible to replace an entire map field by providing the map field's path in the updateMask. The new value of the field will be that which is provided in the patch environment. For example, to delete all pre-existing user-specified PyPI packages and install botocore at version 1.7.14, the updateMask would contain the path "config.softwareConfig.pypiPackages", and the patch environment would be the following:

 {
   "config":{
     "softwareConfig":{
       "pypiPackages":{
         "botocore":"==1.7.14"
       }
     }
   }
 }

Note: Only the following fields can be updated:

  • config.softwareConfig.pypiPackages
    • Replace all custom custom PyPI packages. If a replacement package map is not included in environment, all custom PyPI packages are cleared. It is an error to provide both this mask and a mask specifying an individual package.
  • config.softwareConfig.pypiPackages.packagename
    • Update the custom PyPI package packagename, preserving other packages. To delete the package, include it in updateMask, and omit the mapping for it in environment.config.softwareConfig.pypiPackages. It is an error to provide both a mask of this form and the config.softwareConfig.pypiPackages mask.
  • labels
    • Replace all environment labels. If a replacement labels map is not included in environment, all labels are cleared. It is an error to provide both this mask and a mask specifying one or more individual labels.
  • labels.labelName
    • Set the label named labelName, while preserving other labels. To delete the label, include it in updateMask and omit its mapping in environment.labels. It is an error to provide both a mask of this form and the labels mask.
  • config.nodeCount
    • Horizontally scale the number of nodes in the environment. An integer greater than or equal to 3 must be provided in the config.nodeCount field. Supported for Cloud Composer environments in versions composer-1..-airflow-..*.
  • config.webServerNetworkAccessControl
    • Replace the environment's current WebServerNetworkAccessControl.
  • config.softwareConfig.airflowConfigOverrides
    • Replace all Apache Airflow config overrides. If a replacement config overrides map is not included in environment, all config overrides are cleared. It is an error to provide both this mask and a mask specifying one or more individual config overrides.
  • config.softwareConfig.airflowConfigOverrides.section-name
    • Override the Apache Airflow config property name in the section named section, preserving other properties. To delete the property override, include it in updateMask and omit its mapping in environment.config.softwareConfig.airflowConfigOverrides. It is an error to provide both a mask of this form and the config.softwareConfig.airflowConfigOverrides mask.
  • config.softwareConfig.envVariables
    • Replace all environment variables. If a replacement environment variable map is not included in environment, all custom environment variables are cleared.
  • config.softwareConfig.schedulerCount
    • Horizontally scale the number of schedulers in Airflow. A positive integer not greater than the number of nodes must be provided in the config.softwareConfig.schedulerCount field. Supported for Cloud Composer environments in versions composer-1..-airflow-2...
  • config.databaseConfig.machineType
    • Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. Supported for Cloud Composer environments in versions composer-1..-airflow-..*.
  • config.webServerConfig.machineType
    • Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. Supported for Cloud Composer environments in versions composer-1..-airflow-..*.

.google.protobuf.FieldMask update_mask = 3;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
UpdateEnvironmentRequest.Builder