public static final class TransferProto.ListTransferJobsRequest.Builder extends GeneratedMessageV3.Builder<TransferProto.ListTransferJobsRequest.Builder> 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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > TransferProto.ListTransferJobsRequest.BuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public TransferProto.ListTransferJobsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
TransferProto.ListTransferJobsRequest.Builder |
build()
public TransferProto.ListTransferJobsRequest build()
Returns | |
---|---|
Type | Description |
TransferProto.ListTransferJobsRequest |
buildPartial()
public TransferProto.ListTransferJobsRequest buildPartial()
Returns | |
---|---|
Type | Description |
TransferProto.ListTransferJobsRequest |
clear()
public TransferProto.ListTransferJobsRequest.Builder clear()
Returns | |
---|---|
Type | Description |
TransferProto.ListTransferJobsRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public TransferProto.ListTransferJobsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
TransferProto.ListTransferJobsRequest.Builder |
clearFilter()
public TransferProto.ListTransferJobsRequest.Builder clearFilter()
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 |
TransferProto.ListTransferJobsRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public TransferProto.ListTransferJobsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
TransferProto.ListTransferJobsRequest.Builder |
clearPageSize()
public TransferProto.ListTransferJobsRequest.Builder clearPageSize()
The list page size. The max allowed value is 256.
int32 page_size = 4;
Returns | |
---|---|
Type | Description |
TransferProto.ListTransferJobsRequest.Builder |
This builder for chaining. |
clearPageToken()
public TransferProto.ListTransferJobsRequest.Builder clearPageToken()
The list page token.
string page_token = 5;
Returns | |
---|---|
Type | Description |
TransferProto.ListTransferJobsRequest.Builder |
This builder for chaining. |
clone()
public TransferProto.ListTransferJobsRequest.Builder clone()
Returns | |
---|---|
Type | Description |
TransferProto.ListTransferJobsRequest.Builder |
getDefaultInstanceForType()
public TransferProto.ListTransferJobsRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
TransferProto.ListTransferJobsRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public TransferProto.ListTransferJobsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
TransferProto.ListTransferJobsRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public TransferProto.ListTransferJobsRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
TransferProto.ListTransferJobsRequest.Builder |
mergeFrom(TransferProto.ListTransferJobsRequest other)
public TransferProto.ListTransferJobsRequest.Builder mergeFrom(TransferProto.ListTransferJobsRequest other)
Parameter | |
---|---|
Name | Description |
other |
TransferProto.ListTransferJobsRequest |
Returns | |
---|---|
Type | Description |
TransferProto.ListTransferJobsRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final TransferProto.ListTransferJobsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
TransferProto.ListTransferJobsRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public TransferProto.ListTransferJobsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
TransferProto.ListTransferJobsRequest.Builder |
setFilter(String value)
public TransferProto.ListTransferJobsRequest.Builder setFilter(String value)
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];
Parameter | |
---|---|
Name | Description |
value |
String The filter to set. |
Returns | |
---|---|
Type | Description |
TransferProto.ListTransferJobsRequest.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public TransferProto.ListTransferJobsRequest.Builder setFilterBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for filter to set. |
Returns | |
---|---|
Type | Description |
TransferProto.ListTransferJobsRequest.Builder |
This builder for chaining. |
setPageSize(int value)
public TransferProto.ListTransferJobsRequest.Builder setPageSize(int value)
The list page size. The max allowed value is 256.
int32 page_size = 4;
Parameter | |
---|---|
Name | Description |
value |
int The pageSize to set. |
Returns | |
---|---|
Type | Description |
TransferProto.ListTransferJobsRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public TransferProto.ListTransferJobsRequest.Builder setPageToken(String value)
The list page token.
string page_token = 5;
Parameter | |
---|---|
Name | Description |
value |
String The pageToken to set. |
Returns | |
---|---|
Type | Description |
TransferProto.ListTransferJobsRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public TransferProto.ListTransferJobsRequest.Builder setPageTokenBytes(ByteString value)
The list page token.
string page_token = 5;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for pageToken to set. |
Returns | |
---|---|
Type | Description |
TransferProto.ListTransferJobsRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public TransferProto.ListTransferJobsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
TransferProto.ListTransferJobsRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final TransferProto.ListTransferJobsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
TransferProto.ListTransferJobsRequest.Builder |