public final class RenewLeaseRequest extends GeneratedMessageV3 implements RenewLeaseRequestOrBuilder
Request message for renewing a lease using
RenewLease.
Protobuf type google.cloud.tasks.v2beta2.RenewLeaseRequest
Static Fields
LEASE_DURATION_FIELD_NUMBER
public static final int LEASE_DURATION_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
RESPONSE_VIEW_FIELD_NUMBER
public static final int RESPONSE_VIEW_FIELD_NUMBER
Field Value
SCHEDULE_TIME_FIELD_NUMBER
public static final int SCHEDULE_TIME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static RenewLeaseRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static RenewLeaseRequest.Builder newBuilder()
Returns
newBuilder(RenewLeaseRequest prototype)
public static RenewLeaseRequest.Builder newBuilder(RenewLeaseRequest prototype)
Parameter
Returns
public static RenewLeaseRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static RenewLeaseRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static RenewLeaseRequest parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RenewLeaseRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static RenewLeaseRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RenewLeaseRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RenewLeaseRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static RenewLeaseRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RenewLeaseRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static RenewLeaseRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static RenewLeaseRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RenewLeaseRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<RenewLeaseRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public RenewLeaseRequest getDefaultInstanceForType()
Returns
getLeaseDuration()
public Duration getLeaseDuration()
Required. The desired new lease duration, starting from now.
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.
|
getLeaseDurationOrBuilder()
public DurationOrBuilder getLeaseDurationOrBuilder()
Required. The desired new lease duration, starting from now.
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
getName()
Required. The task name. For example:
projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns
Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Required. The task name. For example:
projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns
getParserForType()
public Parser<RenewLeaseRequest> 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;
Returns
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.
|
getScheduleTime()
public Timestamp getScheduleTime()
Required. The task's current schedule time, available in the
schedule_time returned by
LeaseTasks response or
RenewLease response. This restriction is
to ensure that your worker currently holds the lease.
.google.protobuf.Timestamp schedule_time = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
getScheduleTimeOrBuilder()
public TimestampOrBuilder getScheduleTimeOrBuilder()
Required. The task's current schedule time, available in the
schedule_time returned by
LeaseTasks response or
RenewLease response. This restriction is
to ensure that your worker currently holds the lease.
.google.protobuf.Timestamp schedule_time = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasLeaseDuration()
public boolean hasLeaseDuration()
Required. The desired new lease duration, starting from now.
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.
|
hasScheduleTime()
public boolean hasScheduleTime()
Required. The task's current schedule time, available in the
schedule_time returned by
LeaseTasks response or
RenewLease response. This restriction is
to ensure that your worker currently holds the lease.
.google.protobuf.Timestamp schedule_time = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
Type | Description |
boolean | Whether the scheduleTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public RenewLeaseRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RenewLeaseRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public RenewLeaseRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions