BeyondCorp API (beyondcorp:v1)

2023-06-20

4 new methods

Additions

    Methods
  • beyondcorp.organizations.locations.operations.list

      Parameter Order : name

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

      HTTP Method : GET

      Path : v1/{+name}/operations

      Parameters :

        pageSize

          Location : query

          Format : int32

          Type : integer

          Description : The standard list page size.

        pageToken

          Description : The standard list page token.

          Type : string

          Location : query

        name

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

          Type : string

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

          Location : path

          Required : Yes

        filter

          Location : query

          Description : The standard list filter.

          Type : string

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

      Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/operations

  • beyondcorp.organizations.locations.operations.get

      Path : v1/{+name}

      HTTP Method : GET

      Parameter Order : name

      Parameters :

        name

          Type : string

          Description : The name of the operation resource.

          Location : path

          Required : Yes

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

      Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}

      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.

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

  • beyondcorp.organizations.locations.operations.cancel

      Path : v1/{+name}:cancel

      Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}:cancel

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

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

      Parameters :

        name

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

          Required : Yes

          Location : path

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

          Type : string

      HTTP Method : POST

  • beyondcorp.organizations.locations.operations.delete

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

      HTTP Method : DELETE

      Parameters :

        name

          Location : path

          Required : Yes

          Type : string

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

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

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

      Path : v1/{+name}

      Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}

      Parameter Order : name