Skip to content

Commit

Permalink
feat(composer): update the api
Browse files Browse the repository at this point in the history
#### composer:v1beta1

The following keys were added:
- schemas.SoftwareConfig.properties.schedulerCount (Total Keys: 2)
  • Loading branch information
yoshi-automation committed Jul 13, 2021
1 parent a01c7e2 commit add2fbd
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/dyn/composer_v1.projects.locations.environments.html
Original file line number Diff line number Diff line change
Expand Up @@ -550,7 +550,7 @@ <h3>Method Details</h3>
&quot;uuid&quot;: &quot;A String&quot;, # Output only. The UUID (Universally Unique IDentifier) associated with this environment. This value is generated when the environment is created.
}

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: &quot;config.softwareConfig.pypiPackages.scikit-learn&quot; and &quot;config.softwareConfig.pypiPackages.numpy&quot;. The included patch environment would specify the scikit-learn version as follows: { &quot;config&quot;:{ &quot;softwareConfig&quot;:{ &quot;pypiPackages&quot;:{ &quot;scikit-learn&quot;:&quot;==0.19.0&quot; } } } } 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&#x27;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 &quot;label1&quot; and &quot;label2&quot; while clearing &quot;label3&quot; (assuming it already exists), one can provide the paths &quot;labels.label1&quot;, &quot;labels.label2&quot;, and &quot;labels.label3&quot; and populate the patch environment as follows: { &quot;labels&quot;:{ &quot;label1&quot;:&quot;new-label1-value&quot; &quot;label2&quot;:&quot;new-label2-value&quot; } } 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&#x27;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 &quot;config.softwareConfig.pypiPackages&quot;, and the patch environment would be the following: { &quot;config&quot;:{ &quot;softwareConfig&quot;:{ &quot;pypiPackages&quot;:{ &quot;botocore&quot;:&quot;==1.7.14&quot; } } } } **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 &quot;config.softwareConfig.pypiPackages&quot; 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 &quot;labels&quot; 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.webServerNetworkAccessControl Replace the environment&#x27;s current WebServerNetworkAccessControl. config.databaseConfig Replace the environment&#x27;s current DatabaseConfig. config.webServerConfig Replace the environment&#x27;s current WebServerConfig. 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 &quot;config.softwareConfig.airflowConfigOverrides&quot; 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.
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: &quot;config.softwareConfig.pypiPackages.scikit-learn&quot; and &quot;config.softwareConfig.pypiPackages.numpy&quot;. The included patch environment would specify the scikit-learn version as follows: { &quot;config&quot;:{ &quot;softwareConfig&quot;:{ &quot;pypiPackages&quot;:{ &quot;scikit-learn&quot;:&quot;==0.19.0&quot; } } } } 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&#x27;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 &quot;label1&quot; and &quot;label2&quot; while clearing &quot;label3&quot; (assuming it already exists), one can provide the paths &quot;labels.label1&quot;, &quot;labels.label2&quot;, and &quot;labels.label3&quot; and populate the patch environment as follows: { &quot;labels&quot;:{ &quot;label1&quot;:&quot;new-label1-value&quot; &quot;label2&quot;:&quot;new-label2-value&quot; } } 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&#x27;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 &quot;config.softwareConfig.pypiPackages&quot;, and the patch environment would be the following: { &quot;config&quot;:{ &quot;softwareConfig&quot;:{ &quot;pypiPackages&quot;:{ &quot;botocore&quot;:&quot;==1.7.14&quot; } } } } **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. * `config.webServerNetworkAccessControl` * Replace the environment&#x27;s current `WebServerNetworkAccessControl`. * `config.databaseConfig` * Replace the environment&#x27;s current `DatabaseConfig`. * `config.webServerConfig` * Replace the environment&#x27;s current `WebServerConfig`. * `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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
Expand Down
Loading

0 comments on commit add2fbd

Please sign in to comment.