Cloud Scheduler API (cloudscheduler:v1)

2024-09-25

4 new methods

Additions

    Methods
  • cloudscheduler.operations.list

      Path: v1/{+name}

      Flat Path: v1/operations

      HTTP Method: GET

      Parameters:

        name

          Description: The name of the operation's parent resource.

          Pattern: ^operations$

          Location: path

          Required: Yes

          Type: string

        filter

          Description: The standard list filter.

          Location: query

          Type: string

        pageSize

          Description: The standard list page size.

          Location: query

          Type: integer

          Format: int32

        pageToken

          Description: The standard list page token.

          Location: query

          Type: string

      Parameter Order: name

      Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

  • cloudscheduler.operations.get

      Path: v1/{+name}

      Flat Path: v1/operations/{operationsId}

      HTTP Method: GET

      Parameters:

        name

          Description: The name of the operation resource.

          Pattern: ^operations/.*$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

      Description: 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.

  • cloudscheduler.operations.delete

      Path: v1/{+name}

      Flat Path: v1/operations/{operationsId}

      HTTP Method: DELETE

      Parameters:

        name

          Description: The name of the operation resource to be deleted.

          Pattern: ^operations/.*$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

      Description: 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`.

  • cloudscheduler.operations.cancel

      Path: v1/{+name}:cancel

      Flat Path: v1/operations/{operationsId}:cancel

      HTTP Method: POST

      Parameters:

        name

          Description: The name of the operation resource to be cancelled.

          Pattern: ^operations/.*$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

      Description: 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`.