Send feedback
Class TransferProto.ListTransferJobsRequest (1.56.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latest keyboard_arrow_down
public static final class TransferProto . ListTransferJobsRequest extends GeneratedMessageV3 implements TransferProto . ListTransferJobsRequestOrBuilder
projectId
, jobNames
, and jobStatuses
are query parameters that can
be specified when listing transfer jobs.
Protobuf type google.storagetransfer.v1.ListTransferJobsRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
Type
Description
int
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type
Description
int
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type
Description
int
Static Methods
getDefaultInstance()
public static TransferProto . ListTransferJobsRequest getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static TransferProto . ListTransferJobsRequest . Builder newBuilder ()
newBuilder(TransferProto.ListTransferJobsRequest prototype)
public static TransferProto . ListTransferJobsRequest . Builder newBuilder ( TransferProto . ListTransferJobsRequest prototype )
public static TransferProto . ListTransferJobsRequest parseDelimitedFrom ( InputStream input )
public static TransferProto . ListTransferJobsRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static TransferProto . ListTransferJobsRequest parseFrom ( byte [] data )
Parameter
Name
Description
data
byte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TransferProto . ListTransferJobsRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static TransferProto . ListTransferJobsRequest parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TransferProto . ListTransferJobsRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static TransferProto . ListTransferJobsRequest parseFrom ( CodedInputStream input )
public static TransferProto . ListTransferJobsRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static TransferProto . ListTransferJobsRequest parseFrom ( InputStream input )
public static TransferProto . ListTransferJobsRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static TransferProto . ListTransferJobsRequest parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TransferProto . ListTransferJobsRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<TransferProto . ListTransferJobsRequest > parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name
Description
obj
Object
Overrides
getDefaultInstanceForType()
public TransferProto . ListTransferJobsRequest getDefaultInstanceForType ()
getFilter()
public String 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",...],
"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.
projectId
is required.
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:
Specify
"dataBackend":"QUERY_REPLICATION_CONFIGS"
to return a list of
cross-bucket replication jobs.
Limit the results to jobs from a particular bucket with
sourceBucket
and/or to a particular bucket with
sinkBucket`.
string filter = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type
Description
String
The filter.
getFilterBytes()
public ByteString getFilterBytes ()
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.
projectId
is required.
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:
Specify
"dataBackend":"QUERY_REPLICATION_CONFIGS"
to return a list of
cross-bucket replication jobs.
Limit the results to jobs from a particular bucket with
sourceBucket
and/or to a particular bucket with
sinkBucket`.
string filter = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type
Description
ByteString
The bytes for filter.
getPageSize()
The list page size. The max allowed value is 256.
int32 page_size = 4;
Returns
Type
Description
int
The pageSize.
getPageToken()
public String getPageToken ()
The list page token.
string page_token = 5;
Returns
Type
Description
String
The pageToken.
getPageTokenBytes()
public ByteString getPageTokenBytes ()
The list page token.
string page_token = 5;
Returns
Type
Description
ByteString
The bytes for pageToken.
getParserForType()
public Parser<TransferProto . ListTransferJobsRequest > getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type
Description
int
Overrides
hashCode()
Returns
Type
Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public TransferProto . ListTransferJobsRequest . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TransferProto . ListTransferJobsRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type
Description
Object
Overrides
toBuilder()
public TransferProto . ListTransferJobsRequest . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-28 UTC.
Need to tell us more?
[[["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-01-28 UTC."],[],[]]