2023-09-09
▼ ▲ checks.privacypolicy.analyze
HTTP Method: POST
Path: v1alpha/privacypolicy:analyze
Description: Performs a synchronous analysis of a privacy policy, where the policy content is mapped to privacy categories, data types, and purposes.
Flat Path: v1alpha/privacypolicy:analyze
▼ ▲ checks.projects.privacypolicy.operations.list
Parameter Order: name
Parameters:
pageSize
Format: int32
Location: query
Description: The standard list page size.
Type: integer
filter
Description: The standard list filter.
Location: query
Type: string
name
Location: path
Type: string
Required: Yes
Description: The name of the operation's parent resource.
Pattern: ^projects/[^/]+$
pageToken
Type: string
Location: query
Description: The standard list page token.
Flat Path: v1alpha/projects/{projectsId}/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`.
Path: v1alpha/{+name}/privacypolicy/operations
▼ ▲ checks.projects.privacypolicy.operations.delete
Flat Path: v1alpha/projects/{projectsId}/privacypolicy/operations/{operationsId}
Parameter Order: name
Path: v1alpha/{+name}
Parameters:
name
Pattern: ^projects/[^/]+/privacypolicy/operations/[^/]+$
Description: The name of the operation resource to be deleted.
Location: path
Type: string
Required: Yes
HTTP Method: 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`.
▼ ▲ checks.projects.privacypolicy.operations.cancel
Path: v1alpha/{+name}:cancel
HTTP Method: POST
Flat Path: v1alpha/projects/{projectsId}/privacypolicy/operations/{operationsId}:cancel
Parameters:
name
Location: path
Required: Yes
Type: string
Description: The name of the operation resource to be cancelled.
Pattern: ^projects/[^/]+/privacypolicy/operations/[^/]+$
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`.
Parameter Order: name
▼ ▲ checks.projects.privacypolicy.operations.get
Flat Path: v1alpha/projects/{projectsId}/privacypolicy/operations/{operationsId}
Parameter Order: name
HTTP Method: 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: v1alpha/{+name}
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/privacypolicy/operations/[^/]+$
Description: The name of the operation resource.
Required: Yes
Location: path
▼ ▲ checks.projects.privacypolicy.operations.wait
HTTP Method: POST
Parameter Order: name
Path: v1alpha/{+name}:wait
Flat Path: v1alpha/projects/{projectsId}/privacypolicy/operations/{operationsId}:wait
Parameters:
timeout
Format: google-duration
Location: query
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
name
Type: string
Pattern: ^projects/[^/]+/privacypolicy/operations/[^/]+$
Location: path
Required: Yes
Description: The name of the operation resource to wait on.
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.