com.google.cloud.tasks.v2

Class ListTasksRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<ListTasksRequest.Builder>

com.google.cloud.tasks.v2.ListTasksRequest.Builder

All Implemented Interfaces:

ListTasksRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

ListTasksRequest

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

 Request message for listing tasks using [ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks].
 

Protobuf type google.cloud.tasks.v2.ListTasksRequest

Method Summary

Modifier and Type	Method and Description
ListTasksRequest.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ListTasksRequest	build()
ListTasksRequest	buildPartial()
ListTasksRequest.Builder	clear()
ListTasksRequest.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
ListTasksRequest.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
ListTasksRequest.Builder	clearPageSize() Maximum page size.
ListTasksRequest.Builder	clearPageToken() A token identifying the page of results to return.
ListTasksRequest.Builder	clearParent() Required.
ListTasksRequest.Builder	clearResponseView() The response_view specifies which subset of the [Task][google.cloud.tasks.v2.Task] will be returned.
ListTasksRequest.Builder	clone()
ListTasksRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
int	getPageSize() Maximum page size.
String	getPageToken() A token identifying the page of results to return.
com.google.protobuf.ByteString	getPageTokenBytes() A token identifying the page of results to return.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
Task.View	getResponseView() The response_view specifies which subset of the [Task][google.cloud.tasks.v2.Task] will be returned.
int	getResponseViewValue() The response_view specifies which subset of the [Task][google.cloud.tasks.v2.Task] will be returned.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
ListTasksRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ListTasksRequest.Builder	mergeFrom(ListTasksRequest other)
ListTasksRequest.Builder	mergeFrom(com.google.protobuf.Message other)
ListTasksRequest.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
ListTasksRequest.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ListTasksRequest.Builder	setPageSize(int value) Maximum page size.
ListTasksRequest.Builder	setPageToken(String value) A token identifying the page of results to return.
ListTasksRequest.Builder	setPageTokenBytes(com.google.protobuf.ByteString value) A token identifying the page of results to return.
ListTasksRequest.Builder	setParent(String value) Required.
ListTasksRequest.Builder	setParentBytes(com.google.protobuf.ByteString value) Required.
ListTasksRequest.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
ListTasksRequest.Builder	setResponseView(Task.View value) The response_view specifies which subset of the [Task][google.cloud.tasks.v2.Task] will be returned.
ListTasksRequest.Builder	setResponseViewValue(int value) The response_view specifies which subset of the [Task][google.cloud.tasks.v2.Task] will be returned.
ListTasksRequest.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ListTasksRequest.Builder>

clear

public ListTasksRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<ListTasksRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ListTasksRequest.Builder>

getDefaultInstanceForType

public ListTasksRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public ListTasksRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public ListTasksRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public ListTasksRequest.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<ListTasksRequest.Builder>

setField

public ListTasksRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<ListTasksRequest.Builder>

clearField

public ListTasksRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ListTasksRequest.Builder>

clearOneof

public ListTasksRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ListTasksRequest.Builder>

setRepeatedField

public ListTasksRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 int index,
                                                 Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListTasksRequest.Builder>

addRepeatedField

public ListTasksRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListTasksRequest.Builder>

mergeFrom

public ListTasksRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListTasksRequest.Builder>

mergeFrom

public ListTasksRequest.Builder mergeFrom(ListTasksRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ListTasksRequest.Builder>

mergeFrom

public ListTasksRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListTasksRequest.Builder>

Throws:

IOException

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) = { ... }

Specified by:

getParent in interface ListTasksRequestOrBuilder

Returns:

The parent.

getParentBytes

public com.google.protobuf.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) = { ... }

Specified by:

getParentBytes in interface ListTasksRequestOrBuilder

Returns:

The bytes for parent.

setParent

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) = { ... }

Parameters:

value - The parent to set.

Returns:

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:

This builder for chaining.

setParentBytes

public ListTasksRequest.Builder setParentBytes(com.google.protobuf.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) = { ... }

Parameters:

value - The bytes for parent to set.

Returns:

This builder for chaining.

getResponseViewValue

