public static final class CancelLeaseRequest.Builder extends GeneratedMessageV3.Builder<CancelLeaseRequest.Builder> implements CancelLeaseRequestOrBuilder
Request message for canceling a lease using
CancelLease.
Protobuf type google.cloud.tasks.v2beta2.CancelLeaseRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CancelLeaseRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public CancelLeaseRequest build()
buildPartial()
public CancelLeaseRequest buildPartial()
clear()
public CancelLeaseRequest.Builder clear()
Overrides
clearField(Descriptors.FieldDescriptor field)
public CancelLeaseRequest.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearName()
public CancelLeaseRequest.Builder clearName()
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) = { ... }
clearOneof(Descriptors.OneofDescriptor oneof)
public CancelLeaseRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clearResponseView()
public CancelLeaseRequest.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 = 3;
clearScheduleTime()
public CancelLeaseRequest.Builder clearScheduleTime()
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];
clone()
public CancelLeaseRequest.Builder clone()
Overrides
getDefaultInstanceForType()
public CancelLeaseRequest getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
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.
|
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.
|
getScheduleTimeBuilder()
public Timestamp.Builder getScheduleTimeBuilder()
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];
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];
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.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(CancelLeaseRequest other)
public CancelLeaseRequest.Builder mergeFrom(CancelLeaseRequest other)
public CancelLeaseRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public CancelLeaseRequest.Builder mergeFrom(Message other)
| Parameter |
|---|
| Name | Description |
other | Message
|
Overrides
mergeScheduleTime(Timestamp value)
public CancelLeaseRequest.Builder mergeScheduleTime(Timestamp value)
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];
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CancelLeaseRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public CancelLeaseRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setName(String value)
public CancelLeaseRequest.Builder setName(String value)
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) = { ... }
| Parameter |
|---|
| Name | Description |
value | String
The name to set.
|
setNameBytes(ByteString value)
public CancelLeaseRequest.Builder setNameBytes(ByteString value)
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) = { ... }
| Parameter |
|---|
| Name | Description |
value | ByteString
The bytes for name to set.
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CancelLeaseRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setResponseView(Task.View value)
public CancelLeaseRequest.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 = 3;
| Parameter |
|---|
| Name | Description |
value | Task.View
The responseView to set.
|
setResponseViewValue(int value)
public CancelLeaseRequest.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 = 3;
| Parameter |
|---|
| Name | Description |
value | int
The enum numeric value on the wire for responseView to set.
|
setScheduleTime(Timestamp value)
public CancelLeaseRequest.Builder setScheduleTime(Timestamp value)
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];
setScheduleTime(Timestamp.Builder builderForValue)
public CancelLeaseRequest.Builder setScheduleTime(Timestamp.Builder builderForValue)
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];
| Parameter |
|---|
| Name | Description |
builderForValue | Builder
|
setUnknownFields(UnknownFieldSet unknownFields)
public final CancelLeaseRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
