Class RenewLeaseRequest.Builder (2.32.0)

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RenewLeaseRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
RenewLeaseRequest.Builder
Overrides

build()

public RenewLeaseRequest build()
Returns
TypeDescription
RenewLeaseRequest

buildPartial()

public RenewLeaseRequest buildPartial()
Returns
TypeDescription
RenewLeaseRequest

clear()

public RenewLeaseRequest.Builder clear()
Returns
TypeDescription
RenewLeaseRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public RenewLeaseRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
RenewLeaseRequest.Builder
Overrides

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
TypeDescription
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
TypeDescription
RenewLeaseRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public RenewLeaseRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
RenewLeaseRequest.Builder
Overrides

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
TypeDescription
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
TypeDescription
RenewLeaseRequest.Builder

clone()

public RenewLeaseRequest.Builder clone()
Returns
TypeDescription
RenewLeaseRequest.Builder
Overrides

getDefaultInstanceForType()

public RenewLeaseRequest getDefaultInstanceForType()
Returns
TypeDescription
RenewLeaseRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the scheduleTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(RenewLeaseRequest other)

public RenewLeaseRequest.Builder mergeFrom(RenewLeaseRequest other)
Parameter
NameDescription
otherRenewLeaseRequest
Returns
TypeDescription
RenewLeaseRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RenewLeaseRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RenewLeaseRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public RenewLeaseRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
RenewLeaseRequest.Builder
Overrides

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
NameDescription
valueDuration
Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
RenewLeaseRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RenewLeaseRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
RenewLeaseRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public RenewLeaseRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
RenewLeaseRequest.Builder
Overrides

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
NameDescription
valueDuration
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
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
NameDescription
valueString

The name to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
RenewLeaseRequest.Builder
Overrides

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
NameDescription
valueTask.View

The responseView to set.

Returns
TypeDescription
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
NameDescription
valueint

The enum numeric value on the wire for responseView to set.

Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
RenewLeaseRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final RenewLeaseRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
RenewLeaseRequest.Builder
Overrides