com.google.cloud.tasks.v2beta2

Interface LeaseTasksRequestOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

LeaseTasksRequest, LeaseTasksRequest.Builder

public interface LeaseTasksRequestOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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.
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.
boolean	hasLeaseDuration() Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParent

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:

The parent.

getParentBytes

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:

The bytes for parent.

getMaxTasks

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;

Returns:

The maxTasks.

hasLeaseDuration

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];

Returns:

Whether the leaseDuration field is set.

getLeaseDuration

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];

Returns:

The leaseDuration.

getLeaseDurationOrBuilder

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];

getResponseViewValue

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;

Returns:

The enum numeric value on the wire for responseView.

getResponseView

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;

Returns:

The responseView.

getFilter

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;

Returns:

The filter.

getFilterBytes

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;

Returns:

The bytes for filter.