Class LeaseTasksRequest.Builder (2.53.0) 

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

Request message for leasing tasks using LeaseTasks.

Protobuf type google.cloud.tasks.v2beta2.LeaseTasksRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > LeaseTasksRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public LeaseTasksRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
LeaseTasksRequest.Builder
Overrides

build()

public LeaseTasksRequest build()
Returns
Type Description
LeaseTasksRequest

buildPartial()

public LeaseTasksRequest buildPartial()
Returns
Type Description
LeaseTasksRequest

clear()

public LeaseTasksRequest.Builder clear()
Returns
Type Description
LeaseTasksRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public LeaseTasksRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
LeaseTasksRequest.Builder
Overrides

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 will contain only tasks whose 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 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, 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 and the task's tag will be displayed as empty in Cloud Tasks.

string filter = 5;

Returns
Type Description
LeaseTasksRequest.Builder

This builder for chaining.

clearLeaseDuration()

public LeaseTasksRequest.Builder clearLeaseDuration()

Required. The duration of the lease.

Each task returned in the response will have its schedule_time set to the current time plus the lease_duration. The task is leased until its schedule_time; thus, the task will not be returned to another LeaseTasks call before its schedule_time.

After the worker has successfully finished the work associated with the task, the worker must call via AcknowledgeTask before the schedule_time. Otherwise the task will be returned to a later 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
Type Description
LeaseTasksRequest.Builder

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public LeaseTasksRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
LeaseTasksRequest.Builder
Overrides

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

This builder for chaining.

clearResponseView()

public LeaseTasksRequest.Builder clearResponseView()

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.v2beta2.Task.View response_view = 4;

Returns
Type Description
LeaseTasksRequest.Builder

This builder for chaining.

clone()

public LeaseTasksRequest.Builder clone()
Returns
Type Description
LeaseTasksRequest.Builder
Overrides

getDefaultInstanceForType()

public LeaseTasksRequest getDefaultInstanceForType()
Returns
Type Description
LeaseTasksRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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 will contain only tasks whose 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 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, 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 and the task's tag will be displayed as empty in Cloud Tasks.

string filter = 5;

Returns
Type Description
String

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 will contain only tasks whose 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 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, 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 and the task's tag will be displayed as empty in Cloud Tasks.

string filter = 5;

Returns
Type Description
ByteString

The bytes for filter.

getLeaseDuration()

public Duration getLeaseDuration()

Required. The duration of the lease.

Each task returned in the response will have its schedule_time set to the current time plus the lease_duration. The task is leased until its schedule_time; thus, the task will not be returned to another LeaseTasks call before its schedule_time.

After the worker has successfully finished the work associated with the task, the worker must call via AcknowledgeTask before the schedule_time. Otherwise the task will be returned to a later 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
Type Description
Duration

The leaseDuration.

getLeaseDurationBuilder()

public Duration.Builder getLeaseDurationBuilder()

Required. The duration of the lease.

Each task returned in the response will have its schedule_time set to the current time plus the lease_duration. The task is leased until its schedule_time; thus, the task will not be returned to another LeaseTasks call before its schedule_time.

After the worker has successfully finished the work associated with the task, the worker must call via AcknowledgeTask before the schedule_time. Otherwise the task will be returned to a later 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
Type Description
Builder

getLeaseDurationOrBuilder()

public DurationOrBuilder getLeaseDurationOrBuilder()

Required. The duration of the lease.

Each task returned in the response will have its schedule_time set to the current time plus the lease_duration. The task is leased until its schedule_time; thus, the task will not be returned to another LeaseTasks call before its schedule_time.

After the worker has successfully finished the work associated with the task, the worker must call via AcknowledgeTask before the schedule_time. Otherwise the task will be returned to a later 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
Type Description
DurationOrBuilder

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 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
Type Description
int

The maxTasks.

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) = { ... }

Returns
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) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

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.v2beta2.Task.View response_view = 4;

Returns
Type Description
Task.View

The responseView.

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.v2beta2.Task.View response_view = 4;

Returns
Type Description
int

The enum numeric value on the wire for responseView.

hasLeaseDuration()

public boolean hasLeaseDuration()

Required. The duration of the lease.

