com.google.cloud.tasks.v2beta2

Class LeaseTasksRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.tasks.v2beta2.LeaseTasksRequest

All Implemented Interfaces:

LeaseTasksRequestOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable

public final class LeaseTasksRequest
extends GeneratedMessageV3
implements LeaseTasksRequestOrBuilder

 Request message for leasing tasks using [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].
 

Protobuf type google.cloud.tasks.v2beta2.LeaseTasksRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LeaseTasksRequest.Builder Request message for leasing tasks using [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].

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	FILTER_FIELD_NUMBER
static int	LEASE_DURATION_FIELD_NUMBER
static int	MAX_TASKS_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 LeaseTasksRequest	getDefaultInstance()
LeaseTasksRequest	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
String	getFilter() `filter` can be used to specify a subset of tasks to lease.
ByteString	getFilterBytes() `filter` can be used to specify a subset of tasks to lease.
Duration	getLeaseDuration() Required.
DurationOrBuilder	getLeaseDurationOrBuilder() Required.
int	getMaxTasks() The maximum number of tasks to lease.
String	getParent() Required.
ByteString	getParentBytes() Required.
Parser<LeaseTasksRequest>	getParserForType()
Task.View	getResponseView() The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be returned.
int	getResponseViewValue() The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be returned.
int	getSerializedSize()
UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasLeaseDuration() Required.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static LeaseTasksRequest.Builder	newBuilder()
static LeaseTasksRequest.Builder	newBuilder(LeaseTasksRequest prototype)
LeaseTasksRequest.Builder	newBuilderForType()
protected LeaseTasksRequest.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static LeaseTasksRequest	parseDelimitedFrom(InputStream input)
static LeaseTasksRequest	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static LeaseTasksRequest	parseFrom(byte[] data)
static LeaseTasksRequest	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static LeaseTasksRequest	parseFrom(ByteBuffer data)
static LeaseTasksRequest	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static LeaseTasksRequest	parseFrom(ByteString data)
static LeaseTasksRequest	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static LeaseTasksRequest	parseFrom(CodedInputStream input)
static LeaseTasksRequest	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static LeaseTasksRequest	parseFrom(InputStream input)
static LeaseTasksRequest	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<LeaseTasksRequest>	parser()
LeaseTasksRequest.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

MAX_TASKS_FIELD_NUMBER

public static final int MAX_TASKS_FIELD_NUMBER

See Also:

Constant Field Values

LEASE_DURATION_FIELD_NUMBER

public static final int LEASE_DURATION_FIELD_NUMBER

See Also:

Constant Field Values

RESPONSE_VIEW_FIELD_NUMBER

public static final int RESPONSE_VIEW_FIELD_NUMBER

See Also:

Constant Field Values

FILTER_FIELD_NUMBER

public static final int FILTER_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 LeaseTasksRequestOrBuilder

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 LeaseTasksRequestOrBuilder

Returns:

The bytes for parent.

getMaxTasks

public int getMaxTasks()

 The maximum number of tasks to lease.
 The system will make a best effort to return as close to as
 `max_tasks` as possible.
 The largest that `max_tasks` can be is 1000.
 The maximum total size of a [lease tasks response][google.cloud.tasks.v2beta2.LeaseTasksResponse] is
 32 MB. If the sum of all task sizes requested reaches this limit,
 fewer tasks than requested are returned.
 

int32 max_tasks = 2;

Specified by:

getMaxTasks in interface LeaseTasksRequestOrBuilder

Returns:

The maxTasks.

hasLeaseDuration

public boolean hasLeaseDuration()

 Required. The duration of the lease.
 Each task returned in the [response][google.cloud.tasks.v2beta2.LeaseTasksResponse] will
 have its [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] set to the current
 time plus the `lease_duration`. The task is leased until its
 [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time]; thus, the task will not be
 returned to another [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] call
 before its [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time].
 After the worker has successfully finished the work associated
 with the task, the worker must call via
 [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask] before the
 [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time]. Otherwise the task will be
 returned to a later [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] call so
 that another worker can retry it.
 The maximum lease duration is 1 week.
 `lease_duration` will be truncated to the nearest second.
 

.google.protobuf.Duration lease_duration = 3 [(.google.api.field_behavior) = REQUIRED];

Specified by:

hasLeaseDuration in interface LeaseTasksRequestOrBuilder

Returns:

Whether the leaseDuration field is set.

getLeaseDuration

public Duration getLeaseDuration()

 Required. The duration of the lease.
 Each task returned in the [response][google.cloud.tasks.v2beta2.LeaseTasksResponse] will
 have its [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] set to the current
 time plus the `lease_duration`. The task is leased until its
 [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time]; thus, the task will not be
 returned to another [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] call
 before its [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time].
 After the worker has successfully finished the work associated
 with the task, the worker must call via
 [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask] before the
 [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time]. Otherwise the task will be
 returned to a later [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] call so
 that another worker can retry it.
 The maximum lease duration is 1 week.
 `lease_duration` will be truncated to the nearest second.
 

.google.protobuf.Duration lease_duration = 3 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getLeaseDuration in interface LeaseTasksRequestOrBuilder

Returns:

The leaseDuration.

getLeaseDurationOrBuilder

public DurationOrBuilder getLeaseDurationOrBuilder()

 Required. The duration of the lease.
 Each task returned in the [response][google.cloud.tasks.v2beta2.LeaseTasksResponse] will
 have its [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] set to the current
 time plus the `lease_duration`. The task is leased until its
 [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time]; thus, the task will not be
 returned to another [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] call
 before its [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time].
 After the worker has successfully finished the work associated
 with the task, the worker must call via
 [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask] before the
 [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time]. Otherwise the task will be
 returned to a later [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] call so
 that another worker can retry it.
 The maximum lease duration is 1 week.
 `lease_duration` will be truncated to the nearest second.
 

.google.protobuf.Duration lease_duration = 3 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getLeaseDurationOrBuilder in interface LeaseTasksRequestOrBuilder

getResponseViewValue

public int getResponseViewValue()

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

.google.cloud.tasks.v2beta2.Task.View response_view = 4;

Specified by:

getResponseViewValue in interface LeaseTasksRequestOrBuilder

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

.google.cloud.tasks.v2beta2.Task.View response_view = 4;

Specified by:

getResponseView in interface LeaseTasksRequestOrBuilder

Returns:

The responseView.

getFilter

public String getFilter()

 `filter` can be used to specify a subset of tasks to lease.
 When `filter` is set to `tag=<my-tag>` then the
 [response][google.cloud.tasks.v2beta2.LeaseTasksResponse] will contain only tasks whose
 [tag][google.cloud.tasks.v2beta2.PullMessage.tag] is equal to `<my-tag>`. `<my-tag>` must be
 less than 500 characters.
 When `filter` is set to `tag_function=oldest_tag()`, only tasks which have
 the same tag as the task with the oldest
 [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] will be returned.
 Grammar Syntax:
 * `filter = "tag=" tag | "tag_function=" function`
 * `tag = string`
 * `function = "oldest_tag()"`
 The `oldest_tag()` function returns tasks which have the same tag as the
 oldest task (ordered by schedule time).
 SDK compatibility: Although the SDK allows tags to be either
 string or
 [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
 only UTF-8 encoded tags can be used in Cloud Tasks. Tag which
 aren't UTF-8 encoded can't be used in the
 [filter][google.cloud.tasks.v2beta2.LeaseTasksRequest.filter] and the task's
 [tag][google.cloud.tasks.v2beta2.PullMessage.tag] will be displayed as empty in Cloud Tasks.
 

string filter = 5;

Specified by:

getFilter in interface LeaseTasksRequestOrBuilder

Returns:

The filter.

getFilterBytes

public ByteString getFilterBytes()

 `filter` can be used to specify a subset of tasks to lease.
 When `filter` is set to `tag=<my-tag>` then the
 [response][google.cloud.tasks.v2beta2.LeaseTasksResponse] will contain only tasks whose
 [tag][google.cloud.tasks.v2beta2.PullMessage.tag] is equal to `<my-tag>`. `<my-tag>` must be
 less than 500 characters.
 When `filter` is set to `tag_function=oldest_tag()`, only tasks which have
 the same tag as the task with the oldest
 [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] will be returned.
 Grammar Syntax:
 * `filter = "tag=" tag | "tag_function=" function`
 * `tag = string`
 * `function = "oldest_tag()"`
 The `oldest_tag()` function returns tasks which have the same tag as the
 oldest task (ordered by schedule time).
 SDK compatibility: Although the SDK allows tags to be either
 string or
 [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
 only UTF-8 encoded tags can be used in Cloud Tasks. Tag which
 aren't UTF-8 encoded can't be used in the
 [filter][google.cloud.tasks.v2beta2.LeaseTasksRequest.filter] and the task's
 [tag][google.cloud.tasks.v2beta2.PullMessage.tag] will be displayed as empty in Cloud Tasks.
 

string filter = 5;

Specified by:

getFilterBytes in interface LeaseTasksRequestOrBuilder

Returns:

The bytes for filter.

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 LeaseTasksRequest parseFrom(ByteBuffer data)
                                   throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

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

Throws:

InvalidProtocolBufferException

parseFrom

public static LeaseTasksRequest parseFrom(ByteString data)
                                   throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

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

Throws:

InvalidProtocolBufferException

parseFrom

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

Throws:

InvalidProtocolBufferException

parseFrom

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

Throws:

InvalidProtocolBufferException

parseFrom

public static LeaseTasksRequest parseFrom(InputStream input)
                                   throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static LeaseTasksRequest parseDelimitedFrom(InputStream input)
                                            throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static LeaseTasksRequest parseFrom(CodedInputStream input)
                                   throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public LeaseTasksRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static LeaseTasksRequest.Builder newBuilder()

newBuilder

public static LeaseTasksRequest.Builder newBuilder(LeaseTasksRequest prototype)

toBuilder

public LeaseTasksRequest.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected LeaseTasksRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static LeaseTasksRequest getDefaultInstance()

parser

public static Parser<LeaseTasksRequest> parser()

getParserForType

public Parser<LeaseTasksRequest> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public LeaseTasksRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder