GoogleApi.Apigee.V1.Api.Organizations.apigee_organizations_environments_sharedflows_revisions_deploy

You're seeing just the function apigee_organizations_environments_sharedflows_revisions_deploy, go back to GoogleApi.Apigee.V1.Api.Organizations module for more information.
Link to this function

apigee_organizations_environments_sharedflows_revisions_deploy(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

apigee_organizations_environments_sharedflows_revisions_deploy(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Deployment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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}

Parameters

  • connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Name of the shared flow revision to deploy in the following format: organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :override (type: boolean()) - Flag that specifies whether the new deployment replaces other deployed revisions of the shared flow 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 shared flow are deployed in the environment.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Deployment{}} on success
  • {:error, info} on failure