composer.projects.locations.environments.patch
PATCH {{baseUrl}}/v1/:name?updateMask=<string>&$.xgafv=<string>&access_token=<string>&alt=<string>&callback=<string>&fields=<string>&key=<string>&oauth_token=<string>&prettyPrint=<boolean>"aUser=<string>&upload_protocol=<string>&uploadType=<string>
Update an environment.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
updateMask | string | 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: Mask Purpose 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. 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. It is an error to provide both this mask and a mask specifying one or more individual environment variables. | |
$.xgafv | string | V1 error format. | |
access_token | string | OAuth access token. | |
alt | string | Data format for response. | |
callback | string | JSONP | |
fields | string | Selector specifying which fields to include in a partial response. | |
key | string | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | |
oauth_token | string | OAuth 2.0 token for the current user. | |
prettyPrint | string | Returns response with indentations and line breaks. | |
quotaUser | string | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. | |
upload_protocol | string | Upload protocol for media (e.g. "raw", "multipart"). | |
uploadType | string | Legacy upload protocol for media (e.g. "media", "multipart"). |
Request Body
{"config"=>{"airflowUri"=>"<string>", "dagGcsPrefix"=>"<string>", "gkeCluster"=>"<string>", "nodeConfig"=>{"diskSizeGb"=>"<integer>", "ipAllocationPolicy"=>{"clusterIpv4CidrBlock"=>"<string>", "clusterSecondaryRangeName"=>"<string>", "servicesIpv4CidrBlock"=>"<string>", "servicesSecondaryRangeName"=>"<string>", "useIpAliases"=>"<boolean>"}, "location"=>"<string>", "machineType"=>"<string>", "network"=>"<string>", "oauthScopes"=>["<string>", "<string>"], "serviceAccount"=>"<string>", "subnetwork"=>"<string>", "tags"=>["<string>", "<string>"]}, "nodeCount"=>"<integer>", "privateEnvironmentConfig"=>{"cloudSqlIpv4CidrBlock"=>"<string>", "enablePrivateEnvironment"=>"<boolean>", "privateClusterConfig"=>{"enablePrivateEndpoint"=>"<boolean>", "masterIpv4CidrBlock"=>"<string>"}, "webServerIpv4CidrBlock"=>"<string>"}, "softwareConfig"=>{"airflowConfigOverrides"=>"<object>", "envVariables"=>"<object>", "imageVersion"=>"<string>", "pypiPackages"=>"<object>", "pythonVersion"=>"<string>"}}, "createTime"=>"<google-datetime>", "labels"=>"<object>", "name"=>"<string>", "state"=>"<string>", "updateTime"=>"<google-datetime>", "uuid"=>"<string>"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"done":false,"error":{"code":-47194927,"message":"consectetur incididunt"},"metadata":{},"name":"Duis nisi qui","response":{}}