Class ListTasksRequest.Builder (2.54.0) 

public static final class ListTasksRequest.Builder extends GeneratedMessageV3.Builder<ListTasksRequest.Builder> implements ListTasksRequestOrBuilder

Request message for listing tasks using ListTasks.

Protobuf type google.cloud.tasks.v2beta3.ListTasksRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListTasksRequest.Builder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListTasksRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListTasksRequest.Builder
Overrides

build()

public ListTasksRequest build()
Returns
Type Description
ListTasksRequest

buildPartial()

public ListTasksRequest buildPartial()
Returns
Type Description
ListTasksRequest

clear()

public ListTasksRequest.Builder clear()
Returns
Type Description
ListTasksRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListTasksRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListTasksRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ListTasksRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListTasksRequest.Builder
Overrides

clearPageSize()

public ListTasksRequest.Builder clearPageSize()

Maximum page size.

Fewer tasks than requested might be returned, even if more tasks exist; use next_page_token in the response to determine if more tasks exist.

The maximum page size is 1000. If unspecified, the page size will be the maximum.

int32 page_size = 3;

Returns
Type Description
ListTasksRequest.Builder

This builder for chaining.

clearPageToken()

public ListTasksRequest.Builder clearPageToken()

A token identifying the page of results to return.

To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListTasks method.

The page token is valid for only 2 hours.

string page_token = 4;

Returns
Type Description
ListTasksRequest.Builder

This builder for chaining.

clearParent()

public ListTasksRequest.Builder clearParent()

Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ListTasksRequest.Builder

This builder for chaining.

clearResponseView()

public ListTasksRequest.Builder clearResponseView()

The response_view specifies which subset of the Task will be returned.

By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains.

Authorization for FULL requires cloudtasks.tasks.fullView Google IAM permission on the Task resource.

.google.cloud.tasks.v2beta3.Task.View response_view = 2;

Returns
Type Description
ListTasksRequest.Builder

This builder for chaining.

clone()

public ListTasksRequest.Builder clone()
Returns
Type Description
ListTasksRequest.Builder
Overrides

getDefaultInstanceForType()

public ListTasksRequest getDefaultInstanceForType()
Returns
Type Description
ListTasksRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getPageSize()

public int getPageSize()

Maximum page size.

Fewer tasks than requested might be returned, even if more tasks exist; use next_page_token in the response to determine if more tasks exist.

The maximum page size is 1000. If unspecified, the page size will be the maximum.

int32 page_size = 3;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

A token identifying the page of results to return.

To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListTasks method.

The page token is valid for only 2 hours.

string page_token = 4;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

A token identifying the page of results to return.

To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListTasks method.

The page token is valid for only 2 hours.

string page_token = 4;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getResponseView()

public Task.View getResponseView()

The response_view specifies which subset of the Task will be returned.

By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains.

Authorization for FULL requires cloudtasks.tasks.fullView Google IAM permission on the Task resource.

.google.cloud.tasks.v2beta3.Task.View response_view = 2;

Returns
Type Description
Task.View

The responseView.

getResponseViewValue()

public int getResponseViewValue()

The response_view specifies which subset of the Task will be returned.

By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains.

Authorization for FULL requires cloudtasks.tasks.fullView Google IAM permission on the Task resource.

.google.cloud.tasks.v2beta3.Task.View response_view = 2;

Returns
Type Description
int

The enum numeric value on the wire for responseView.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListTasksRequest other)

public ListTasksRequest.Builder mergeFrom(ListTasksRequest other)
Parameter
Name Description
other ListTasksRequest
Returns
Type Description
ListTasksRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListTasksRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListTasksRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListTasksRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListTasksRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListTasksRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListTasksRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListTasksRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListTasksRequest.Builder
Overrides

setPageSize(int value)

public ListTasksRequest.Builder setPageSize(int value)

Maximum page size.

Fewer tasks than requested might be returned, even if more tasks exist; use next_page_token in the response to determine if more tasks exist.

The maximum page size is 1000. If unspecified, the page size will be the maximum.

int32 page_size = 3;

Parameter
Name Description
value int

The pageSize to set.
Returns
Type Description
ListTasksRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListTasksRequest.Builder setPageToken(String value)

A token identifying the page of results to return.

To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListTasks method.

The page token is valid for only 2 hours.

string page_token = 4;

Parameter
Name Description
value String

The pageToken to set.
Returns
Type Description
ListTasksRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListTasksRequest.Builder setPageTokenBytes(ByteString value)

A token identifying the page of results to return.

To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListTasks method.

The page token is valid for only 2 hours.

string page_token = 4;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.
Returns
Type Description
ListTasksRequest.Builder

This builder for chaining.

setParent(String value)

public ListTasksRequest.Builder setParent(String value)

Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
ListTasksRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListTasksRequest.Builder setParentBytes(ByteString value)

Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.
Returns
Type Description
ListTasksRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListTasksRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListTasksRequest.Builder
Overrides

setResponseView(Task.View value)

public ListTasksRequest.Builder setResponseView(Task.View value)

The response_view specifies which subset of the Task will be returned.

By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains.

Authorization for FULL requires cloudtasks.tasks.fullView Google IAM permission on the Task resource.

.google.cloud.tasks.v2beta3.Task.View response_view = 2;

Parameter
Name Description
value Task.View

The responseView to set.
Returns
Type Description
ListTasksRequest.Builder

This builder for chaining.

setResponseViewValue(int value)

public ListTasksRequest.Builder setResponseViewValue(int value)

The response_view specifies which subset of the Task will be returned.

By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains.

Authorization for FULL requires cloudtasks.tasks.fullView Google IAM permission on the Task resource.

.google.cloud.tasks.v2beta3.Task.View response_view = 2;

Parameter
Name Description
value int

The enum numeric value on the wire for responseView to set.
Returns
Type Description
ListTasksRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ListTasksRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListTasksRequest.Builder
Overrides