Package com.google.cloud.tasks.v2beta2

Class RenewLeaseRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.tasks.v2beta2.RenewLeaseRequest
All Implemented Interfaces:
RenewLeaseRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class RenewLeaseRequest extends com.google.protobuf.GeneratedMessage implements RenewLeaseRequestOrBuilder
 Request message for renewing a lease using
 [RenewLease][google.cloud.tasks.v2beta2.CloudTasks.RenewLease].
Protobuf type google.cloud.tasks.v2beta2.RenewLeaseRequest
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    RenewLeaseRequest.Builder
    Request message for renewing a lease using [RenewLease][google.cloud.tasks.v2beta2.CloudTasks.RenewLease].

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    LEASE_DURATION_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    RESPONSE_VIEW_FIELD_NUMBER
     
    static final int
    SCHEDULE_TIME_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static RenewLeaseRequest
    getDefaultInstance()
     
    RenewLeaseRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Duration
    getLeaseDuration()
    Required.
    com.google.protobuf.DurationOrBuilder
    getLeaseDurationOrBuilder()
    Required.
    String
    getName()
    Required.
    com.google.protobuf.ByteString
    getNameBytes()
    Required.
    com.google.protobuf.Parser<RenewLeaseRequest>
    getParserForType()
     
    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.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasLeaseDuration()
    Required.
    boolean
    hasScheduleTime()
    Required.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static RenewLeaseRequest.Builder
    newBuilder()
     
    static RenewLeaseRequest.Builder
    newBuilder(RenewLeaseRequest prototype)
     
    RenewLeaseRequest.Builder
    newBuilderForType()
     
    protected RenewLeaseRequest.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static RenewLeaseRequest
    parseDelimitedFrom(InputStream input)
     
    static RenewLeaseRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RenewLeaseRequest
    parseFrom(byte[] data)
     
    static RenewLeaseRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RenewLeaseRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static RenewLeaseRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RenewLeaseRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static RenewLeaseRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RenewLeaseRequest
    parseFrom(InputStream input)
     
    static RenewLeaseRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RenewLeaseRequest
    parseFrom(ByteBuffer data)
     
    static RenewLeaseRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<RenewLeaseRequest>
    parser()
     
    RenewLeaseRequest.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • SCHEDULE_TIME_FIELD_NUMBER

      public static final int SCHEDULE_TIME_FIELD_NUMBER
      See Also:

    • LEASE_DURATION_FIELD_NUMBER

      public static final int LEASE_DURATION_FIELD_NUMBER
      See Also:

    • RESPONSE_VIEW_FIELD_NUMBER

      public static final int RESPONSE_VIEW_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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) = { ... }
      Specified by:
      getName in interface RenewLeaseRequestOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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) = { ... }
      Specified by:
      getNameBytes in interface RenewLeaseRequestOrBuilder
      Returns:
      The bytes for name.

    • hasScheduleTime

      public 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];
      Specified by:
      hasScheduleTime in interface RenewLeaseRequestOrBuilder
      Returns:
      Whether the scheduleTime field is set.

    • getScheduleTime

      public 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];
      Specified by:
      getScheduleTime in interface RenewLeaseRequestOrBuilder
      Returns:
      The scheduleTime.

    • getScheduleTimeOrBuilder

      public 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];
      Specified by:
      getScheduleTimeOrBuilder in interface RenewLeaseRequestOrBuilder

    • 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];
      Specified by:
      hasLeaseDuration in interface RenewLeaseRequestOrBuilder
      Returns:
      Whether the leaseDuration field is set.

    • getLeaseDuration

      public 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];
      Specified by:
      getLeaseDuration in interface RenewLeaseRequestOrBuilder
      Returns:
      The leaseDuration.

    • getLeaseDurationOrBuilder

      public 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];
      Specified by:
      getLeaseDurationOrBuilder in interface RenewLeaseRequestOrBuilder

    • getResponseViewValue

      public 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;
      Specified by:
      getResponseViewValue in interface RenewLeaseRequestOrBuilder
      Returns:
      The enum numeric value on the wire for responseView.

    • getResponseView

      public 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;
      Specified by:
      getResponseView in interface RenewLeaseRequestOrBuilder
      Returns:
      The responseView.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static RenewLeaseRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RenewLeaseRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RenewLeaseRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RenewLeaseRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RenewLeaseRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RenewLeaseRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RenewLeaseRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RenewLeaseRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RenewLeaseRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RenewLeaseRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RenewLeaseRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RenewLeaseRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public RenewLeaseRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static RenewLeaseRequest.Builder newBuilder()

    • newBuilder

      public static RenewLeaseRequest.Builder newBuilder(RenewLeaseRequest prototype)

    • toBuilder

      public RenewLeaseRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected RenewLeaseRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static RenewLeaseRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<RenewLeaseRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<RenewLeaseRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public RenewLeaseRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder