2023-08-19
▼ ▲ checks.projects.privacypolicy.operations.get
Flat Path: v1alpha/projects/{projectsId}/privacypolicy/operations/{operationsId}
Parameter Order: 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.
Path: v1alpha/{+name}
HTTP Method: GET
Parameters:
name
Location: path
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/privacypolicy/operations/[^/]+$
Type: string
Required: Yes
▼ ▲ checks.projects.privacypolicy.operations.cancel
Path: v1alpha/{+name}:cancel
Flat Path: v1alpha/projects/{projectsId}/privacypolicy/operations/{operationsId}:cancel
HTTP Method: POST
Parameters:
name
Description: The name of the operation resource to be cancelled.
Required: Yes
Type: string
Location: path
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.wait
Path: v1alpha/{+name}: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.
Parameters:
name
Pattern: ^projects/[^/]+/privacypolicy/operations/[^/]+$
Type: string
Required: Yes
Description: The name of the operation resource to wait on.
Location: path
timeout
Format: google-duration
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.
Location: query
Type: string
Parameter Order: name
HTTP Method: POST
▼ ▲ checks.projects.privacypolicy.operations.delete
Parameter Order: name
Path: v1alpha/{+name}
HTTP Method: DELETE
Flat Path: v1alpha/projects/{projectsId}/privacypolicy/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`.
Parameters:
name
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/privacypolicy/operations/[^/]+$
Description: The name of the operation resource to be deleted.
▼ ▲ checks.projects.privacypolicy.operations.list
Parameter Order: name
HTTP Method: GET
Parameters:
pageToken
Location: query
Type: string
Description: The standard list page token.
filter
Description: The standard list filter.
Location: query
Type: string
pageSize
Type: integer
Format: int32
Location: query
Description: The standard list page size.
name
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+$
Description: The name of the operation's parent resource.
Path: v1alpha/{+name}/privacypolicy/operations
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/projects/{projectsId}/privacypolicy/operations
▼ ▲ checks.accounts.apps.reports.get
Description: Gets a report. By default, only the name and results_uri fields are returned. You can include other fields by listing them in the `fields` URL query parameter. For example, `?fields=name,checks` will return the name and checks fields.
Parameter Order: name
Flat Path: v1alpha/accounts/{accountsId}/apps/{appsId}/reports/{reportsId}
HTTP Method: GET
Path: v1alpha/{+name}
Parameters:
name
Pattern: ^accounts/[^/]+/apps/[^/]+/reports/[^/]+$
Type: string
Required: Yes
Description: Required. Resource name of the report. Example: `accounts/123/apps/456/reports/789`
Location: path
checksFilter
Description: Optional. An [AIP-160](https://google.aip.dev/160) filter string to filter checks within the report. Only checks that match the filter string are included in the response. Example: `state = FAILED`
Location: query
Type: string
▼ ▲ checks.accounts.apps.reports.list
Path: v1alpha/{+parent}/reports
Parameter Order: parent
HTTP Method: GET
Parameters:
parent
Location: path
Pattern: ^accounts/[^/]+/apps/[^/]+$
Type: string
Description: Required. Resource name of the app. Example: `accounts/123/apps/456`
Required: Yes
filter
Type: string
Location: query
Description: Optional. An [AIP-160](https://google.aip.dev/160) filter string to filter reports. Example: `appBundle.releaseType = PRE_RELEASE`
pageSize
Type: integer
Location: query
Description: Optional. The maximum number of reports to return. If unspecified, at most 10 reports will be returned. The maximum value is 50; values above 50 will be coerced to 50.
Format: int32
pageToken
Location: query
Description: Optional. A page token received from a previous `ListReports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReports` must match the call that provided the page token.
Type: string
checksFilter
Location: query
Type: string
Description: Optional. An [AIP-160](https://google.aip.dev/160) filter string to filter checks within reports. Only checks that match the filter string are included in the response. Example: `state = FAILED`
Flat Path: v1alpha/accounts/{accountsId}/apps/{appsId}/reports
Description: Lists reports for the specified app. By default, only the name and results_uri fields are returned. You can include other fields by listing them in the `fields` URL query parameter. For example, `?fields=reports(name,checks)` will return the name and checks fields.
▼ ▲ checks.accounts.apps.operations.list
HTTP Method: GET
Parameter Order: name
Flat Path: v1alpha/accounts/{accountsId}/apps/{appsId}/operations
Parameters:
name
Type: string
Location: path
Required: Yes
Pattern: ^accounts/[^/]+/apps/[^/]+$
Description: The name of the operation's parent resource.
pageSize
Type: integer
Format: int32
Description: The standard list page size.
Location: query
filter
Description: The standard list filter.
Type: string
Location: query
pageToken
Location: query
Type: string
Description: The standard list page token.
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}/operations
▼ ▲ checks.accounts.apps.operations.wait
HTTP Method: POST
Parameter Order: name
Flat Path: v1alpha/accounts/{accountsId}/apps/{appsId}/operations/{operationsId}:wait
Parameters:
name
Pattern: ^accounts/[^/]+/apps/[^/]+/operations/[^/]+$
Required: Yes
Type: string
Description: The name of the operation resource to wait on.
Location: path
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.
Path: v1alpha/{+name}:wait
▼ ▲ checks.accounts.apps.operations.cancel
Flat Path: v1alpha/accounts/{accountsId}/apps/{appsId}/operations/{operationsId}:cancel
Parameter Order: name
Parameters:
name
Type: string
Location: path
Pattern: ^accounts/[^/]+/apps/[^/]+/operations/[^/]+$
Required: Yes
Description: The name of the operation resource to be cancelled.
Path: v1alpha/{+name}:cancel
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`.
▼ ▲ checks.accounts.apps.operations.delete
Parameter Order: name
Parameters:
name
Location: path
Type: string
Description: The name of the operation resource to be deleted.
Required: Yes
Pattern: ^accounts/[^/]+/apps/[^/]+/operations/[^/]+$
Path: v1alpha/{+name}
Flat Path: v1alpha/accounts/{accountsId}/apps/{appsId}/operations/{operationsId}
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.accounts.apps.operations.get
Path: v1alpha/{+name}
Parameter Order: 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.
Flat Path: v1alpha/accounts/{accountsId}/apps/{appsId}/operations/{operationsId}
Parameters:
name
Pattern: ^accounts/[^/]+/apps/[^/]+/operations/[^/]+$
Location: path
Type: string
Required: Yes
Description: The name of the operation resource.
HTTP Method: GET
▼ ▲ checks.media.upload
Parameters:
parent
Pattern: ^accounts/[^/]+/apps/[^/]+$
Description: Required. Resource name of the app. Example: `accounts/123/apps/456`
Required: Yes
Type: string
Location: path
HTTP Method: POST
Flat Path: v1alpha/accounts/{accountsId}/apps/{appsId}/reports:analyzeUpload
Mediaupload:
Maxsize: 10737418240
Accept: */*
Protocols:
Simple:
Path: /upload/v1alpha/{+parent}/reports:analyzeUpload
Multipart: Yes
Path: v1alpha/{+parent}/reports:analyzeUpload
Parameter Order: parent
Description: Analyzes the uploaded app bundle and returns a google.longrunning.Operation containing the generated Report. ## Example (upload only) Send a regular POST request with the header `X-Goog-Upload-Protocol: raw`. ``` POST https://checks.googleapis.com/upload/v1alpha/{parent=accounts/*/apps/*}/reports:analyzeUpload HTTP/1.1 X-Goog-Upload-Protocol: raw Content-Length: Content-Type: application/octet-stream ``` ## Example (upload with metadata) Send a multipart POST request where the first body part contains the metadata JSON and the second body part contains the binary upload. Include the header `X-Goog-Upload-Protocol: multipart`. ``` POST https://checks.googleapis.com/upload/v1alpha/{parent=accounts/*/apps/*}/reports:analyzeUpload HTTP/1.1 X-Goog-Upload-Protocol: multipart Content-Length: ? Content-Type: multipart/related; boundary=BOUNDARY --BOUNDARY Content-Type: application/json {"code_reference_id":"db5bcc20f94055fb5bc08cbb9b0e7a5530308786"} --BOUNDARY --BOUNDARY-- ``` *Note:* Metadata-only requests are not supported.
Supportsmediaupload: Yes
▼ ▲ checks.privacypolicy.analyze
Flat Path: v1alpha/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.