google_api_cloud_shell v0.1.0 GoogleApi.CloudShell.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`

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

Link to this section Functions

Link to this function cloudshell_operations_cancel(connection, name, opts \\ []) View Source
cloudshell_operations_cancel(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.CloudShell.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.CloudShell.V1.Connection): Connection to server
  • name (String.t): The name of the operation resource to be cancelled.
  • opts (KeywordList): [optional] Optional parameters

    • :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.
    • :access_token (String.t): OAuth access token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :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.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :$.xgafv (String.t): V1 error format.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :callback (String.t): JSONP
    • :alt (String.t): Data format for response.
    • :body (CancelOperationRequest):

Returns

{:ok, %GoogleApi.CloudShell.V1.Model.Empty{}} on success {:error, info} on failure

Link to this function cloudshell_operations_delete(connection, name, opts \\ []) View Source
cloudshell_operations_delete(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.CloudShell.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.CloudShell.V1.Connection): Connection to server
  • name (String.t): The name of the operation resource to be deleted.
  • opts (KeywordList): [optional] Optional parameters

    • :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.
    • :access_token (String.t): OAuth access token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :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.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :$.xgafv (String.t): V1 error format.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :callback (String.t): JSONP
    • :alt (String.t): Data format for response.

Returns

{:ok, %GoogleApi.CloudShell.V1.Model.Empty{}} on success {:error, info} on failure

Link to this function cloudshell_operations_get(connection, name, opts \\ []) View Source
cloudshell_operations_get(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.CloudShell.V1.Model.Operation.t()} | {:error, Tesla.Env.t()}

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 (GoogleApi.CloudShell.V1.Connection): Connection to server
  • name (String.t): The name of the operation resource.
  • opts (KeywordList): [optional] Optional parameters

    • :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.
    • :access_token (String.t): OAuth access token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :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.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :$.xgafv (String.t): V1 error format.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :callback (String.t): JSONP
    • :alt (String.t): Data format for response.
    • :pageToken (String.t): The standard list page token.
    • :pageSize (integer()): The standard list page size.
    • :filter (String.t): The standard list filter.

Returns

{:ok, %GoogleApi.CloudShell.V1.Model.Operation{}} on success {:error, info} on failure