google_api_runtime_config v0.1.0 GoogleApi.RuntimeConfig.V1.Api.Operations View Source
API calls for all endpoints tagged Operations
.
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`
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users//operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id
Link to this section Functions
runtimeconfig_operations_cancel(Tesla.Env.client(), String.t(), keyword()) :: {:ok, GoogleApi.RuntimeConfig.V1.Model.Empty.t()} | {:error, Tesla.Env.t()}
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 (GoogleApi.RuntimeConfig.V1.Connection): Connection to server
- operations_id (String.t): Part of `name`. The name of the operation resource to be cancelled.
opts (KeywordList): [optional] Optional parameters
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :access_token (String.t): OAuth access token.
- :key (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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (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.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :body (CancelOperationRequest):
Returns
{:ok, %GoogleApi.RuntimeConfig.V1.Model.Empty{}} on success {:error, info} on failure
runtimeconfig_operations_delete(Tesla.Env.client(), String.t(), keyword()) :: {:ok, GoogleApi.RuntimeConfig.V1.Model.Empty.t()} | {:error, Tesla.Env.t()}
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
Parameters
- connection (GoogleApi.RuntimeConfig.V1.Connection): Connection to server
- operations_id (String.t): Part of `name`. The name of the operation resource to be deleted.
opts (KeywordList): [optional] Optional parameters
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :access_token (String.t): OAuth access token.
- :key (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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (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.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
Returns
{:ok, %GoogleApi.RuntimeConfig.V1.Model.Empty{}} on success {:error, info} on failure
runtimeconfig_operations_list(Tesla.Env.client(), keyword()) :: {:ok, GoogleApi.RuntimeConfig.V1.Model.ListOperationsResponse.t()} | {:error, Tesla.Env.t()}
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users//operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameters
- connection (GoogleApi.RuntimeConfig.V1.Connection): Connection to server
opts (KeywordList): [optional] Optional parameters
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :access_token (String.t): OAuth access token.
- :key (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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (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.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :filter (String.t): The standard list filter.
- :pageToken (String.t): The standard list page token.
- :pageSize (integer()): The standard list page size.
Returns
{:ok, %GoogleApi.RuntimeConfig.V1.Model.ListOperationsResponse{}} on success {:error, info} on failure