Package com.google.cloud.tasks.v2beta2

Interface RenewLeaseRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
RenewLeaseRequest, RenewLeaseRequest.Builder
@Generated public interface RenewLeaseRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.Duration
    getLeaseDuration()
    Required.
    com.google.protobuf.DurationOrBuilder
    getLeaseDurationOrBuilder()
    Required.
    String
    getName()
    Required.
    com.google.protobuf.ByteString
    getNameBytes()
    Required.
    Task.View
    getResponseView()
    The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be returned.
    int
    getResponseViewValue()
    The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be returned.
    com.google.protobuf.Timestamp
    getScheduleTime()
    Required.
    com.google.protobuf.TimestampOrBuilder
    getScheduleTimeOrBuilder()
    Required.
    boolean
    hasLeaseDuration()
    Required.
    boolean
    hasScheduleTime()
    Required.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getName

      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:
      The name.

    • getNameBytes

      com.google.protobuf.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:
      The bytes for name.

    • hasScheduleTime

      boolean hasScheduleTime()
       Required. The task's current schedule time, available in the
 [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] returned by
 [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] response or
 [RenewLease][google.cloud.tasks.v2beta2.CloudTasks.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:
      Whether the scheduleTime field is set.

    • getScheduleTime

      com.google.protobuf.Timestamp getScheduleTime()
       Required. The task's current schedule time, available in the
 [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] returned by
 [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] response or
 [RenewLease][google.cloud.tasks.v2beta2.CloudTasks.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:
      The scheduleTime.

    • getScheduleTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getScheduleTimeOrBuilder()
       Required. The task's current schedule time, available in the
 [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] returned by
 [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] response or
 [RenewLease][google.cloud.tasks.v2beta2.CloudTasks.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];

    • hasLeaseDuration

      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:
      Whether the leaseDuration field is set.

    • getLeaseDuration

      com.google.protobuf.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:
      The leaseDuration.

    • getLeaseDurationOrBuilder

      com.google.protobuf.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];

    • getResponseViewValue

      int getResponseViewValue()
       The response_view specifies which subset of the
 [Task][google.cloud.tasks.v2beta2.Task] will be returned.

 By default response_view is
 [BASIC][google.cloud.tasks.v2beta2.Task.View.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][google.cloud.tasks.v2beta2.Task.View.FULL]
 requires `cloudtasks.tasks.fullView` [Google
 IAM](https://cloud.google.com/iam/) permission on the
 [Task][google.cloud.tasks.v2beta2.Task] resource.
      .google.cloud.tasks.v2beta2.Task.View response_view = 4;
      Returns:
      The enum numeric value on the wire for responseView.

    • getResponseView

      Task.View getResponseView()
       The response_view specifies which subset of the
 [Task][google.cloud.tasks.v2beta2.Task] will be returned.

 By default response_view is
 [BASIC][google.cloud.tasks.v2beta2.Task.View.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][google.cloud.tasks.v2beta2.Task.View.FULL]
 requires `cloudtasks.tasks.fullView` [Google
 IAM](https://cloud.google.com/iam/) permission on the
 [Task][google.cloud.tasks.v2beta2.Task] resource.
      .google.cloud.tasks.v2beta2.Task.View response_view = 4;
      Returns:
      The responseView.