Class RenewLeaseRequest.Builder (2.34.0)

publicstaticfinalclass RenewLeaseRequest.BuilderextendsGeneratedMessageV3.Builder<RenewLeaseRequest.Builder>implementsRenewLeaseRequestOrBuilder

Request message for renewing a lease using RenewLease.

Protobuf type google.cloud.tasks.v2beta2.RenewLeaseRequest

Inherited Members

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
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()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

publicRenewLeaseRequest.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RenewLeaseRequest.Builder
Overrides

build()

publicRenewLeaseRequestbuild()
Returns
Type Description
RenewLeaseRequest

buildPartial()

publicRenewLeaseRequestbuildPartial()
Returns
Type Description
RenewLeaseRequest

clear()

publicRenewLeaseRequest.Builderclear()
Returns
Type Description
RenewLeaseRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

publicRenewLeaseRequest.BuilderclearField(Descriptors.FieldDescriptorfield)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RenewLeaseRequest.Builder
Overrides

clearLeaseDuration()

publicRenewLeaseRequest.BuilderclearLeaseDuration()

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

publicRenewLeaseRequest.BuilderclearName()

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)

publicRenewLeaseRequest.BuilderclearOneof(Descriptors.OneofDescriptoroneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RenewLeaseRequest.Builder
Overrides

clearResponseView()

publicRenewLeaseRequest.BuilderclearResponseView()

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

publicRenewLeaseRequest.BuilderclearScheduleTime()

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

publicRenewLeaseRequest.Builderclone()
Returns
Type Description
RenewLeaseRequest.Builder
Overrides

getDefaultInstanceForType()

publicRenewLeaseRequestgetDefaultInstanceForType()
Returns
Type Description
RenewLeaseRequest

getDescriptorForType()

publicDescriptors.DescriptorgetDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getLeaseDuration()

publicDurationgetLeaseDuration()

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

publicDuration.BuildergetLeaseDurationBuilder()

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

publicDurationOrBuildergetLeaseDurationOrBuilder()

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

publicStringgetName()

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

publicByteStringgetNameBytes()

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

publicTask.ViewgetResponseView()

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

publicintgetResponseViewValue()

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

publicTimestampgetScheduleTime()

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

publicTimestamp.BuildergetScheduleTimeBuilder()

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

publicTimestampOrBuildergetScheduleTimeOrBuilder()

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

publicbooleanhasLeaseDuration()

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

publicbooleanhasScheduleTime()

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

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(RenewLeaseRequest other)

publicRenewLeaseRequest.BuildermergeFrom(RenewLeaseRequestother)
Parameter
Name Description
other RenewLeaseRequest
Returns
Type Description
RenewLeaseRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicRenewLeaseRequest.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RenewLeaseRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

publicRenewLeaseRequest.BuildermergeFrom(Messageother)
Parameter
Name Description
other Message
Returns
Type Description
RenewLeaseRequest.Builder
Overrides

mergeLeaseDuration(Duration value)

publicRenewLeaseRequest.BuildermergeLeaseDuration(Durationvalue)

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)

publicRenewLeaseRequest.BuildermergeScheduleTime(Timestampvalue)

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)

publicfinalRenewLeaseRequest.BuildermergeUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RenewLeaseRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

publicRenewLeaseRequest.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RenewLeaseRequest.Builder
Overrides

setLeaseDuration(Duration value)

publicRenewLeaseRequest.BuildersetLeaseDuration(Durationvalue)

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)

publicRenewLeaseRequest.BuildersetLeaseDuration(Duration.BuilderbuilderForValue)

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)

publicRenewLeaseRequest.BuildersetName(Stringvalue)

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)

publicRenewLeaseRequest.BuildersetNameBytes(ByteStringvalue)

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)

publicRenewLeaseRequest.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RenewLeaseRequest.Builder
Overrides

setResponseView(Task.View value)

publicRenewLeaseRequest.BuildersetResponseView(Task.Viewvalue)

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)

publicRenewLeaseRequest.BuildersetResponseViewValue(intvalue)

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)

publicRenewLeaseRequest.BuildersetScheduleTime(Timestampvalue)

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)

publicRenewLeaseRequest.BuildersetScheduleTime(Timestamp.BuilderbuilderForValue)

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)

publicfinalRenewLeaseRequest.BuildersetUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RenewLeaseRequest.Builder
Overrides

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.