BeyondCorp API (beyondcorp:v1)

2023-06-24

4 new methods

Additions

    Methods
  • beyondcorp.organizations.locations.operations.get

      Path : v1/{+name}

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

      Parameters :

        name

          Location : path

          Description : The name of the operation resource.

          Type : string

          Required : Yes

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

      HTTP Method : GET

      Parameter Order : name

      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.

  • beyondcorp.organizations.locations.operations.list

      Parameter Order : name

      Path : v1/{+name}/operations

      Parameters :

        pageToken

          Type : string

          Description : The standard list page token.

          Location : query

        pageSize

          Format : int32

          Type : integer

          Description : The standard list page size.

          Location : query

        filter

          Location : query

          Description : The standard list filter.

          Type : string

        name

          Required : Yes

          Type : string

          Location : path

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

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

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

      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

  • beyondcorp.organizations.locations.operations.cancel

      HTTP Method : POST

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

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

      Parameters :

        name

          Type : string

          Required : Yes

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

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

          Location : path

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

      Path : v1/{+name}:cancel

  • beyondcorp.organizations.locations.operations.delete

      Parameter Order : name

      Parameters :

        name

          Type : string

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

          Required : Yes

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

          Location : path

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

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

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

      Path : v1/{+name}

      HTTP Method : DELETE