public final class LeaseTasksRequest extends GeneratedMessageV3 implements LeaseTasksRequestOrBuilder
Request message for leasing tasks using LeaseTasks.
Protobuf type google.cloud.tasks.v2beta2.LeaseTasksRequest
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
LEASE_DURATION_FIELD_NUMBER
public static final int LEASE_DURATION_FIELD_NUMBER
Field Value
MAX_TASKS_FIELD_NUMBER
public static final int MAX_TASKS_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 LeaseTasksRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static LeaseTasksRequest.Builder newBuilder()
Returns
newBuilder(LeaseTasksRequest prototype)
public static LeaseTasksRequest.Builder newBuilder(LeaseTasksRequest prototype)
Parameter
Returns
public static LeaseTasksRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static LeaseTasksRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static LeaseTasksRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static LeaseTasksRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static LeaseTasksRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static LeaseTasksRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static LeaseTasksRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static LeaseTasksRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static LeaseTasksRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static LeaseTasksRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static LeaseTasksRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static LeaseTasksRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<LeaseTasksRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public LeaseTasksRequest getDefaultInstanceForType()
Returns
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=" functiontag = stringfunction = "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;
| 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=" functiontag = stringfunction = "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;
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];
| Type | Description |
| Duration | The leaseDuration.
|
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];
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;
| 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) = { ... }
| 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<LeaseTasksRequest> 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.v2beta2.Task.View response_view = 4;
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;
| 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
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];
| Type | Description |
| boolean | Whether the leaseDuration field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public LeaseTasksRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected LeaseTasksRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public LeaseTasksRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
