Checks

import { Checks } from "https://googleapis.deno.dev/v1/checks:v1alpha.ts";

The Checks API contains powerful and easy-to-use privacy and compliance APIs that interact with the Checks product and its underlying technology.

class Checks {

constructor(client?: CredentialsClient, baseUrl?: string);

async accountsAppsGet(name: string): Promise<GoogleChecksAccountV1alphaApp>;

async accountsAppsList(parent: string, opts?: AccountsAppsListOptions): Promise<GoogleChecksAccountV1alphaListAppsResponse>;

async accountsAppsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>;

async accountsAppsOperationsDelete(name: string): Promise<Empty>;

async accountsAppsOperationsGet(name: string): Promise<Operation>;

async accountsAppsOperationsList(name: string, opts?: AccountsAppsOperationsListOptions): Promise<ListOperationsResponse>;

async accountsAppsOperationsWait(name: string, req: WaitOperationRequest): Promise<Operation>;

async accountsAppsReportsGet(name: string, opts?: AccountsAppsReportsGetOptions): Promise<GoogleChecksReportV1alphaReport>;

async accountsAppsReportsList(parent: string, opts?: AccountsAppsReportsListOptions): Promise<GoogleChecksReportV1alphaListReportsResponse>;

async mediaUpload(parent: string, req: GoogleChecksReportV1alphaAnalyzeUploadRequest): Promise<Operation>;

}

§Constructors

new Checks(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

accountsAppsGet(name: string): Promise<GoogleChecksAccountV1alphaApp>

[src]

Gets an app.

@param name

Required. Resource name of the app. Example: accounts/123/apps/456

accountsAppsList(parent: string, opts?: AccountsAppsListOptions): Promise<GoogleChecksAccountV1alphaListAppsResponse>

[src]

Lists the apps under the given account.

@param parent

Required. The parent account. Example: accounts/123

accountsAppsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>

[src]

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.

@param name

The name of the operation resource to be cancelled.

accountsAppsOperationsDelete(name: string): Promise<Empty>

[src]

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.

@param name

The name of the operation resource to be deleted.

accountsAppsOperationsGet(name: string): Promise<Operation>

[src]

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.

@param name

The name of the operation resource.

accountsAppsOperationsList(name: string, opts?: AccountsAppsOperationsListOptions): Promise<ListOperationsResponse>

[src]

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

@param name

The name of the operation's parent resource.

accountsAppsOperationsWait(name: string, req: WaitOperationRequest): Promise<Operation>

[src]

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.

@param name

The name of the operation resource to wait on.

accountsAppsReportsGet(name: string, opts?: AccountsAppsReportsGetOptions): Promise<GoogleChecksReportV1alphaReport>

[src]

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.

@param name

Required. Resource name of the report. Example: accounts/123/apps/456/reports/789

accountsAppsReportsList(parent: string, opts?: AccountsAppsReportsListOptions): Promise<GoogleChecksReportV1alphaListReportsResponse>

[src]

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.

@param parent

Required. Resource name of the app. Example: accounts/123/apps/456

mediaUpload(parent: string, req: GoogleChecksReportV1alphaAnalyzeUploadRequest): Promise<Operation>

[src]

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.

@param parent

Required. Resource name of the app. Example: accounts/123/apps/456