Class TransferProto.ListTransferJobsRequest (1.36.0)

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > TransferProto.ListTransferJobsRequest

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()
Returns
Type Description
TransferProto.ListTransferJobsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static TransferProto.ListTransferJobsRequest.Builder newBuilder()
Returns
Type Description
TransferProto.ListTransferJobsRequest.Builder

newBuilder(TransferProto.ListTransferJobsRequest prototype)

public static TransferProto.ListTransferJobsRequest.Builder newBuilder(TransferProto.ListTransferJobsRequest prototype)
Parameter
Name Description
prototype TransferProto.ListTransferJobsRequest
Returns
Type Description
TransferProto.ListTransferJobsRequest.Builder

parseDelimitedFrom(InputStream input)

public static TransferProto.ListTransferJobsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TransferProto.ListTransferJobsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferProto.ListTransferJobsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferProto.ListTransferJobsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static TransferProto.ListTransferJobsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
TransferProto.ListTransferJobsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TransferProto.ListTransferJobsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferProto.ListTransferJobsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TransferProto.ListTransferJobsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
TransferProto.ListTransferJobsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TransferProto.ListTransferJobsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferProto.ListTransferJobsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TransferProto.ListTransferJobsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TransferProto.ListTransferJobsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferProto.ListTransferJobsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferProto.ListTransferJobsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static TransferProto.ListTransferJobsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TransferProto.ListTransferJobsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferProto.ListTransferJobsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferProto.ListTransferJobsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static TransferProto.ListTransferJobsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TransferProto.ListTransferJobsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TransferProto.ListTransferJobsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferProto.ListTransferJobsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<TransferProto.ListTransferJobsRequest> parser()
Returns
Type Description
Parser<ListTransferJobsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public TransferProto.ListTransferJobsRequest getDefaultInstanceForType()
Returns
Type Description
TransferProto.ListTransferJobsRequest

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",...]}

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.

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",...]}

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.

string filter = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public int 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()
Returns
Type Description
Parser<ListTransferJobsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public TransferProto.ListTransferJobsRequest.Builder newBuilderForType()
Returns
Type Description
TransferProto.ListTransferJobsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TransferProto.ListTransferJobsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TransferProto.ListTransferJobsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public TransferProto.ListTransferJobsRequest.Builder toBuilder()
Returns
Type Description
TransferProto.ListTransferJobsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException