pub struct OrganizationEnvironmentApiRevisionDeployCall<'a, S>where
S: 'a,{ /* private fields */ }
Expand description
Deploys a revision of an API proxy. If another revision of the same API proxy revision is currently deployed, set the override
parameter to true
to have this revision replace the currently deployed revision. You cannot invoke an API proxy until it has been deployed to an environment. After you deploy an API proxy revision, you cannot edit it. To edit the API proxy, you must create and deploy a new revision. For a request path organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments
, two permissions are required: * apigee.deployments.create
on the resource organizations/{org}/environments/{env}
* apigee.proxyrevisions.deploy
on the resource organizations/{org}/apis/{api}/revisions/{rev}
A builder for the environments.apis.revisions.deploy method supported by a organization resource.
It is not used directly, but through a OrganizationMethods
instance.
§Example
Instantiate a resource method builder
// 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.organizations().environments_apis_revisions_deploy("name")
.service_account("ut")
.sequenced_rollout(true)
.override_(false)
.doit().await;
Implementations§
source§impl<'a, S> OrganizationEnvironmentApiRevisionDeployCall<'a, S>
impl<'a, S> OrganizationEnvironmentApiRevisionDeployCall<'a, S>
sourcepub async fn doit(
self
) -> Result<(Response<Body>, GoogleCloudApigeeV1Deployment)>
pub async fn doit( self ) -> Result<(Response<Body>, GoogleCloudApigeeV1Deployment)>
Perform the operation you have build so far.
sourcepub fn name(
self,
new_value: &str
) -> OrganizationEnvironmentApiRevisionDeployCall<'a, S>
pub fn name( self, new_value: &str ) -> OrganizationEnvironmentApiRevisionDeployCall<'a, S>
Required. Name of the API proxy revision deployment in the following format: organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}
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 service_account(
self,
new_value: &str
) -> OrganizationEnvironmentApiRevisionDeployCall<'a, S>
pub fn service_account( self, new_value: &str ) -> OrganizationEnvironmentApiRevisionDeployCall<'a, S>
Google Cloud IAM service account. The service account represents the identity of the deployed proxy, and determines what permissions it has. The format must be {ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com
.
Sets the service account query property to the given value.
sourcepub fn sequenced_rollout(
self,
new_value: bool
) -> OrganizationEnvironmentApiRevisionDeployCall<'a, S>
pub fn sequenced_rollout( self, new_value: bool ) -> OrganizationEnvironmentApiRevisionDeployCall<'a, S>
Flag that specifies whether to enable sequenced rollout. If set to true
, the routing rules for this deployment and the environment changes to add the deployment will be rolled out in a safe order. This reduces the risk of downtime that could be caused by changing the environment group’s routing before the new destination for the affected traffic is ready to receive it. This should only be necessary if the new deployment will be capturing traffic from another environment under a shared environment group or if traffic will be rerouted to a different environment due to a base path removal. The generateDeployChangeReport API may be used to examine routing changes before issuing the deployment request, and its response will indicate if a sequenced rollout is recommended for the deployment.
Sets the sequenced rollout query property to the given value.
sourcepub fn override_(
self,
new_value: bool
) -> OrganizationEnvironmentApiRevisionDeployCall<'a, S>
pub fn override_( self, new_value: bool ) -> OrganizationEnvironmentApiRevisionDeployCall<'a, S>
Flag that specifies whether the new deployment replaces other deployed revisions of the API proxy in the environment. Set override
to true
to replace other deployed revisions. By default, override
is false
and the deployment is rejected if other revisions of the API proxy are deployed in the environment.
Sets the override query property to the given value.
sourcepub fn delegate(
self,
new_value: &'a mut dyn Delegate
) -> OrganizationEnvironmentApiRevisionDeployCall<'a, S>
pub fn delegate( self, new_value: &'a mut dyn Delegate ) -> OrganizationEnvironmentApiRevisionDeployCall<'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
) -> OrganizationEnvironmentApiRevisionDeployCall<'a, S>
pub fn param<T>( self, name: T, value: T ) -> OrganizationEnvironmentApiRevisionDeployCall<'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
) -> OrganizationEnvironmentApiRevisionDeployCall<'a, S>
pub fn add_scope<St>( self, scope: St ) -> OrganizationEnvironmentApiRevisionDeployCall<'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
) -> OrganizationEnvironmentApiRevisionDeployCall<'a, S>
pub fn add_scopes<I, St>( self, scopes: I ) -> OrganizationEnvironmentApiRevisionDeployCall<'a, S>
Identifies the authorization scope(s) for the method you are building.
See Self::add_scope()
for details.
sourcepub fn clear_scopes(self) -> OrganizationEnvironmentApiRevisionDeployCall<'a, S>
pub fn clear_scopes(self) -> OrganizationEnvironmentApiRevisionDeployCall<'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).