Cloud Scheduler API (cloudscheduler:v1beta1)

2025-10-28

4 new methods

Additions

    Methods
  • cloudscheduler.projects.locations.operations.get

      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.

      Path : v1beta1/{+name}

      HTTP Method : GET

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameters :

        name

          Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Required : Yes

          Type : string

          Location : path

          Description : The name of the operation resource.

  • cloudscheduler.projects.locations.operations.delete

      HTTP Method : DELETE

      Path : v1beta1/{+name}

      Parameters :

        name

          Required : Yes

          Location : path

          Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Type : string

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

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

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

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

  • cloudscheduler.projects.locations.operations.list

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

      HTTP Method : GET

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/operations

      Parameters :

        name

          Type : string

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

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+$

          Location : path

        pageSize

          Format : int32

          Location : query

          Type : integer

          Description : The standard list page size.

        pageToken

          Description : The standard list page token.

          Type : string

          Location : query

        filter

          Description : The standard list filter.

          Location : query

          Type : string

        returnPartialSuccess

          Location : query

          Type : boolean

          Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.

      Path : v1beta1/{+name}/operations

  • cloudscheduler.projects.locations.operations.cancel

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel

      Parameters :

        name

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

          Location : path

          Required : Yes

          Type : string

          Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

      Path : v1beta1/{+name}:cancel

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

      HTTP Method : POST

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform