com.google.cloud.tasks.v2

Class ListTasksRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.tasks.v2.ListTasksRequest

All Implemented Interfaces:

ListTasksRequestOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable

public final class ListTasksRequest
extends GeneratedMessageV3
implements ListTasksRequestOrBuilder

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

Protobuf type google.cloud.tasks.v2.ListTasksRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListTasksRequest.Builder Request message for listing tasks using [ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks].

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	PAGE_SIZE_FIELD_NUMBER
static int	PAGE_TOKEN_FIELD_NUMBER
static int	PARENT_FIELD_NUMBER
static int	RESPONSE_VIEW_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static ListTasksRequest	getDefaultInstance()
ListTasksRequest	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
int	getPageSize() Maximum page size.
String	getPageToken() A token identifying the page of results to return.
ByteString	getPageTokenBytes() A token identifying the page of results to return.
String	getParent() Required.
ByteString	getParentBytes() Required.
Parser<ListTasksRequest>	getParserForType()
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.
int	getSerializedSize()
UnknownFieldSet	getUnknownFields()
int	hashCode()
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ListTasksRequest.Builder	newBuilder()
static ListTasksRequest.Builder	newBuilder(ListTasksRequest prototype)
ListTasksRequest.Builder	newBuilderForType()
protected ListTasksRequest.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static ListTasksRequest	parseDelimitedFrom(InputStream input)
static ListTasksRequest	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static ListTasksRequest	parseFrom(byte[] data)
static ListTasksRequest	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static ListTasksRequest	parseFrom(ByteBuffer data)
static ListTasksRequest	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static ListTasksRequest	parseFrom(ByteString data)
static ListTasksRequest	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static ListTasksRequest	parseFrom(CodedInputStream input)
static ListTasksRequest	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static ListTasksRequest	parseFrom(InputStream input)
static ListTasksRequest	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<ListTasksRequest>	parser()
ListTasksRequest.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER

See Also:

Constant Field Values

RESPONSE_VIEW_FIELD_NUMBER

public static final int RESPONSE_VIEW_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

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

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.

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.

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.

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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static ListTasksRequest parseFrom(ByteBuffer data)
                                  throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ListTasksRequest parseFrom(ByteBuffer data,
                                         ExtensionRegistryLite extensionRegistry)
                                  throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ListTasksRequest parseFrom(ByteString data)
                                  throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ListTasksRequest parseFrom(ByteString data,
                                         ExtensionRegistryLite extensionRegistry)
                                  throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ListTasksRequest parseFrom(byte[] data)
                                  throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ListTasksRequest parseFrom(byte[] data,
                                         ExtensionRegistryLite extensionRegistry)
                                  throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ListTasksRequest parseFrom(InputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

public static ListTasksRequest parseFrom(InputStream input,
                                         ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static ListTasksRequest parseDelimitedFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static ListTasksRequest parseDelimitedFrom(InputStream input,
                                                  ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

parseFrom

public static ListTasksRequest parseFrom(CodedInputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

public static ListTasksRequest parseFrom(CodedInputStream input,
                                         ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

newBuilderForType

public ListTasksRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static ListTasksRequest.Builder newBuilder()

newBuilder

public static ListTasksRequest.Builder newBuilder(ListTasksRequest prototype)

toBuilder

public ListTasksRequest.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected ListTasksRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static ListTasksRequest getDefaultInstance()

parser

public static Parser<ListTasksRequest> parser()

getParserForType

public Parser<ListTasksRequest> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public ListTasksRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder