- 2.55.0 (latest)
- 2.54.0
- 2.53.0
- 2.52.0
- 2.51.0
- 2.49.0
- 2.48.0
- 2.47.0
- 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 RenewLeaseRequest.Builder extends GeneratedMessageV3.Builder<RenewLeaseRequest.Builder> implements RenewLeaseRequestOrBuilder
Request message for renewing a lease using RenewLease.
Protobuf type google.cloud.tasks.v2beta2.RenewLeaseRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RenewLeaseRequest.BuilderImplements
RenewLeaseRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public RenewLeaseRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
RenewLeaseRequest.Builder |
build()
public RenewLeaseRequest build()
Returns | |
---|---|
Type | Description |
RenewLeaseRequest |
buildPartial()
public RenewLeaseRequest buildPartial()
Returns | |
---|---|
Type | Description |
RenewLeaseRequest |
clear()
public RenewLeaseRequest.Builder clear()
Returns | |
---|---|
Type | Description |
RenewLeaseRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public RenewLeaseRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
RenewLeaseRequest.Builder |
clearLeaseDuration()
public RenewLeaseRequest.Builder clearLeaseDuration()
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 |
RenewLeaseRequest.Builder |
clearName()
public RenewLeaseRequest.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 |
RenewLeaseRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public RenewLeaseRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
RenewLeaseRequest.Builder |
clearResponseView()
public RenewLeaseRequest.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 = 4;
Returns | |
---|---|
Type | Description |
RenewLeaseRequest.Builder |
This builder for chaining. |
clearScheduleTime()
public RenewLeaseRequest.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 |
RenewLeaseRequest.Builder |
clone()
public RenewLeaseRequest.Builder clone()
Returns | |
---|---|
Type | Description |
RenewLeaseRequest.Builder |
getDefaultInstanceForType()
public RenewLeaseRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
RenewLeaseRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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. |
getLeaseDurationBuilder()
public Duration.Builder getLeaseDurationBuilder()
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 |
Builder |
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 | |
---|---|
Type | Description |
DurationOrBuilder |
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 = 4;
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 = 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 | |
---|---|
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 |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(RenewLeaseRequest other)
public RenewLeaseRequest.Builder mergeFrom(RenewLeaseRequest other)
Parameter | |
---|---|
Name | Description |
other |
RenewLeaseRequest |
Returns | |
---|---|
Type | Description |
RenewLeaseRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public RenewLeaseRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
RenewLeaseRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public RenewLeaseRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
RenewLeaseRequest.Builder |
mergeLeaseDuration(Duration value)
public RenewLeaseRequest.Builder mergeLeaseDuration(Duration value)
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];
Parameter | |
---|---|
Name | Description |
value |
Duration |
Returns | |
---|---|
Type | Description |
RenewLeaseRequest.Builder |
mergeScheduleTime(Timestamp value)
public RenewLeaseRequest.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 |
RenewLeaseRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final RenewLeaseRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
RenewLeaseRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public RenewLeaseRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
RenewLeaseRequest.Builder |
setLeaseDuration(Duration value)
public RenewLeaseRequest.Builder setLeaseDuration(Duration value)
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];
Parameter | |
---|---|
Name | Description |
value |
Duration |
Returns | |
---|---|
Type | Description |
RenewLeaseRequest.Builder |
setLeaseDuration(Duration.Builder builderForValue)
public RenewLeaseRequest.Builder setLeaseDuration(Duration.Builder builderForValue)
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];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
RenewLeaseRequest.Builder |
setName(String value)
public RenewLeaseRequest.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 |
RenewLeaseRequest.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public RenewLeaseRequest.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 |
RenewLeaseRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public RenewLeaseRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
RenewLeaseRequest.Builder |
setResponseView(Task.View value)
public RenewLeaseRequest.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 = 4;
Parameter | |
---|---|
Name | Description |
value |
Task.View The responseView to set. |
Returns | |
---|---|
Type | Description |
RenewLeaseRequest.Builder |
This builder for chaining. |
setResponseViewValue(int value)
public RenewLeaseRequest.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 = 4;
Parameter | |
---|---|
Name | Description |
value |
int The enum numeric value on the wire for responseView to set. |
Returns | |
---|---|
Type | Description |
RenewLeaseRequest.Builder |
This builder for chaining. |
setScheduleTime(Timestamp value)
public RenewLeaseRequest.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 |
RenewLeaseRequest.Builder |
setScheduleTime(Timestamp.Builder builderForValue)
public RenewLeaseRequest.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 |
RenewLeaseRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final RenewLeaseRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
RenewLeaseRequest.Builder |