Checks API (checks:v1alpha)

2023-07-22

9 new methods

Additions

    Methods
  • checks.accounts.apps.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`.

      Parameters :

        name

          Pattern : ^accounts/[^/]+/apps/[^/]+/operations/[^/]+$

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

          Required : Yes

          Location : path

          Type : string

      Parameter Order : name

      HTTP Method : DELETE

      Flat Path : v1alpha/accounts/{accountsId}/apps/{appsId}/operations/{operationsId}

      Scopes : https://www.googleapis.com/auth/xapi.zoo

      Path : v1alpha/{+name}

  • checks.accounts.apps.operations.wait

      Description : Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

      HTTP Method : POST

      Flat Path : v1alpha/accounts/{accountsId}/apps/{appsId}/operations/{operationsId}:wait

      Path : v1alpha/{+name}:wait

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/xapi.zoo

      Parameters :

        name

          Type : string

          Location : path

          Description : The name of the operation resource to wait on.

          Pattern : ^accounts/[^/]+/apps/[^/]+/operations/[^/]+$

          Required : Yes

  • checks.accounts.apps.operations.cancel

      Path : v1alpha/{+name}:cancel

      Parameters :

        name

          Type : string

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

          Location : path

          Pattern : ^accounts/[^/]+/apps/[^/]+/operations/[^/]+$

          Required : Yes

      Flat Path : v1alpha/accounts/{accountsId}/apps/{appsId}/operations/{operationsId}:cancel

      Parameter Order : name

      HTTP Method : POST

      Scopes : https://www.googleapis.com/auth/xapi.zoo

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

  • checks.projects.privacypolicy.operations.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`.

      Path : v1alpha/{+name}:cancel

      HTTP Method : POST

      Flat Path : v1alpha/projects/{projectsId}/privacypolicy/operations/{operationsId}:cancel

      Scopes : https://www.googleapis.com/auth/xapi.zoo

      Parameters :

        name

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

          Required : Yes

          Type : string

          Location : path

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

  • checks.projects.privacypolicy.operations.list

      Scopes : https://www.googleapis.com/auth/xapi.zoo

      Path : v1alpha/{+name}/privacypolicy/operations

      HTTP Method : GET

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

      Parameters :

        name

          Pattern : ^projects/[^/]+$

          Required : Yes

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

          Type : string

          Location : path

        filter

          Description : The standard list filter.

          Type : string

          Location : query

        pageToken

          Type : string

          Location : query

          Description : The standard list page token.

        pageSize

          Format : int32

          Location : query

          Description : The standard list page size.

          Type : integer

      Parameter Order : name

      Flat Path : v1alpha/projects/{projectsId}/privacypolicy/operations

  • checks.projects.privacypolicy.operations.delete

      Flat Path : v1alpha/projects/{projectsId}/privacypolicy/operations/{operationsId}

      Path : v1alpha/{+name}

      Scopes : https://www.googleapis.com/auth/xapi.zoo

      Parameters :

        name

          Required : Yes

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

          Location : path

          Type : string

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

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

      HTTP Method : DELETE

  • checks.projects.privacypolicy.operations.wait

      Parameter Order : name

      HTTP Method : POST

      Flat Path : v1alpha/projects/{projectsId}/privacypolicy/operations/{operationsId}:wait

      Path : v1alpha/{+name}:wait

      Scopes : https://www.googleapis.com/auth/xapi.zoo

      Parameters :

        timeout

          Format : google-duration

          Location : query

          Type : string

          Description : The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

        name

          Description : The name of the operation resource to wait on.

          Type : string

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

          Location : path

          Required : Yes

      Description : Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

  • checks.projects.privacyPolicies.get

      Parameters :

        name

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

          Description : Required. Resource name of the privacy policy.

          Required : Yes

          Location : path

          Type : string

      HTTP Method : GET

      Path : v1alpha/{+name}

      Flat Path : v1alpha/projects/{projectsId}/privacyPolicies/{privacyPoliciesId}

      Parameter Order : name

      Description : Gets a privacy policy.

  • checks.projects.privacyPolicies.delete

      Path : v1alpha/{+name}

      Parameters :

        name

          Location : path

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

          Description : Required. Resource name of the privacy policy.

          Type : string

          Required : Yes

      Flat Path : v1alpha/projects/{projectsId}/privacyPolicies/{privacyPoliciesId}

      Parameter Order : name

      Description : Deletes a privacy policy.

      HTTP Method : DELETE