public final class ListTasksRequest extends GeneratedMessageV3 implements ListTasksRequestOrBuilder
Request message for listing tasks using ListTasks.
Protobuf type google.cloud.tasks.v2.ListTasksRequest
Static Fields
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
RESPONSE_VIEW_FIELD_NUMBER
public static final int RESPONSE_VIEW_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ListTasksRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ListTasksRequest.Builder newBuilder()
Returns
newBuilder(ListTasksRequest prototype)
public static ListTasksRequest.Builder newBuilder(ListTasksRequest prototype)
Parameter
Returns
public static ListTasksRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListTasksRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ListTasksRequest parseFrom(byte[] data)
Parameter
| Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListTasksRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ListTasksRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListTasksRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListTasksRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ListTasksRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListTasksRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListTasksRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ListTasksRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListTasksRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ListTasksRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public ListTasksRequest getDefaultInstanceForType()
Returns
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;
| 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;
| 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;
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) = { ... }
| 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) = { ... }
getParserForType()
public Parser<ListTasksRequest> getParserForType()
Returns
Overrides
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.v2.Task.View response_view = 2;
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.v2.Task.View response_view = 2;
| Type | Description |
int | The enum numeric value on the wire for responseView.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public ListTasksRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListTasksRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ListTasksRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
