- 2.47.0 (latest)
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.12
- 2.2.0
- 2.1.11
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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CancelLeaseRequest.BuilderImplements
CancelLeaseRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CancelLeaseRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
CancelLeaseRequest.Builder |
build()
public CancelLeaseRequest build()
Returns | |
---|---|
Type | Description |
CancelLeaseRequest |
buildPartial()
public CancelLeaseRequest buildPartial()
Returns | |
---|---|
Type | Description |
CancelLeaseRequest |
clear()
public CancelLeaseRequest.Builder clear()
Returns | |
---|---|
Type | Description |
CancelLeaseRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public CancelLeaseRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
CancelLeaseRequest.Builder |
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) = { ... }
Returns | |
---|---|
Type | Description |
CancelLeaseRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public CancelLeaseRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
CancelLeaseRequest.Builder |
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;
Returns | |
---|---|
Type | Description |
CancelLeaseRequest.Builder | This builder for chaining. |
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];
Returns | |
---|---|
Type | Description |
CancelLeaseRequest.Builder |
clone()
public CancelLeaseRequest.Builder clone()
Returns | |
---|---|
Type | Description |
CancelLeaseRequest.Builder |
getDefaultInstanceForType()
public CancelLeaseRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
CancelLeaseRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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. |
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];
Returns | |
---|---|
Type | Description |
Builder |
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 |
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()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(CancelLeaseRequest other)
public CancelLeaseRequest.Builder mergeFrom(CancelLeaseRequest other)
Parameter | |
---|---|
Name | Description |
other | CancelLeaseRequest |
Returns | |
---|---|
Type | Description |
CancelLeaseRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CancelLeaseRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
CancelLeaseRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public CancelLeaseRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
CancelLeaseRequest.Builder |
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];
Parameter | |
---|---|
Name | Description |
value | Timestamp |
Returns | |
---|---|
Type | Description |
CancelLeaseRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CancelLeaseRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
CancelLeaseRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public CancelLeaseRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
CancelLeaseRequest.Builder |
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. |
Returns | |
---|---|
Type | Description |
CancelLeaseRequest.Builder | This builder for chaining. |
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. |
Returns | |
---|---|
Type | Description |
CancelLeaseRequest.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CancelLeaseRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Returns | |
---|---|
Type | Description |
CancelLeaseRequest.Builder |
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. |
Returns | |
---|---|
Type | Description |
CancelLeaseRequest.Builder | This builder for chaining. |
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. |
Returns | |
---|---|
Type | Description |
CancelLeaseRequest.Builder | This builder for chaining. |
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];
Parameter | |
---|---|
Name | Description |
value | Timestamp |
Returns | |
---|---|
Type | Description |
CancelLeaseRequest.Builder |
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 |
Returns | |
---|---|
Type | Description |
CancelLeaseRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final CancelLeaseRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
CancelLeaseRequest.Builder |