com.google.cloud.tasks.v2beta2

Class LeaseTasksRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

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

com.google.cloud.tasks.v2beta2.LeaseTasksRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

LeaseTasksRequest

public static final class LeaseTasksRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<LeaseTasksRequest.Builder>
implements LeaseTasksRequestOrBuilder

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

Protobuf type google.cloud.tasks.v2beta2.LeaseTasksRequest

Method Summary

Modifier and Type	Method and Description
LeaseTasksRequest.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
LeaseTasksRequest	build()
LeaseTasksRequest	buildPartial()
LeaseTasksRequest.Builder	clear()
LeaseTasksRequest.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
LeaseTasksRequest.Builder	clearFilter() `filter` can be used to specify a subset of tasks to lease.
LeaseTasksRequest.Builder	clearLeaseDuration() Required.
LeaseTasksRequest.Builder	clearMaxTasks() The maximum number of tasks to lease.
LeaseTasksRequest.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
LeaseTasksRequest.Builder	clearParent() Required.
LeaseTasksRequest.Builder	clearResponseView() The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be returned.
LeaseTasksRequest.Builder	clone()
LeaseTasksRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getFilter() `filter` can be used to specify a subset of tasks to lease.
com.google.protobuf.ByteString	getFilterBytes() `filter` can be used to specify a subset of tasks to lease.
com.google.protobuf.Duration	getLeaseDuration() Required.
com.google.protobuf.Duration.Builder	getLeaseDurationBuilder() Required.
com.google.protobuf.DurationOrBuilder	getLeaseDurationOrBuilder() Required.
int	getMaxTasks() The maximum number of tasks to lease.
String	getParent() Required.
com.google.protobuf.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.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
LeaseTasksRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
LeaseTasksRequest.Builder	mergeFrom(LeaseTasksRequest other)
LeaseTasksRequest.Builder	mergeFrom(com.google.protobuf.Message other)
LeaseTasksRequest.Builder	mergeLeaseDuration(com.google.protobuf.Duration value) Required.
LeaseTasksRequest.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
LeaseTasksRequest.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
LeaseTasksRequest.Builder	setFilter(String value) `filter` can be used to specify a subset of tasks to lease.
LeaseTasksRequest.Builder	setFilterBytes(com.google.protobuf.ByteString value) `filter` can be used to specify a subset of tasks to lease.
LeaseTasksRequest.Builder	setLeaseDuration(com.google.protobuf.Duration.Builder builderForValue) Required.
LeaseTasksRequest.Builder	setLeaseDuration(com.google.protobuf.Duration value) Required.
LeaseTasksRequest.Builder	setMaxTasks(int value) The maximum number of tasks to lease.
LeaseTasksRequest.Builder	setParent(String value) Required.
LeaseTasksRequest.Builder	setParentBytes(com.google.protobuf.ByteString value) Required.
LeaseTasksRequest.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
LeaseTasksRequest.Builder	setResponseView(Task.View value) The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be returned.
LeaseTasksRequest.Builder	setResponseViewValue(int value) The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be returned.
LeaseTasksRequest.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, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

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

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

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

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, 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.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

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

clear

public LeaseTasksRequest.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<LeaseTasksRequest.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<LeaseTasksRequest.Builder>

getDefaultInstanceForType

public LeaseTasksRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public LeaseTasksRequest build()

Specified by:

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

Specified by:

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

buildPartial

public LeaseTasksRequest buildPartial()

Specified by:

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

Specified by:

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

clone

public LeaseTasksRequest.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<LeaseTasksRequest.Builder>

setField

public LeaseTasksRequest.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<LeaseTasksRequest.Builder>

clearField

public LeaseTasksRequest.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<LeaseTasksRequest.Builder>

clearOneof

public LeaseTasksRequest.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<LeaseTasksRequest.Builder>

setRepeatedField

public LeaseTasksRequest.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<LeaseTasksRequest.Builder>

addRepeatedField

public LeaseTasksRequest.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<LeaseTasksRequest.Builder>

mergeFrom

public LeaseTasksRequest.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<LeaseTasksRequest.Builder>

mergeFrom

public LeaseTasksRequest.Builder mergeFrom(LeaseTasksRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

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

mergeFrom

public LeaseTasksRequest.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<LeaseTasksRequest.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 LeaseTasksRequestOrBuilder

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 LeaseTasksRequestOrBuilder

Returns:

The bytes for parent.

setParent

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

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.

setMaxTasks

public LeaseTasksRequest.Builder setMaxTasks(int value)

 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;

Parameters:

value - The maxTasks to set.

Returns:

This builder for chaining.

clearMaxTasks

public LeaseTasksRequest.Builder clearMaxTasks()

 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:

This builder for chaining.

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 com.google.protobuf.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.

setLeaseDuration

public LeaseTasksRequest.Builder setLeaseDuration(com.google.protobuf.Duration value)

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

setLeaseDuration

public LeaseTasksRequest.Builder setLeaseDuration(com.google.protobuf.Duration.Builder builderForValue)

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

mergeLeaseDuration

public LeaseTasksRequest.Builder mergeLeaseDuration(com.google.protobuf.Duration value)

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

clearLeaseDuration

public LeaseTasksRequest.Builder clearLeaseDuration()

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

getLeaseDurationBuilder

public com.google.protobuf.Duration.Builder getLeaseDurationBuilder()

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

getLeaseDurationOrBuilder

public com.google.protobuf.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.

setResponseViewValue

public LeaseTasksRequest.Builder setResponseViewValue(int value)

 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;

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

setResponseView

public LeaseTasksRequest.Builder setResponseView(Task.View value)

 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;

Parameters:

value - The responseView to set.

Returns:

This builder for chaining.

clearResponseView

public LeaseTasksRequest.Builder clearResponseView()

 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:

This builder for chaining.

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 com.google.protobuf.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.

setFilter

public LeaseTasksRequest.Builder setFilter(String value)

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

Parameters:

value - The filter to set.

Returns:

This builder for chaining.

clearFilter

public LeaseTasksRequest.Builder clearFilter()

 `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:

This builder for chaining.

setFilterBytes

public LeaseTasksRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)

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

Parameters:

value - The bytes for filter to set.

Returns:

This builder for chaining.

setUnknownFields

public final LeaseTasksRequest.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<LeaseTasksRequest.Builder>

mergeUnknownFields

public final LeaseTasksRequest.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<LeaseTasksRequest.Builder>