public sealed class ListTransferJobsRequest : IPageRequest, IMessage<ListTransferJobsRequest>, IEquatable<ListTransferJobsRequest>, IDeepCloneable<ListTransferJobsRequest>, IBufferMessage, IMessage
Reference documentation and code samples for the Storage Transfer v1 API class ListTransferJobsRequest.
projectId
, jobNames
, and jobStatuses
are query parameters that can
be specified when listing transfer jobs.
Implements
IPageRequest, IMessageListTransferJobsRequest, IEquatableListTransferJobsRequest, IDeepCloneableListTransferJobsRequest, IBufferMessage, IMessageNamespace
Google.Cloud.StorageTransfer.V1Assembly
Google.Cloud.StorageTransfer.V1.dll
Constructors
ListTransferJobsRequest()
public ListTransferJobsRequest()
ListTransferJobsRequest(ListTransferJobsRequest)
public ListTransferJobsRequest(ListTransferJobsRequest other)
Parameter | |
---|---|
Name | Description |
other |
ListTransferJobsRequest |
Properties
Filter
public string Filter { get; set; }
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][google.storagetransfer.v1.TransferJob.Status.ENABLED],
[DISABLED][google.storagetransfer.v1.TransferJob.Status.DISABLED], and
[DELETED][google.storagetransfer.v1.TransferJob.Status.DELETED].
Property Value | |
---|---|
Type | Description |
string |
PageSize
public int PageSize { get; set; }
The list page size. The max allowed value is 256.
Property Value | |
---|---|
Type | Description |
int |
PageToken
public string PageToken { get; set; }
The list page token.
Property Value | |
---|---|
Type | Description |
string |