Each task returned in the response will have its schedule_time set to the current time plus the lease_duration. The task is leased until its schedule_time; thus, the task will not be returned to another LeaseTasks call before its schedule_time.

After the worker has successfully finished the work associated with the task, the worker must call via AcknowledgeTask before the schedule_time. Otherwise the task will be returned to a later 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
Type Description
boolean

Whether the leaseDuration field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(LeaseTasksRequest other)

public LeaseTasksRequest.Builder mergeFrom(LeaseTasksRequest other)
Parameter
Name Description
other LeaseTasksRequest
Returns
Type Description
LeaseTasksRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public LeaseTasksRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LeaseTasksRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public LeaseTasksRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
LeaseTasksRequest.Builder
Overrides

mergeLeaseDuration(Duration value)

public LeaseTasksRequest.Builder mergeLeaseDuration(Duration value)

Required. The duration of the lease.

Each task returned in the response will have its schedule_time set to the current time plus the lease_duration. The task is leased until its schedule_time; thus, the task will not be returned to another LeaseTasks call before its schedule_time.

After the worker has successfully finished the work associated with the task, the worker must call via AcknowledgeTask before the schedule_time. Otherwise the task will be returned to a later 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];

Parameter
Name Description
value Duration
Returns
Type Description
LeaseTasksRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final LeaseTasksRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
LeaseTasksRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public LeaseTasksRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
LeaseTasksRequest.Builder
Overrides

setFilter(String value)

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 will contain only tasks whose 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 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, 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 and the task's tag will be displayed as empty in Cloud Tasks.

string filter = 5;

Parameter
Name Description
value String

The filter to set.
Returns
Type Description
LeaseTasksRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public LeaseTasksRequest.Builder setFilterBytes(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 will contain only tasks whose 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 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, 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 and the task's tag will be displayed as empty in Cloud Tasks.

string filter = 5;

Parameter
Name Description
value ByteString

The bytes for filter to set.
Returns
Type Description
LeaseTasksRequest.Builder

This builder for chaining.

setLeaseDuration(Duration value)

public LeaseTasksRequest.Builder setLeaseDuration(Duration value)

Required. The duration of the lease.

Each task returned in the response will have its schedule_time set to the current time plus the lease_duration. The task is leased until its schedule_time; thus, the task will not be returned to another LeaseTasks call before its schedule_time.

After the worker has successfully finished the work associated with the task, the worker must call via AcknowledgeTask before the schedule_time. Otherwise the task will be returned to a later 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];

Parameter
Name Description
value Duration
Returns
Type Description
LeaseTasksRequest.Builder

setLeaseDuration(Duration.Builder builderForValue)

public LeaseTasksRequest.Builder setLeaseDuration(Duration.Builder builderForValue)

Required. The duration of the lease.

Each task returned in the response will have its schedule_time set to the current time plus the lease_duration. The task is leased until its schedule_time; thus, the task will not be returned to another LeaseTasks call before its schedule_time.

After the worker has successfully finished the work associated with the task, the worker must call via AcknowledgeTask before the schedule_time. Otherwise the task will be returned to a later 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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
LeaseTasksRequest.Builder

setMaxTasks(int value)

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 is 32 MB. If the sum of all task sizes requested reaches this limit, fewer tasks than requested are returned.

int32 max_tasks = 2;

Parameter
Name Description
value int

The maxTasks to set.
Returns
Type Description
LeaseTasksRequest.Builder

This builder for chaining.

setParent(String value)

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) = { ... }

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
LeaseTasksRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public LeaseTasksRequest.Builder setParentBytes(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) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.
Returns
Type Description
LeaseTasksRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public LeaseTasksRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
LeaseTasksRequest.Builder
Overrides

setResponseView(Task.View value)

public LeaseTasksRequest.Builder setResponseView(Task.View value)

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.v2beta2.Task.View response_view = 4;

Parameter
Name Description
value Task.View

The responseView to set.
Returns
Type Description
LeaseTasksRequest.Builder

This builder for chaining.

setResponseViewValue(int value)

public LeaseTasksRequest.Builder setResponseViewValue(int value)

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.v2beta2.Task.View response_view = 4;

Parameter
Name Description
value int

The enum numeric value on the wire for responseView to set.
Returns
Type Description
LeaseTasksRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final LeaseTasksRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
LeaseTasksRequest.Builder
Overrides