Class TransferProto.ListTransferJobsRequest.Builder (1.56.0)

Version latest

• 1.56.0 (latest)
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.0.4

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.Builder

Implements

TransferProto.ListTransferJobsRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static 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

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public TransferProto.ListTransferJobsRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
TransferProto.ListTransferJobsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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

• 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 with

sourceBucket and/or to a particular bucket with sinkBucket`.

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public TransferProto.ListTransferJobsRequest getDefaultInstanceForType()

Returns
Type	Description
TransferProto.ListTransferJobsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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:

• 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 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:

• 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 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()

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

• 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 with

sourceBucket and/or to a particular bucket with sinkBucket`.

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

• 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 with

sourceBucket and/or to a particular bucket with sinkBucket`.

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final TransferProto.ListTransferJobsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
TransferProto.ListTransferJobsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)