Checks API (checks:v1alpha)

2023-08-15

11 removed methods | Removed API

Deletions

    Methods
  • checks.accounts.apps.operations.cancel

      Parameters:

        name

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

          Type: string

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

          Required: Yes

          Location: path

      Path: v1alpha/{+name}:cancel

      Parameter Order: name

      HTTP Method: POST

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

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

  • checks.accounts.apps.operations.wait

      Parameter Order: name

      Path: v1alpha/{+name}:wait

      Parameters:

        name

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

          Required: Yes

          Type: string

          Location: path

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

      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.

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

      HTTP Method: POST

  • checks.accounts.apps.operations.delete

      Parameters:

        name

          Required: Yes

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

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

          Location: path

          Type: string

      HTTP Method: DELETE

      Flat Path: v1alpha/accounts/{accountsId}/apps/{appsId}/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`.

      Path: v1alpha/{+name}

      Parameter Order: name

  • checks.accounts.apps.operations.list

      Path: v1alpha/{+name}/operations

      Parameters:

        pageSize

          Format: int32

          Location: query

          Type: integer

          Description: The standard list page size.

        pageToken

          Type: string

          Location: query

          Description: The standard list page token.

        filter

          Type: string

          Location: query

          Description: The standard list filter.

        name

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

          Type: string

          Location: path

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

          Required: Yes

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

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

      Parameter Order: name

  • checks.accounts.apps.operations.get

      Path: v1alpha/{+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.

      Parameters:

        name

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

          Required: Yes

          Type: string

          Location: path

          Description: The name of the operation resource.

      Parameter Order: name

      HTTP Method: GET

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

  • checks.projects.privacypolicy.operations.wait

      Flat Path: v1alpha/projects/{projectsId}/privacypolicy/operations/{operationsId}: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

      Parameter Order: name

      Parameters:

        timeout

          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.

          Type: string

          Location: query

          Format: google-duration

        name

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

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

          Required: Yes

          Location: path

          Type: string

      Path: v1alpha/{+name}:wait

  • checks.projects.privacypolicy.operations.cancel

      Parameter Order: name

      HTTP Method: POST

      Path: v1alpha/{+name}:cancel

      Parameters:

        name

          Type: string

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

          Required: Yes

          Location: path

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

      Flat Path: v1alpha/projects/{projectsId}/privacypolicy/operations/{operationsId}: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`.

  • checks.projects.privacypolicy.operations.get

      HTTP Method: GET

      Path: v1alpha/{+name}

      Flat Path: v1alpha/projects/{projectsId}/privacypolicy/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.

      Parameter Order: name

      Parameters:

        name

          Type: string

          Location: path

          Description: The name of the operation resource.

          Required: Yes

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

  • checks.projects.privacypolicy.operations.list

      HTTP Method: GET

      Parameter Order: name

      Parameters:

        filter

          Location: query

          Type: string

          Description: The standard list filter.

        name

          Type: string

          Required: Yes

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

          Location: path

          Pattern: ^projects/[^/]+$

        pageSize

          Type: integer

          Format: int32

          Description: The standard list page size.

          Location: query

        pageToken

          Type: string

          Description: The standard list page token.

          Location: query

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

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

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

  • checks.projects.privacypolicy.operations.delete

      HTTP Method: DELETE

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

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

      Parameters:

        name

          Required: Yes

          Type: string

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

          Location: path

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

      Path: v1alpha/{+name}

  • checks.privacypolicy.analyze

      HTTP Method: POST

      Path: v1alpha/privacypolicy:analyze

      Description: Analyzes the privacy policy of the given policy URL or content.

      Flat Path: v1alpha/privacypolicy:analyze