TransferOperationsListOptions

import type { TransferOperationsListOptions } from "https://googleapis.deno.dev/v1/storagetransfer:v1.ts";

Additional options for StorageTransfer#transferOperationsList.

interface TransferOperationsListOptions {

filter: string;

pageSize?: number;

pageToken?: string;

returnPartialSuccess?: boolean;

}

§Properties

filter: string

[src]

Required. A list of query parameters specified as JSON text in the form of: {"projectId":"my_project_id", "jobNames":["jobid1","jobid2",...], "jobNamePattern": "job_name_pattern", "operationNames":["opid1","opid2",...], "operationNamePattern": "operation_name_pattern", "minCreationTime": "min_creation_time", "maxCreationTime": "max_creation_time", "transferStatuses":["status1","status2",...]} Since jobNames, operationNames, and transferStatuses support multiple values, they must be specified with array notation. projectId is the only argument that is required. If specified, jobNamePattern and operationNamePattern must match the full job or operation name respectively. '*' is a wildcard matching 0 or more characters. minCreationTime and maxCreationTime should be timestamps encoded as a string in the RFC 3339 format. The valid values for transferStatuses are case-insensitive: IN_PROGRESS, PAUSED, SUCCESS, FAILED, and ABORTED.

pageSize?: number

[src]

The list page size. The max allowed value is 256.

pageToken?: string

[src]

The list page token.

returnPartialSuccess?: boolean

[src]

When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be true when reading across collections. For example, when parent is set to "projects/example/locations/-". This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.