Interface RenewLeaseRequestOrBuilder (2.41.0)

public interface RenewLeaseRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getLeaseDuration()

public abstract 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.

getLeaseDurationOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract int getResponseViewValue()

The response_view specifies which subset of the Task will be returned.

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 abstract 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.

getScheduleTimeOrBuilder()

public abstract TimestampOrBuilder getScheduleTimeOrBuilder()

.google.protobuf.Timestamp schedule_time = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`TimestampOrBuilder`

hasLeaseDuration()

public abstract 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 abstract boolean hasScheduleTime()

.google.protobuf.Timestamp schedule_time = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`boolean`	Whether the scheduleTime field is set.