public int getResponseViewValue()

 The response_view specifies which subset of the [Task][google.cloud.tasks.v2.Task] will be
 returned.
 By default response_view is [BASIC][google.cloud.tasks.v2.Task.View.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][google.cloud.tasks.v2.Task.View.FULL] requires
 `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
 permission on the [Task][google.cloud.tasks.v2.Task] resource.
 

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

Specified by:

getResponseViewValue in interface ListTasksRequestOrBuilder

Returns:

The enum numeric value on the wire for responseView.

setResponseViewValue

public ListTasksRequest.Builder setResponseViewValue(int value)

 The response_view specifies which subset of the [Task][google.cloud.tasks.v2.Task] will be
 returned.
 By default response_view is [BASIC][google.cloud.tasks.v2.Task.View.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][google.cloud.tasks.v2.Task.View.FULL] requires
 `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
 permission on the [Task][google.cloud.tasks.v2.Task] resource.
 

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

Parameters:

value - The enum numeric value on the wire for responseView to set.

Returns:

This builder for chaining.

getResponseView

public Task.View getResponseView()

 The response_view specifies which subset of the [Task][google.cloud.tasks.v2.Task] will be
 returned.
 By default response_view is [BASIC][google.cloud.tasks.v2.Task.View.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][google.cloud.tasks.v2.Task.View.FULL] requires
 `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
 permission on the [Task][google.cloud.tasks.v2.Task] resource.
 

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

Specified by:

getResponseView in interface ListTasksRequestOrBuilder

Returns:

The responseView.

setResponseView

public ListTasksRequest.Builder setResponseView(Task.View value)

 The response_view specifies which subset of the [Task][google.cloud.tasks.v2.Task] will be
 returned.
 By default response_view is [BASIC][google.cloud.tasks.v2.Task.View.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][google.cloud.tasks.v2.Task.View.FULL] requires
 `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
 permission on the [Task][google.cloud.tasks.v2.Task] resource.
 

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

Parameters:

value - The responseView to set.

Returns:

This builder for chaining.

clearResponseView

public ListTasksRequest.Builder clearResponseView()

 The response_view specifies which subset of the [Task][google.cloud.tasks.v2.Task] will be
 returned.
 By default response_view is [BASIC][google.cloud.tasks.v2.Task.View.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][google.cloud.tasks.v2.Task.View.FULL] requires
 `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
 permission on the [Task][google.cloud.tasks.v2.Task] resource.
 

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

Returns:

This builder for chaining.

getPageSize

public int getPageSize()

 Maximum page size.
 Fewer tasks than requested might be returned, even if more tasks exist; use
 [next_page_token][google.cloud.tasks.v2.ListTasksResponse.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;

Specified by:

getPageSize in interface ListTasksRequestOrBuilder

Returns:

The pageSize.

setPageSize

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][google.cloud.tasks.v2.ListTasksResponse.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;

Parameters:

value - The pageSize to set.

Returns:

This builder for chaining.

clearPageSize

public ListTasksRequest.Builder clearPageSize()

 Maximum page size.
 Fewer tasks than requested might be returned, even if more tasks exist; use
 [next_page_token][google.cloud.tasks.v2.ListTasksResponse.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:

This builder for chaining.

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][google.cloud.tasks.v2.ListTasksResponse.next_page_token] returned
 from the previous call to [ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks]
 method.
 The page token is valid for only 2 hours.
 

string page_token = 4;

Specified by:

getPageToken in interface ListTasksRequestOrBuilder

Returns:

The pageToken.

getPageTokenBytes

public com.google.protobuf.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][google.cloud.tasks.v2.ListTasksResponse.next_page_token] returned
 from the previous call to [ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks]
 method.
 The page token is valid for only 2 hours.
 

string page_token = 4;

Specified by:

getPageTokenBytes in interface ListTasksRequestOrBuilder

Returns:

The bytes for pageToken.

setPageToken

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][google.cloud.tasks.v2.ListTasksResponse.next_page_token] returned
 from the previous call to [ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks]
 method.
 The page token is valid for only 2 hours.
 

string page_token = 4;

Parameters:

value - The pageToken to set.

Returns:

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][google.cloud.tasks.v2.ListTasksResponse.next_page_token] returned
 from the previous call to [ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks]
 method.
 The page token is valid for only 2 hours.
 

string page_token = 4;

Returns:

This builder for chaining.

setPageTokenBytes

public ListTasksRequest.Builder setPageTokenBytes(com.google.protobuf.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][google.cloud.tasks.v2.ListTasksResponse.next_page_token] returned
 from the previous call to [ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks]
 method.
 The page token is valid for only 2 hours.
 

string page_token = 4;

Parameters:

value - The bytes for pageToken to set.

Returns:

This builder for chaining.

setUnknownFields

public final ListTasksRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListTasksRequest.Builder>

mergeUnknownFields

public final ListTasksRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListTasksRequest.Builder>