pub struct ProjectLocationEnvironmentPatchCall<'a, S>where
S: 'a,{ /* private fields */ }Expand description
Update an environment.
A builder for the locations.environments.patch method supported by a project resource.
It is not used directly, but through a ProjectMethods instance.
§Example
Instantiate a resource method builder
use composer1::api::Environment;
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = Environment::default();
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.projects().locations_environments_patch(req, "name")
.update_mask(&Default::default())
.doit().await;Implementations§
source§impl<'a, S> ProjectLocationEnvironmentPatchCall<'a, S>
impl<'a, S> ProjectLocationEnvironmentPatchCall<'a, S>
sourcepub async fn doit(self) -> Result<(Response<Body>, Operation)>
pub async fn doit(self) -> Result<(Response<Body>, Operation)>
Perform the operation you have build so far.
sourcepub fn request(
self,
new_value: Environment
) -> ProjectLocationEnvironmentPatchCall<'a, S>
pub fn request( self, new_value: Environment ) -> ProjectLocationEnvironmentPatchCall<'a, S>
Sets the request property to the given value.
Even though the property as already been set when instantiating this call, we provide this method for API completeness.
sourcepub fn name(self, new_value: &str) -> ProjectLocationEnvironmentPatchCall<'a, S>
pub fn name(self, new_value: &str) -> ProjectLocationEnvironmentPatchCall<'a, S>
The relative resource name of the environment to update, in the form: “projects/{projectId}/locations/{locationId}/environments/{environmentId}”
Sets the name path property to the given value.
Even though the property as already been set when instantiating this call, we provide this method for API completeness.
sourcepub fn update_mask(
self,
new_value: FieldMask
) -> ProjectLocationEnvironmentPatchCall<'a, S>
pub fn update_mask( self, new_value: FieldMask ) -> ProjectLocationEnvironmentPatchCall<'a, S>
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-..*.
Sets the update mask query property to the given value.
sourcepub fn delegate(
self,
new_value: &'a mut dyn Delegate
) -> ProjectLocationEnvironmentPatchCall<'a, S>
pub fn delegate( self, new_value: &'a mut dyn Delegate ) -> ProjectLocationEnvironmentPatchCall<'a, S>
The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.
It should be used to handle progress information, and to implement a certain level of resilience.
Sets the delegate property to the given value.
sourcepub fn param<T>(
self,
name: T,
value: T
) -> ProjectLocationEnvironmentPatchCall<'a, S>
pub fn param<T>( self, name: T, value: T ) -> ProjectLocationEnvironmentPatchCall<'a, S>
Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.
Please note that this method must not be used to set any of the known parameters which have their own setter method. If done anyway, the request will fail.
§Additional Parameters
- $.xgafv (query-string) - V1 error format.
- access_token (query-string) - OAuth access token.
- alt (query-string) - Data format for response.
- callback (query-string) - JSONP
- fields (query-string) - Selector specifying which fields to include in a partial response.
- key (query-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 (query-string) - OAuth 2.0 token for the current user.
- prettyPrint (query-boolean) - Returns response with indentations and line breaks.
- quotaUser (query-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.
- uploadType (query-string) - Legacy upload protocol for media (e.g. “media”, “multipart”).
- upload_protocol (query-string) - Upload protocol for media (e.g. “raw”, “multipart”).
sourcepub fn add_scope<St>(
self,
scope: St
) -> ProjectLocationEnvironmentPatchCall<'a, S>
pub fn add_scope<St>( self, scope: St ) -> ProjectLocationEnvironmentPatchCall<'a, S>
Identifies the authorization scope for the method you are building.
Use this method to actively specify which scope should be used, instead of the default Scope variant
Scope::CloudPlatform.
The scope will be added to a set of scopes. This is important as one can maintain access
tokens for more than one scope.
Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.
sourcepub fn add_scopes<I, St>(
self,
scopes: I
) -> ProjectLocationEnvironmentPatchCall<'a, S>
pub fn add_scopes<I, St>( self, scopes: I ) -> ProjectLocationEnvironmentPatchCall<'a, S>
Identifies the authorization scope(s) for the method you are building.
See Self::add_scope() for details.
sourcepub fn clear_scopes(self) -> ProjectLocationEnvironmentPatchCall<'a, S>
pub fn clear_scopes(self) -> ProjectLocationEnvironmentPatchCall<'a, S>
Removes all scopes, and no default scope will be used either.
In this case, you have to specify your API-key using the key parameter (see Self::param()
for details).