Google Cloud Storage Transfer V1 Client - Class ListTransferJobsRequest (1.1.1)

Reference documentation and code samples for the Google Cloud Storage Transfer V1 Client class ListTransferJobsRequest.

projectId , jobNames , and jobStatuses are query parameters that can be specified when listing transfer jobs.

Generated from protobuf message google.storagetransfer.v1.ListTransferJobsRequest

Namespace

Google \ Cloud \ StorageTransfer \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ filter
string

Required. A list of query parameters specified as JSON text in the form of: {"projectId":"my_project_id", "jobNames":["jobid1","jobid2",...], "jobStatuses":["status1","status2",...]} Since jobNames and jobStatuses support multiple values, their values must be specified with array notation. projectId is required. jobNames and jobStatuses are optional. The valid values for jobStatuses are case-insensitive: ENABLED , DISABLED , and DELETED .

↳ page_size
int

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

↳ page_token
string

The list page token.

getFilter

Required. A list of query parameters specified as JSON text in the form of: {"projectId":"my_project_id", "jobNames":["jobid1","jobid2",...], "jobStatuses":["status1","status2",...]} Since jobNames and jobStatuses support multiple values, their values must be specified with array notation. projectId is required.

jobNames and jobStatuses are optional. The valid values for jobStatuses are case-insensitive: ENABLED , DISABLED , and DELETED .

Returns
Type
Description
string

setFilter

Required. A list of query parameters specified as JSON text in the form of: {"projectId":"my_project_id", "jobNames":["jobid1","jobid2",...], "jobStatuses":["status1","status2",...]} Since jobNames and jobStatuses support multiple values, their values must be specified with array notation. projectId is required.

jobNames and jobStatuses are optional. The valid values for jobStatuses are case-insensitive: ENABLED , DISABLED , and DELETED .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getPageSize

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

Returns
Type
Description
int

setPageSize

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

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getPageToken

The list page token.

Returns
Type
Description
string

setPageToken

The list page token.

Parameter
Name
Description
var
string
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: