- 1.51.0 (latest)
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
public static final class UpdateEnvironmentRequest.Builder extends GeneratedMessageV3.Builder<UpdateEnvironmentRequest.Builder> implements UpdateEnvironmentRequestOrBuilder
Update an environment.
Protobuf type
google.cloud.orchestration.airflow.service.v1beta1.UpdateEnvironmentRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > UpdateEnvironmentRequest.BuilderImplements
UpdateEnvironmentRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public UpdateEnvironmentRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
UpdateEnvironmentRequest.Builder |
build()
public UpdateEnvironmentRequest build()
Returns | |
---|---|
Type | Description |
UpdateEnvironmentRequest |
buildPartial()
public UpdateEnvironmentRequest buildPartial()
Returns | |
---|---|
Type | Description |
UpdateEnvironmentRequest |
clear()
public UpdateEnvironmentRequest.Builder clear()
Returns | |
---|---|
Type | Description |
UpdateEnvironmentRequest.Builder |
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.v1beta1.Environment environment = 1;
Returns | |
---|---|
Type | Description |
UpdateEnvironmentRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public UpdateEnvironmentRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
UpdateEnvironmentRequest.Builder |
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 | |
---|---|
Type | Description |
UpdateEnvironmentRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public UpdateEnvironmentRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
UpdateEnvironmentRequest.Builder |
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
argparse, the updateMask
parameter would include the following two
paths
values: "config.softwareConfig.pypiPackages.scikit-learn" and
"config.softwareConfig.pypiPackages.argparse". 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 argparse 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.
- Replace all custom custom PyPI packages. If a replacement
package map is not included in
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 inenvironment.config.softwareConfig.pypiPackages
. It is an error to provide both a mask of this form and theconfig.softwareConfig.pypiPackages
mask.
- Update the custom PyPI package packagename,
preserving other packages. To delete the package, include it in
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.
- Replace all environment labels. If a replacement labels map is not
included in
labels.
labelName- Set the label named labelName, while preserving other
labels. To delete the label, include it in
updateMask
and omit its mapping inenvironment.labels
. It is an error to provide both a mask of this form and thelabels
mask.
- Set the label named labelName, while preserving other
labels. To delete the label, include it in
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-..*.
- Horizontally scale the number of nodes in the environment. An integer
greater than or equal to 3 must be provided in the
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.
- Replace all Apache Airflow config overrides. If a replacement config
overrides map is not included in
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 inenvironment.config.softwareConfig.airflowConfigOverrides
. It is an error to provide both a mask of this form and theconfig.softwareConfig.airflowConfigOverrides
mask.
- Override the Apache Airflow config property name in the
section named section, preserving other properties. To
delete the property override, include it in
config.softwareConfig.envVariables
- Replace all environment variables. If a replacement environment
variable map is not included in
environment
, all custom environment variables are cleared.
- Replace all environment variables. If a replacement environment
variable map is not included in
config.softwareConfig.imageVersion
- Upgrade the version of the environment in-place. Refer to
SoftwareConfig.image_version
for information on how to format the new image version. Additionally, the new image version cannot effect a version downgrade, and must match the current image version's Composer and Airflow major versions. Consult the Cloud Composer version list for valid values.
- Upgrade the version of the environment in-place. Refer to
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...
- 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.cloudDataLineageIntegration
- Configuration for Cloud Data Lineage integration.
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-..*.
config.maintenanceWindow
- Maintenance window during which Cloud Composer components may be under maintenance.
config.workloadsConfig
- The workloads configuration settings for the GKE cluster associated with the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
config.environmentSize
- The size of the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
.google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
UpdateEnvironmentRequest.Builder |
clone()
public UpdateEnvironmentRequest.Builder clone()
Returns | |
---|---|
Type | Description |
UpdateEnvironmentRequest.Builder |
getDefaultInstanceForType()
public UpdateEnvironmentRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
UpdateEnvironmentRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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.v1beta1.Environment environment = 1;
Returns | |
---|---|
Type | Description |
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.v1beta1.Environment environment = 1;
Returns | |
---|---|
Type | Description |
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.v1beta1.Environment environment = 1;
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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
argparse, the updateMask
parameter would include the following two
paths
values: "config.softwareConfig.pypiPackages.scikit-learn" and
"config.softwareConfig.pypiPackages.argparse". 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 argparse 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.
- Replace all custom custom PyPI packages. If a replacement
package map is not included in
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 inenvironment.config.softwareConfig.pypiPackages
. It is an error to provide both a mask of this form and theconfig.softwareConfig.pypiPackages
mask.
- Update the custom PyPI package packagename,
preserving other packages. To delete the package, include it in
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.
- Replace all environment labels. If a replacement labels map is not
included in
labels.
labelName- Set the label named labelName, while preserving other
labels. To delete the label, include it in
updateMask
and omit its mapping inenvironment.labels
. It is an error to provide both a mask of this form and thelabels
mask.
- Set the label named labelName, while preserving other
labels. To delete the label, include it in
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-..*.
- Horizontally scale the number of nodes in the environment. An integer
greater than or equal to 3 must be provided in the
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.
- Replace all Apache Airflow config overrides. If a replacement config
overrides map is not included in
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 inenvironment.config.softwareConfig.airflowConfigOverrides
. It is an error to provide both a mask of this form and theconfig.softwareConfig.airflowConfigOverrides
mask.
- Override the Apache Airflow config property name in the
section named section, preserving other properties. To
delete the property override, include it in
config.softwareConfig.envVariables
- Replace all environment variables. If a replacement environment
variable map is not included in
environment
, all custom environment variables are cleared.
- Replace all environment variables. If a replacement environment
variable map is not included in
config.softwareConfig.imageVersion
- Upgrade the version of the environment in-place. Refer to
SoftwareConfig.image_version
for information on how to format the new image version. Additionally, the new image version cannot effect a version downgrade, and must match the current image version's Composer and Airflow major versions. Consult the Cloud Composer version list for valid values.
- Upgrade the version of the environment in-place. Refer to
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...
- 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.cloudDataLineageIntegration
- Configuration for Cloud Data Lineage integration.
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-..*.
config.maintenanceWindow
- Maintenance window during which Cloud Composer components may be under maintenance.
config.workloadsConfig
- The workloads configuration settings for the GKE cluster associated with the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
config.environmentSize
- The size of the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
.google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
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
argparse, the updateMask
parameter would include the following two
paths
values: "config.softwareConfig.pypiPackages.scikit-learn" and
"config.softwareConfig.pypiPackages.argparse". 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 argparse 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.
- Replace all custom custom PyPI packages. If a replacement
package map is not included in
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 inenvironment.config.softwareConfig.pypiPackages
. It is an error to provide both a mask of this form and theconfig.softwareConfig.pypiPackages
mask.
- Update the custom PyPI package packagename,
preserving other packages. To delete the package, include it in
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.
- Replace all environment labels. If a replacement labels map is not
included in
labels.
labelName- Set the label named labelName, while preserving other
labels. To delete the label, include it in
updateMask
and omit its mapping inenvironment.labels
. It is an error to provide both a mask of this form and thelabels
mask.
- Set the label named labelName, while preserving other
labels. To delete the label, include it in
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-..*.
- Horizontally scale the number of nodes in the environment. An integer
greater than or equal to 3 must be provided in the
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.
- Replace all Apache Airflow config overrides. If a replacement config
overrides map is not included in
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 inenvironment.config.softwareConfig.airflowConfigOverrides
. It is an error to provide both a mask of this form and theconfig.softwareConfig.airflowConfigOverrides
mask.
- Override the Apache Airflow config property name in the
section named section, preserving other properties. To
delete the property override, include it in
config.softwareConfig.envVariables
- Replace all environment variables. If a replacement environment
variable map is not included in
environment
, all custom environment variables are cleared.
- Replace all environment variables. If a replacement environment
variable map is not included in
config.softwareConfig.imageVersion
- Upgrade the version of the environment in-place. Refer to
SoftwareConfig.image_version
for information on how to format the new image version. Additionally, the new image version cannot effect a version downgrade, and must match the current image version's Composer and Airflow major versions. Consult the Cloud Composer version list for valid values.
- Upgrade the version of the environment in-place. Refer to
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...
- 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.cloudDataLineageIntegration
- Configuration for Cloud Data Lineage integration.
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-..*.
config.maintenanceWindow
- Maintenance window during which Cloud Composer components may be under maintenance.
config.workloadsConfig
- The workloads configuration settings for the GKE cluster associated with the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
config.environmentSize
- The size of the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
.google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
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
argparse, the updateMask
parameter would include the following two
paths
values: "config.softwareConfig.pypiPackages.scikit-learn" and
"config.softwareConfig.pypiPackages.argparse". 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 argparse 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.
- Replace all custom custom PyPI packages. If a replacement
package map is not included in
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 inenvironment.config.softwareConfig.pypiPackages
. It is an error to provide both a mask of this form and theconfig.softwareConfig.pypiPackages
mask.
- Update the custom PyPI package packagename,
preserving other packages. To delete the package, include it in
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.
- Replace all environment labels. If a replacement labels map is not
included in
labels.
labelName- Set the label named labelName, while preserving other
labels. To delete the label, include it in
updateMask
and omit its mapping inenvironment.labels
. It is an error to provide both a mask of this form and thelabels
mask.
- Set the label named labelName, while preserving other
labels. To delete the label, include it in
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-..*.
- Horizontally scale the number of nodes in the environment. An integer
greater than or equal to 3 must be provided in the
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.
- Replace all Apache Airflow config overrides. If a replacement config
overrides map is not included in
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 inenvironment.config.softwareConfig.airflowConfigOverrides
. It is an error to provide both a mask of this form and theconfig.softwareConfig.airflowConfigOverrides
mask.
- Override the Apache Airflow config property name in the
section named section, preserving other properties. To
delete the property override, include it in
config.softwareConfig.envVariables
- Replace all environment variables. If a replacement environment
variable map is not included in
environment
, all custom environment variables are cleared.
- Replace all environment variables. If a replacement environment
variable map is not included in
config.softwareConfig.imageVersion
- Upgrade the version of the environment in-place. Refer to
SoftwareConfig.image_version
for information on how to format the new image version. Additionally, the new image version cannot effect a version downgrade, and must match the current image version's Composer and Airflow major versions. Consult the Cloud Composer version list for valid values.
- Upgrade the version of the environment in-place. Refer to
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...
- 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.cloudDataLineageIntegration
- Configuration for Cloud Data Lineage integration.
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-..*.
config.maintenanceWindow
- Maintenance window during which Cloud Composer components may be under maintenance.
config.workloadsConfig
- The workloads configuration settings for the GKE cluster associated with the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
config.environmentSize
- The size of the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
.google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
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.v1beta1.Environment environment = 1;
Returns | |
---|---|
Type | Description |
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
argparse, the updateMask
parameter would include the following two
paths
values: "config.softwareConfig.pypiPackages.scikit-learn" and
"config.softwareConfig.pypiPackages.argparse". 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 argparse 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.
- Replace all custom custom PyPI packages. If a replacement
package map is not included in
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 inenvironment.config.softwareConfig.pypiPackages
. It is an error to provide both a mask of this form and theconfig.softwareConfig.pypiPackages
mask.
- Update the custom PyPI package packagename,
preserving other packages. To delete the package, include it in
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.
- Replace all environment labels. If a replacement labels map is not
included in
labels.
labelName- Set the label named labelName, while preserving other
labels. To delete the label, include it in
updateMask
and omit its mapping inenvironment.labels
. It is an error to provide both a mask of this form and thelabels
mask.
- Set the label named labelName, while preserving other
labels. To delete the label, include it in
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-..*.
- Horizontally scale the number of nodes in the environment. An integer
greater than or equal to 3 must be provided in the
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.
- Replace all Apache Airflow config overrides. If a replacement config
overrides map is not included in
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 inenvironment.config.softwareConfig.airflowConfigOverrides
. It is an error to provide both a mask of this form and theconfig.softwareConfig.airflowConfigOverrides
mask.
- Override the Apache Airflow config property name in the
section named section, preserving other properties. To
delete the property override, include it in
config.softwareConfig.envVariables
- Replace all environment variables. If a replacement environment
variable map is not included in
environment
, all custom environment variables are cleared.
- Replace all environment variables. If a replacement environment
variable map is not included in
config.softwareConfig.imageVersion
- Upgrade the version of the environment in-place. Refer to
SoftwareConfig.image_version
for information on how to format the new image version. Additionally, the new image version cannot effect a version downgrade, and must match the current image version's Composer and Airflow major versions. Consult the Cloud Composer version list for valid values.
- Upgrade the version of the environment in-place. Refer to
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...
- 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.cloudDataLineageIntegration
- Configuration for Cloud Data Lineage integration.
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-..*.
config.maintenanceWindow
- Maintenance window during which Cloud Composer components may be under maintenance.
config.workloadsConfig
- The workloads configuration settings for the GKE cluster associated with the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
config.environmentSize
- The size of the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
.google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
boolean |
Whether the updateMask field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
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.v1beta1.Environment environment = 1;
Parameter | |
---|---|
Name | Description |
value |
Environment |
Returns | |
---|---|
Type | Description |
UpdateEnvironmentRequest.Builder |
mergeFrom(UpdateEnvironmentRequest other)
public UpdateEnvironmentRequest.Builder mergeFrom(UpdateEnvironmentRequest other)
Parameter | |
---|---|
Name | Description |
other |
UpdateEnvironmentRequest |
Returns | |
---|---|
Type | Description |
UpdateEnvironmentRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public UpdateEnvironmentRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
UpdateEnvironmentRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public UpdateEnvironmentRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
UpdateEnvironmentRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final UpdateEnvironmentRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
UpdateEnvironmentRequest.Builder |
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
argparse, the updateMask
parameter would include the following two
paths
values: "config.softwareConfig.pypiPackages.scikit-learn" and
"config.softwareConfig.pypiPackages.argparse". 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 argparse 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.
- Replace all custom custom PyPI packages. If a replacement
package map is not included in
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 inenvironment.config.softwareConfig.pypiPackages
. It is an error to provide both a mask of this form and theconfig.softwareConfig.pypiPackages
mask.
- Update the custom PyPI package packagename,
preserving other packages. To delete the package, include it in
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.
- Replace all environment labels. If a replacement labels map is not
included in
labels.
labelName- Set the label named labelName, while preserving other
labels. To delete the label, include it in
updateMask
and omit its mapping inenvironment.labels
. It is an error to provide both a mask of this form and thelabels
mask.
- Set the label named labelName, while preserving other
labels. To delete the label, include it in
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-..*.
- Horizontally scale the number of nodes in the environment. An integer
greater than or equal to 3 must be provided in the
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.
- Replace all Apache Airflow config overrides. If a replacement config
overrides map is not included in
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 inenvironment.config.softwareConfig.airflowConfigOverrides
. It is an error to provide both a mask of this form and theconfig.softwareConfig.airflowConfigOverrides
mask.
- Override the Apache Airflow config property name in the
section named section, preserving other properties. To
delete the property override, include it in
config.softwareConfig.envVariables
- Replace all environment variables. If a replacement environment
variable map is not included in
environment
, all custom environment variables are cleared.
- Replace all environment variables. If a replacement environment
variable map is not included in
config.softwareConfig.imageVersion
- Upgrade the version of the environment in-place. Refer to
SoftwareConfig.image_version
for information on how to format the new image version. Additionally, the new image version cannot effect a version downgrade, and must match the current image version's Composer and Airflow major versions. Consult the Cloud Composer version list for valid values.
- Upgrade the version of the environment in-place. Refer to
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...
- 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.cloudDataLineageIntegration
- Configuration for Cloud Data Lineage integration.
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-..*.
config.maintenanceWindow
- Maintenance window during which Cloud Composer components may be under maintenance.
config.workloadsConfig
- The workloads configuration settings for the GKE cluster associated with the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
config.environmentSize
- The size of the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
.google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
FieldMask |
Returns | |
---|---|
Type | Description |
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.v1beta1.Environment environment = 1;
Parameter | |
---|---|
Name | Description |
value |
Environment |
Returns | |
---|---|
Type | Description |
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.v1beta1.Environment environment = 1;
Parameter | |
---|---|
Name | Description |
builderForValue |
Environment.Builder |
Returns | |
---|---|
Type | Description |
UpdateEnvironmentRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public UpdateEnvironmentRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
UpdateEnvironmentRequest.Builder |
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 | |
---|---|
Name | Description |
value |
String The name to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
UpdateEnvironmentRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final UpdateEnvironmentRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
UpdateEnvironmentRequest.Builder |
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
argparse, the updateMask
parameter would include the following two
paths
values: "config.softwareConfig.pypiPackages.scikit-learn" and
"config.softwareConfig.pypiPackages.argparse". 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 argparse 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.
- Replace all custom custom PyPI packages. If a replacement
package map is not included in
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 inenvironment.config.softwareConfig.pypiPackages
. It is an error to provide both a mask of this form and theconfig.softwareConfig.pypiPackages
mask.
- Update the custom PyPI package packagename,
preserving other packages. To delete the package, include it in
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.
- Replace all environment labels. If a replacement labels map is not
included in
labels.
labelName- Set the label named labelName, while preserving other
labels. To delete the label, include it in
updateMask
and omit its mapping inenvironment.labels
. It is an error to provide both a mask of this form and thelabels
mask.
- Set the label named labelName, while preserving other
labels. To delete the label, include it in
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-..*.
- Horizontally scale the number of nodes in the environment. An integer
greater than or equal to 3 must be provided in the
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.
- Replace all Apache Airflow config overrides. If a replacement config
overrides map is not included in
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 inenvironment.config.softwareConfig.airflowConfigOverrides
. It is an error to provide both a mask of this form and theconfig.softwareConfig.airflowConfigOverrides
mask.
- Override the Apache Airflow config property name in the
section named section, preserving other properties. To
delete the property override, include it in
config.softwareConfig.envVariables
- Replace all environment variables. If a replacement environment
variable map is not included in
environment
, all custom environment variables are cleared.
- Replace all environment variables. If a replacement environment
variable map is not included in
config.softwareConfig.imageVersion
- Upgrade the version of the environment in-place. Refer to
SoftwareConfig.image_version
for information on how to format the new image version. Additionally, the new image version cannot effect a version downgrade, and must match the current image version's Composer and Airflow major versions. Consult the Cloud Composer version list for valid values.
- Upgrade the version of the environment in-place. Refer to
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...
- 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.cloudDataLineageIntegration
- Configuration for Cloud Data Lineage integration.
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-..*.
config.maintenanceWindow
- Maintenance window during which Cloud Composer components may be under maintenance.
config.workloadsConfig
- The workloads configuration settings for the GKE cluster associated with the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
config.environmentSize
- The size of the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
.google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
FieldMask |
Returns | |
---|---|
Type | Description |
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
argparse, the updateMask
parameter would include the following two
paths
values: "config.softwareConfig.pypiPackages.scikit-learn" and
"config.softwareConfig.pypiPackages.argparse". 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 argparse 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.
- Replace all custom custom PyPI packages. If a replacement
package map is not included in
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 inenvironment.config.softwareConfig.pypiPackages
. It is an error to provide both a mask of this form and theconfig.softwareConfig.pypiPackages
mask.
- Update the custom PyPI package packagename,
preserving other packages. To delete the package, include it in
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.
- Replace all environment labels. If a replacement labels map is not
included in
labels.
labelName- Set the label named labelName, while preserving other
labels. To delete the label, include it in
updateMask
and omit its mapping inenvironment.labels
. It is an error to provide both a mask of this form and thelabels
mask.
- Set the label named labelName, while preserving other
labels. To delete the label, include it in
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-..*.
- Horizontally scale the number of nodes in the environment. An integer
greater than or equal to 3 must be provided in the
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.
- Replace all Apache Airflow config overrides. If a replacement config
overrides map is not included in
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 inenvironment.config.softwareConfig.airflowConfigOverrides
. It is an error to provide both a mask of this form and theconfig.softwareConfig.airflowConfigOverrides
mask.
- Override the Apache Airflow config property name in the
section named section, preserving other properties. To
delete the property override, include it in
config.softwareConfig.envVariables
- Replace all environment variables. If a replacement environment
variable map is not included in
environment
, all custom environment variables are cleared.
- Replace all environment variables. If a replacement environment
variable map is not included in
config.softwareConfig.imageVersion
- Upgrade the version of the environment in-place. Refer to
SoftwareConfig.image_version
for information on how to format the new image version. Additionally, the new image version cannot effect a version downgrade, and must match the current image version's Composer and Airflow major versions. Consult the Cloud Composer version list for valid values.
- Upgrade the version of the environment in-place. Refer to
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...
- 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.cloudDataLineageIntegration
- Configuration for Cloud Data Lineage integration.
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-..*.
config.maintenanceWindow
- Maintenance window during which Cloud Composer components may be under maintenance.
config.workloadsConfig
- The workloads configuration settings for the GKE cluster associated with the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
config.environmentSize
- The size of the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
.google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
UpdateEnvironmentRequest.Builder |