View Source GoogleApi.CloudBuild.V2.Api.Projects (google_api_cloud_build v0.50.1)
API calls for all endpoints tagged Projects
.
Summary
Functions
Creates a Connection.
Deletes a single connection.
FetchLinkableRepositories get repositories from SCM that are accessible and could be added to the connection.
Gets details of a single connection.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Lists Connections in a given project and location.
Updates a single connection.
ProcessWebhook is called by the external SCM for notifying of events.
Fetches read token of a given repository.
Fetches read/write token of a given repository.
Creates multiple repositories inside a connection.
Creates a Repository.
Deletes a single repository.
Fetch the list of branches or tags for a given repository.
Gets details of a single repository.
Lists Repositories in a given connection.
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND
error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Gets information about a location.
Lists information about the supported locations for this service.
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
.
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Functions
cloudbuild_projects_locations_connections_create(connection, projects_id, locations_id, optional_params \\ [], opts \\ [])
View Source@spec cloudbuild_projects_locations_connections_create( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudBuild.V2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a Connection.
Parameters
-
connection
(type:GoogleApi.CloudBuild.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. Project and location where the connection will be created. Format:projects/*/locations/*
. -
locations_id
(type:String.t
) - Part ofparent
. 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"). -
:connectionId
(type:String.t
) - Required. The ID to use for the Connection, which will become the final component of the Connection's resource name. Names must be unique per-project per-location. Allows alphanumeric characters and any of -._~%!$&'()*+,;=@. -
:body
(type:GoogleApi.CloudBuild.V2.Model.Connection.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudBuild.V2.Model.Operation{}}
on success -
{:error, info}
on failure
cloudbuild_projects_locations_connections_delete(connection, projects_id, locations_id, connections_id, optional_params \\ [], opts \\ [])
View Source@spec cloudbuild_projects_locations_connections_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudBuild.V2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a single connection.
Parameters
-
connection
(type:GoogleApi.CloudBuild.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The name of the Connection to delete. Format:projects/*/locations/*/connections/*
. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
connections_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"). -
:etag
(type:String.t
) - The current etag of the connection. If an etag is provided and does not match the current etag of the connection, deletion will be blocked and an ABORTED error will be returned. -
:validateOnly
(type:boolean()
) - If set, validate the request, but do not actually post it.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudBuild.V2.Model.Operation{}}
on success -
{:error, info}
on failure
cloudbuild_projects_locations_connections_fetch_linkable_repositories(connection, projects_id, locations_id, connections_id, optional_params \\ [], opts \\ [])
View Source@spec cloudbuild_projects_locations_connections_fetch_linkable_repositories( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudBuild.V2.Model.FetchLinkableRepositoriesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
FetchLinkableRepositories get repositories from SCM that are accessible and could be added to the connection.
Parameters
-
connection
(type:GoogleApi.CloudBuild.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofconnection
. Required. The name of the Connection. Format:projects/*/locations/*/connections/*
. -
locations_id
(type:String.t
) - Part ofconnection
. See documentation ofprojectsId
. -
connections_id
(type:String.t
) - Part ofconnection
. 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"). -
:pageSize
(type:integer()
) - Number of results to return in the list. Default to 20. -
:pageToken
(type:String.t
) - Page start.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudBuild.V2.Model.FetchLinkableRepositoriesResponse{}}
on success -
{:error, info}
on failure
cloudbuild_projects_locations_connections_get(connection, projects_id, locations_id, connections_id, optional_params \\ [], opts \\ [])
View Source@spec cloudbuild_projects_locations_connections_get( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudBuild.V2.Model.Connection.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets details of a single connection.
Parameters
-
connection
(type:GoogleApi.CloudBuild.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The name of the Connection to retrieve. Format:projects/*/locations/*/connections/*
. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
connections_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").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudBuild.V2.Model.Connection{}}
on success -
{:error, info}
on failure
cloudbuild_projects_locations_connections_get_iam_policy(connection, projects_id, locations_id, connections_id, optional_params \\ [], opts \\ [])
View Source@spec cloudbuild_projects_locations_connections_get_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudBuild.V2.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
-
connection
(type:GoogleApi.CloudBuild.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field. -
locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
connections_id
(type:String.t
) - Part ofresource
. 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"). -
:"options.requestedPolicyVersion"
(type:integer()
) - Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudBuild.V2.Model.Policy{}}
on success -
{:error, info}
on failure
cloudbuild_projects_locations_connections_list(connection, projects_id, locations_id, optional_params \\ [], opts \\ [])
View Source@spec cloudbuild_projects_locations_connections_list( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudBuild.V2.Model.ListConnectionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists Connections in a given project and location.
Parameters
-
connection
(type:GoogleApi.CloudBuild.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The parent, which owns this collection of Connections. Format:projects/*/locations/*
. -
locations_id
(type:String.t
) - Part ofparent
. 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"). -
:pageSize
(type:integer()
) - Number of results to return in the list. -
:pageToken
(type:String.t
) - Page start.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudBuild.V2.Model.ListConnectionsResponse{}}
on success -
{:error, info}
on failure
cloudbuild_projects_locations_connections_patch(connection, projects_id, locations_id, connections_id, optional_params \\ [], opts \\ [])
View Source@spec cloudbuild_projects_locations_connections_patch( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudBuild.V2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates a single connection.
Parameters
-
connection
(type:GoogleApi.CloudBuild.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofconnection.name
. Immutable. The resource name of the connection, in the formatprojects/{project}/locations/{location}/connections/{connection_id}
. -
locations_id
(type:String.t
) - Part ofconnection.name
. See documentation ofprojectsId
. -
connections_id
(type:String.t
) - Part ofconnection.name
. 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"). -
:allowMissing
(type:boolean()
) - If set to true, and the connection is not found a new connection will be created. In this situationupdate_mask
is ignored. The creation will succeed only if the input connection has all the necessary information (e.g a github_config with both user_oauth_token and installation_id properties). -
:etag
(type:String.t
) - The current etag of the connection. If an etag is provided and does not match the current etag of the connection, update will be blocked and an ABORTED error will be returned. -
:updateMask
(type:String.t
) - The list of fields to be updated. -
:body
(type:GoogleApi.CloudBuild.V2.Model.Connection.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudBuild.V2.Model.Operation{}}
on success -
{:error, info}
on failure
cloudbuild_projects_locations_connections_process_webhook(connection, projects_id, locations_id, optional_params \\ [], opts \\ [])
View Source@spec cloudbuild_projects_locations_connections_process_webhook( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudBuild.V2.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
ProcessWebhook is called by the external SCM for notifying of events.
Parameters
-
connection
(type:GoogleApi.CloudBuild.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. Project and location where the webhook will be received. Format:projects/*/locations/*
. -
locations_id
(type:String.t
) - Part ofparent
. 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"). -
:webhookKey
(type:String.t
) - Arbitrary additional key to find the maching repository for a webhook event if needed. -
:body
(type:GoogleApi.CloudBuild.V2.Model.HttpBody.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudBuild.V2.Model.Empty{}}
on success -
{:error, info}
on failure
cloudbuild_projects_locations_connections_repositories_access_read_token(connection, projects_id, locations_id, connections_id, repositories_id, optional_params \\ [], opts \\ [])
View Source@spec cloudbuild_projects_locations_connections_repositories_access_read_token( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudBuild.V2.Model.FetchReadTokenResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Fetches read token of a given repository.
Parameters
-
connection
(type:GoogleApi.CloudBuild.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofrepository
. Required. The resource name of the repository in the formatprojects/*/locations/*/connections/*/repositories/*
. -
locations_id
(type:String.t
) - Part ofrepository
. See documentation ofprojectsId
. -
connections_id
(type:String.t
) - Part ofrepository
. See documentation ofprojectsId
. -
repositories_id
(type:String.t
) - Part ofrepository
. 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.V2.Model.FetchReadTokenRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudBuild.V2.Model.FetchReadTokenResponse{}}
on success -
{:error, info}
on failure
cloudbuild_projects_locations_connections_repositories_access_read_write_token(connection, projects_id, locations_id, connections_id, repositories_id, optional_params \\ [], opts \\ [])
View Source@spec cloudbuild_projects_locations_connections_repositories_access_read_write_token( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudBuild.V2.Model.FetchReadWriteTokenResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Fetches read/write token of a given repository.
Parameters
-
connection
(type:GoogleApi.CloudBuild.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofrepository
. Required. The resource name of the repository in the formatprojects/*/locations/*/connections/*/repositories/*
. -
locations_id
(type:String.t
) - Part ofrepository
. See documentation ofprojectsId
. -
connections_id
(type:String.t
) - Part ofrepository
. See documentation ofprojectsId
. -
repositories_id
(type:String.t
) - Part ofrepository
. 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.V2.Model.FetchReadWriteTokenRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudBuild.V2.Model.FetchReadWriteTokenResponse{}}
on success -
{:error, info}
on failure
cloudbuild_projects_locations_connections_repositories_batch_create(connection, projects_id, locations_id, connections_id, optional_params \\ [], opts \\ [])
View Source@spec cloudbuild_projects_locations_connections_repositories_batch_create( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudBuild.V2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates multiple repositories inside a connection.
Parameters
-
connection
(type:GoogleApi.CloudBuild.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The connection to contain all the repositories being created. Format: projects//locations//connections/* The parent field in the CreateRepositoryRequest messages must either be empty or match this field. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
connections_id
(type:String.t
) - Part ofparent
. 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.V2.Model.BatchCreateRepositoriesRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudBuild.V2.Model.Operation{}}
on success -
{:error, info}
on failure
cloudbuild_projects_locations_connections_repositories_create(connection, projects_id, locations_id, connections_id, optional_params \\ [], opts \\ [])
View Source@spec cloudbuild_projects_locations_connections_repositories_create( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudBuild.V2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a Repository.
Parameters
-
connection
(type:GoogleApi.CloudBuild.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The connection to contain the repository. If the request is part of a BatchCreateRepositoriesRequest, this field should be empty or match the parent specified there. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
connections_id
(type:String.t
) - Part ofparent
. 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"). -
:repositoryId
(type:String.t
) - Required. The ID to use for the repository, which will become the final component of the repository's resource name. This ID should be unique in the connection. Allows alphanumeric characters and any of -._~%!$&'()*+,;=@. -
:body
(type:GoogleApi.CloudBuild.V2.Model.Repository.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudBuild.V2.Model.Operation{}}
on success -
{:error, info}
on failure
cloudbuild_projects_locations_connections_repositories_delete(connection, projects_id, locations_id, connections_id, repositories_id, optional_params \\ [], opts \\ [])
View Source@spec cloudbuild_projects_locations_connections_repositories_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudBuild.V2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a single repository.
Parameters
-
connection
(type:GoogleApi.CloudBuild.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The name of the Repository to delete. Format:projects/*/locations/*/connections/*/repositories/*
. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
connections_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
repositories_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"). -
:etag
(type:String.t
) - The current etag of the repository. If an etag is provided and does not match the current etag of the repository, deletion will be blocked and an ABORTED error will be returned. -
:validateOnly
(type:boolean()
) - If set, validate the request, but do not actually post it.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudBuild.V2.Model.Operation{}}
on success -
{:error, info}
on failure
cloudbuild_projects_locations_connections_repositories_fetch_git_refs(connection, projects_id, locations_id, connections_id, repositories_id, optional_params \\ [], opts \\ [])
View Source@spec cloudbuild_projects_locations_connections_repositories_fetch_git_refs( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudBuild.V2.Model.FetchGitRefsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Fetch the list of branches or tags for a given repository.
Parameters
-
connection
(type:GoogleApi.CloudBuild.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofrepository
. Required. The resource name of the repository in the formatprojects/*/locations/*/connections/*/repositories/*
. -
locations_id
(type:String.t
) - Part ofrepository
. See documentation ofprojectsId
. -
connections_id
(type:String.t
) - Part ofrepository
. See documentation ofprojectsId
. -
repositories_id
(type:String.t
) - Part ofrepository
. 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"). -
:pageSize
(type:integer()
) - Optional. Number of results to return in the list. Default to 20. -
:pageToken
(type:String.t
) - Optional. Page start. -
:refType
(type:String.t
) - Type of refs to fetch
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudBuild.V2.Model.FetchGitRefsResponse{}}
on success -
{:error, info}
on failure
cloudbuild_projects_locations_connections_repositories_get(connection, projects_id, locations_id, connections_id, repositories_id, optional_params \\ [], opts \\ [])
View Source@spec cloudbuild_projects_locations_connections_repositories_get( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudBuild.V2.Model.Repository.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets details of a single repository.
Parameters
-
connection
(type:GoogleApi.CloudBuild.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The name of the Repository to retrieve. Format:projects/*/locations/*/connections/*/repositories/*
. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
connections_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
repositories_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").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudBuild.V2.Model.Repository{}}
on success -
{:error, info}
on failure
cloudbuild_projects_locations_connections_repositories_list(connection, projects_id, locations_id, connections_id, optional_params \\ [], opts \\ [])
View Source@spec cloudbuild_projects_locations_connections_repositories_list( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudBuild.V2.Model.ListRepositoriesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists Repositories in a given connection.
Parameters
-
connection
(type:GoogleApi.CloudBuild.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The parent, which owns this collection of Repositories. Format:projects/*/locations/*/connections/*
. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
connections_id
(type:String.t
) - Part ofparent
. 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"). -
:filter
(type:String.t
) - A filter expression that filters resources listed in the response. Expressions must follow API improvement proposal AIP-160. e.g.remote_uri:"https://github.com*"
. -
:pageSize
(type:integer()
) - Number of results to return in the list. -
:pageToken
(type:String.t
) - Page start.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudBuild.V2.Model.ListRepositoriesResponse{}}
on success -
{:error, info}
on failure
cloudbuild_projects_locations_connections_set_iam_policy(connection, projects_id, locations_id, connections_id, optional_params \\ [], opts \\ [])
View Source@spec cloudbuild_projects_locations_connections_set_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudBuild.V2.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Parameters
-
connection
(type:GoogleApi.CloudBuild.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field. -
locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
connections_id
(type:String.t
) - Part ofresource
. 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.V2.Model.SetIamPolicyRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudBuild.V2.Model.Policy{}}
on success -
{:error, info}
on failure
cloudbuild_projects_locations_connections_test_iam_permissions(connection, projects_id, locations_id, connections_id, optional_params \\ [], opts \\ [])
View Source@spec cloudbuild_projects_locations_connections_test_iam_permissions( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudBuild.V2.Model.TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND
error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters
-
connection
(type:GoogleApi.CloudBuild.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field. -
locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
connections_id
(type:String.t
) - Part ofresource
. 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.V2.Model.TestIamPermissionsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudBuild.V2.Model.TestIamPermissionsResponse{}}
on success -
{:error, info}
on failure
cloudbuild_projects_locations_get(connection, projects_id, locations_id, optional_params \\ [], opts \\ [])
View Source@spec cloudbuild_projects_locations_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudBuild.V2.Model.Location.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets information about a location.
Parameters
-
connection
(type:GoogleApi.CloudBuild.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Resource name for the location. -
locations_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").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudBuild.V2.Model.Location{}}
on success -
{:error, info}
on failure
cloudbuild_projects_locations_list(connection, projects_id, optional_params \\ [], opts \\ [])
View Source@spec cloudbuild_projects_locations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudBuild.V2.Model.ListLocationsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists information about the supported locations for this service.
Parameters
-
connection
(type:GoogleApi.CloudBuild.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. The resource that owns the locations collection, if applicable. -
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"). -
:filter
(type:String.t
) - A filter to narrow down results to a preferred subset. The filtering language accepts strings like"displayName=tokyo"
, and is documented in more detail in AIP-160. -
:pageSize
(type:integer()
) - The maximum number of results to return. If not set, the service selects a default. -
:pageToken
(type:String.t
) - A page token received from thenext_page_token
field in the response. Send that page token to receive the subsequent page.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudBuild.V2.Model.ListLocationsResponse{}}
on success -
{:error, info}
on failure
cloudbuild_projects_locations_operations_cancel(connection, projects_id, locations_id, operations_id, optional_params \\ [], opts \\ [])
View Source@spec cloudbuild_projects_locations_operations_cancel( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudBuild.V2.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {: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.V2.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.V2.Model.CancelOperationRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudBuild.V2.Model.Empty{}}
on success -
{:error, info}
on failure
cloudbuild_projects_locations_operations_get(connection, projects_id, locations_id, operations_id, optional_params \\ [], opts \\ [])
View Source@spec cloudbuild_projects_locations_operations_get( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudBuild.V2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters
-
connection
(type:GoogleApi.CloudBuild.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. The name of the operation resource. -
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").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudBuild.V2.Model.Operation{}}
on success -
{:error, info}
on failure