google_api_cloud_build v0.22.0 GoogleApi.CloudBuild.V1.Api.Vbeta1 View Source
API calls for all endpoints tagged Vbeta1.
Link to this section Summary
Functions
Starts asynchronous cancellation on a long-running operation. The server
makes a best effort to cancel the operation, but success is not
guaranteed. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Clients can use
Operations.GetOperation or
other methods to check whether the cancellation succeeded or whether the
operation completed despite cancellation. On successful cancellation,
the operation is not deleted; instead, it becomes an operation with
an Operation.error value with a google.rpc.Status.code of 1,
corresponding to Code.CANCELLED.
Link to this section Functions
cloudbuild_vbeta1_projects_locations_operations_cancel(connection, projects_id, locations_id, operations_id, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudbuild_vbeta1_projects_locations_operations_cancel( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudBuild.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Starts asynchronous cancellation on a long-running operation. The server
makes a best effort to cancel the operation, but success is not
guaranteed. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Clients can use
Operations.GetOperation or
other methods to check whether the cancellation succeeded or whether the
operation completed despite cancellation. On successful cancellation,
the operation is not deleted; instead, it becomes an operation with
an Operation.error value with a google.rpc.Status.code of 1,
corresponding to Code.CANCELLED.
Parameters
-
connection(type:GoogleApi.CloudBuild.V1.Connection.t) - Connection to server -
projects_id(type:String.t) - Part ofname. The name of the operation resource to be cancelled. -
locations_id(type:String.t) - Part ofname. See documentation ofprojectsId. -
operations_id(type:String.t) - Part ofname. See documentation ofprojectsId. -
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"). -
:body(type:GoogleApi.CloudBuild.V1.Model.CancelOperationRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.CloudBuild.V1.Model.Empty{}}on success -
{:error, info}on failure