Reference documentation and code samples for the Google Cloud Storage Transfer V1 Client class ListTransferJobsRequest.
projectId,jobNames, andjobStatusesare query parameters that can
be specified when listing transfer jobs.
Generated from protobuf messagegoogle.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",...], "dataBackend":"QUERY_REPLICATION_CONFIGS", "sourceBucket":"source-bucket-name", "sinkBucket":"sink-bucket-name", }The JSON formatting in the example is for display only; provide the query parameters without spaces or line breaks. * *projectIdis required. * * SincejobNamesandjobStatusessupport multiple values, their values must be specified with array notation.jobNamesandjobStatusesare optional. Valid values are case-insensitive: * *ENABLED* *DISABLED* *DELETED* * Specify"dataBackend":"QUERY_REPLICATION_CONFIGS"to return a list of cross-bucket replication jobs. * * Limit the results to jobs from a particular bucket withsourceBucketand/or to a particular bucket withsinkBucket.
↳ 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:
The JSON formatting in the example is for display only; provide the
query parameters without spaces or line breaks.
projectIdis required.
SincejobNamesandjobStatusessupport multiple values, their values
must be specified with array notation.jobNamesandjobStatusesare
optional. Valid values are case-insensitive:
The JSON formatting in the example is for display only; provide the
query parameters without spaces or line breaks.
projectIdis required.
SincejobNamesandjobStatusessupport multiple values, their values
must be specified with array notation.jobNamesandjobStatusesare
optional. Valid values are case-insensitive:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Storage Transfer V1 Client - Class ListTransferJobsRequest (2.2.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.2.1 (latest)](/php/docs/reference/cloud-storage-transfer/latest/V1.ListTransferJobsRequest)\n- [2.2.0](/php/docs/reference/cloud-storage-transfer/2.2.0/V1.ListTransferJobsRequest)\n- [2.1.1](/php/docs/reference/cloud-storage-transfer/2.1.1/V1.ListTransferJobsRequest)\n- [2.0.2](/php/docs/reference/cloud-storage-transfer/2.0.2/V1.ListTransferJobsRequest)\n- [1.5.0](/php/docs/reference/cloud-storage-transfer/1.5.0/V1.ListTransferJobsRequest)\n- [1.4.5](/php/docs/reference/cloud-storage-transfer/1.4.5/V1.ListTransferJobsRequest)\n- [1.3.1](/php/docs/reference/cloud-storage-transfer/1.3.1/V1.ListTransferJobsRequest)\n- [1.2.0](/php/docs/reference/cloud-storage-transfer/1.2.0/V1.ListTransferJobsRequest)\n- [1.1.1](/php/docs/reference/cloud-storage-transfer/1.1.1/V1.ListTransferJobsRequest)\n- [1.0.6](/php/docs/reference/cloud-storage-transfer/1.0.6/V1.ListTransferJobsRequest) \nReference documentation and code samples for the Google Cloud Storage Transfer V1 Client class ListTransferJobsRequest.\n\n`projectId`, `jobNames`, and `jobStatuses` are query parameters that can\nbe specified when listing transfer jobs.\n\nGenerated from protobuf message `google.storagetransfer.v1.ListTransferJobsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ StorageTransfer \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getFilter\n\nRequired. A list of query parameters specified as JSON text in the form of: \n\n {\n \"projectId\":\"my_project_id\",\n \"jobNames\":[\"jobid1\",\"jobid2\",...],\n \"jobStatuses\":[\"status1\",\"status2\",...],\n \"dataBackend\":\"QUERY_REPLICATION_CONFIGS\",\n \"sourceBucket\":\"source-bucket-name\",\n \"sinkBucket\":\"sink-bucket-name\",\n }\n\nThe JSON formatting in the example is for display only; provide the\nquery parameters without spaces or line breaks.\n\n- `projectId` is required.\n- Since `jobNames` and `jobStatuses` support multiple values, their values must be specified with array notation. `jobNames` and `jobStatuses` are optional. Valid values are case-insensitive:\n - [ENABLED](/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob.Status#_Google_Cloud_StorageTransfer_V1_TransferJob_Status__ENABLED)\n - [DISABLED](/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob.Status#_Google_Cloud_StorageTransfer_V1_TransferJob_Status__DISABLED)\n - [DELETED](/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob.Status#_Google_Cloud_StorageTransfer_V1_TransferJob_Status__DELETED)\n- Specify `\"dataBackend\":\"QUERY_REPLICATION_CONFIGS\"` to return a list of cross-bucket replication jobs.\n- Limit the results to jobs from a particular bucket with `sourceBucket` and/or to a particular bucket with `sinkBucket`.\n\n### setFilter\n\nRequired. A list of query parameters specified as JSON text in the form of: \n\n {\n \"projectId\":\"my_project_id\",\n \"jobNames\":[\"jobid1\",\"jobid2\",...],\n \"jobStatuses\":[\"status1\",\"status2\",...],\n \"dataBackend\":\"QUERY_REPLICATION_CONFIGS\",\n \"sourceBucket\":\"source-bucket-name\",\n \"sinkBucket\":\"sink-bucket-name\",\n }\n\nThe JSON formatting in the example is for display only; provide the\nquery parameters without spaces or line breaks.\n\n- `projectId` is required.\n- Since `jobNames` and `jobStatuses` support multiple values, their values must be specified with array notation. `jobNames` and `jobStatuses` are optional. Valid values are case-insensitive:\n - [ENABLED](/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob.Status#_Google_Cloud_StorageTransfer_V1_TransferJob_Status__ENABLED)\n - [DISABLED](/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob.Status#_Google_Cloud_StorageTransfer_V1_TransferJob_Status__DISABLED)\n - [DELETED](/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob.Status#_Google_Cloud_StorageTransfer_V1_TransferJob_Status__DELETED)\n- Specify `\"dataBackend\":\"QUERY_REPLICATION_CONFIGS\"` to return a list of cross-bucket replication jobs.\n- Limit the results to jobs from a particular bucket with `sourceBucket` and/or to a particular bucket with `sinkBucket`.\n\n### getPageSize\n\nThe list page size. The max allowed value is 256.\n\n### setPageSize\n\nThe list page size. The max allowed value is 256.\n\n### getPageToken\n\nThe list page token.\n\n### setPageToken\n\nThe list page token."]]
