Class CancelLeaseRequest (2.44.0)

public final class CancelLeaseRequest extends GeneratedMessageV3 implements CancelLeaseRequestOrBuilder

Request message for canceling a lease using CancelLease.

Protobuf type google.cloud.tasks.v2beta2.CancelLeaseRequest

Static Fields

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

RESPONSE_VIEW_FIELD_NUMBER

public static final int RESPONSE_VIEW_FIELD_NUMBER
Field Value
Type Description
int

SCHEDULE_TIME_FIELD_NUMBER

public static final int SCHEDULE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CancelLeaseRequest getDefaultInstance()
Returns
Type Description
CancelLeaseRequest

getDescriptor()

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

newBuilder()

public static CancelLeaseRequest.Builder newBuilder()
Returns
Type Description
CancelLeaseRequest.Builder

newBuilder(CancelLeaseRequest prototype)

public static CancelLeaseRequest.Builder newBuilder(CancelLeaseRequest prototype)
Parameter
Name Description
prototype CancelLeaseRequest
Returns
Type Description
CancelLeaseRequest.Builder

parseDelimitedFrom(InputStream input)

public static CancelLeaseRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CancelLeaseRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CancelLeaseRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CancelLeaseRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CancelLeaseRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CancelLeaseRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CancelLeaseRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CancelLeaseRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CancelLeaseRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CancelLeaseRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CancelLeaseRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CancelLeaseRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CancelLeaseRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CancelLeaseRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CancelLeaseRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CancelLeaseRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CancelLeaseRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CancelLeaseRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CancelLeaseRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CancelLeaseRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CancelLeaseRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CancelLeaseRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CancelLeaseRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CancelLeaseRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CancelLeaseRequest> parser()
Returns
Type Description
Parser<CancelLeaseRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public CancelLeaseRequest getDefaultInstanceForType()
Returns
Type Description
CancelLeaseRequest

getName()

public String 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
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<CancelLeaseRequest> getParserForType()
Returns
Type Description
Parser<CancelLeaseRequest>
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 = 3;

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 = 3;

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

The scheduleTime.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CancelLeaseRequest.Builder newBuilderForType()
Returns
Type Description
CancelLeaseRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CancelLeaseRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CancelLeaseRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CancelLeaseRequest.Builder toBuilder()
Returns
Type Description
CancelLeaseRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException