Deploys a revision of a shared flow. If another revision of the same shared flow is currently deployed, set the override
parameter to true
to have this revision replace the currently deployed revision. You cannot use a shared flow until it has been deployed to an environment. For a request path organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployments
, two permissions are required: * apigee.deployments.create
on the resource organizations/{org}/environments/{env}
* apigee.sharedflowrevisions.deploy
on the resource organizations/{org}/sharedflows/{sf}/revisions/{rev}
Scopes
You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.
If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform.
You can set the scope for this method like this: apigee1 --scope <scope> organizations environments-sharedflows-revisions-deploy ...
Required Scalar Argument
- <name> (string)
- Required. Name of the shared flow revision to deploy in the following format:
organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}
- Required. Name of the shared flow revision to deploy in the following format:
Optional Output Flags
The method's return value a JSON encoded structure, which will be written to standard output by default.
- -o out
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
-
to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
Optional Method Properties
You may set the following properties to further configure the call. Please note that -p
is followed by one
or more key-value-pairs, and is called like this -p k1=v1 k2=v2
even though the listing below repeats the
-p
for completeness.
-
-p override=boolean
- Flag that specifies whether the new deployment replaces other deployed revisions of the shared flow in the environment. Set
override
totrue
to replace other deployed revisions. By default,override
isfalse
and the deployment is rejected if other revisions of the shared flow are deployed in the environment.
- Flag that specifies whether the new deployment replaces other deployed revisions of the shared flow in the environment. Set
-
-p service-account=string
- 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
.
- 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
Optional General Properties
The following properties can configure any call, and are not specific to this method.
-
-p $-xgafv=string
- V1 error format.
-
-p access-token=string
- OAuth access token.
-
-p alt=string
- Data format for response.
-
-p callback=string
- JSONP
-
-p fields=string
- Selector specifying which fields to include in a partial response.
-
-p 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.
-
-p oauth-token=string
- OAuth 2.0 token for the current user.
-
-p pretty-print=boolean
- Returns response with indentations and line breaks.
-
-p quota-user=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.
-
-p upload-type=string
- Legacy upload protocol for media (e.g. "media", "multipart").
-
-p upload-protocol=string
- Upload protocol for media (e.g. "raw", "multipart").