Package com.google.cloud.tasks.v2beta2

Class CreateTaskRequest

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    CreateTaskRequest.Builder
    Request message for [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask].

    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
    PARENT_FIELD_NUMBER
     
    static final int
    RESPONSE_VIEW_FIELD_NUMBER
     
    static final int
    TASK_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 CreateTaskRequest
    getDefaultInstance()
     
    CreateTaskRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.
    com.google.protobuf.Parser<CreateTaskRequest>
    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.
    int
    getSerializedSize()
     
    Task
    getTask()
    Required.
    TaskOrBuilder
    getTaskOrBuilder()
    Required.
    int
    hashCode()
     
    boolean
    hasTask()
    Required.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static CreateTaskRequest.Builder
    newBuilder()
     
    static CreateTaskRequest.Builder
    newBuilder(CreateTaskRequest prototype)
     
    CreateTaskRequest.Builder
    newBuilderForType()
     
    protected CreateTaskRequest.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static CreateTaskRequest
    parseDelimitedFrom(InputStream input)
     
    static CreateTaskRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CreateTaskRequest
    parseFrom(byte[] data)
     
    static CreateTaskRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CreateTaskRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static CreateTaskRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CreateTaskRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static CreateTaskRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CreateTaskRequest
    parseFrom(InputStream input)
     
    static CreateTaskRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CreateTaskRequest
    parseFrom(ByteBuffer data)
     
    static CreateTaskRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<CreateTaskRequest>
    parser()
     
    CreateTaskRequest.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

  • 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

    • getParent

      public String getParent()
       Required. The queue name. For example:
 `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`

 The queue must already exist.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParent in interface CreateTaskRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public com.google.protobuf.ByteString getParentBytes()
       Required. The queue name. For example:
 `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`

 The queue must already exist.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParentBytes in interface CreateTaskRequestOrBuilder
      Returns:
      The bytes for parent.

    • hasTask

      public boolean hasTask()
       Required. The task to add.

 Task names have the following format:
 `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.
 The user can optionally specify a task
 [name][google.cloud.tasks.v2beta2.Task.name]. If a name is not specified
 then the system will generate a random unique task id, which will be set in
 the task returned in the [response][google.cloud.tasks.v2beta2.Task.name].

 If [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] is not
 set or is in the past then Cloud Tasks will set it to the current time.

 Task De-duplication:

 Explicitly specifying a task ID enables task de-duplication.  If
 a task's ID is identical to that of an existing task or a task
 that was deleted or completed recently then the call will fail
 with [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS].
 If the task's queue was created using Cloud Tasks, then another task with
 the same name can't be created for ~1 hour after the original task was
 deleted or completed. If the task's queue was created using queue.yaml or
 queue.xml, then another task with the same name can't be created
 for ~9 days after the original task was deleted or completed.

 Because there is an extra lookup cost to identify duplicate task
 names, these [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask]
 calls have significantly increased latency. Using hashed strings for the
 task id or for the prefix of the task id is recommended. Choosing task ids
 that are sequential or have sequential prefixes, for example using a
 timestamp, causes an increase in latency and error rates in all
 task commands. The infrastructure relies on an approximately
 uniform distribution of task ids to store and serve tasks
 efficiently.
      .google.cloud.tasks.v2beta2.Task task = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasTask in interface CreateTaskRequestOrBuilder
      Returns:
      Whether the task field is set.

    • getTask

      public Task getTask()
       Required. The task to add.

 Task names have the following format:
 `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.
 The user can optionally specify a task
 [name][google.cloud.tasks.v2beta2.Task.name]. If a name is not specified
 then the system will generate a random unique task id, which will be set in
 the task returned in the [response][google.cloud.tasks.v2beta2.Task.name].

 If [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] is not
 set or is in the past then Cloud Tasks will set it to the current time.

 Task De-duplication:

 Explicitly specifying a task ID enables task de-duplication.  If
 a task's ID is identical to that of an existing task or a task
 that was deleted or completed recently then the call will fail
 with [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS].
 If the task's queue was created using Cloud Tasks, then another task with
 the same name can't be created for ~1 hour after the original task was
 deleted or completed. If the task's queue was created using queue.yaml or
 queue.xml, then another task with the same name can't be created
 for ~9 days after the original task was deleted or completed.

 Because there is an extra lookup cost to identify duplicate task
 names, these [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask]
 calls have significantly increased latency. Using hashed strings for the
 task id or for the prefix of the task id is recommended. Choosing task ids
 that are sequential or have sequential prefixes, for example using a
 timestamp, causes an increase in latency and error rates in all
 task commands. The infrastructure relies on an approximately
 uniform distribution of task ids to store and serve tasks
 efficiently.
      .google.cloud.tasks.v2beta2.Task task = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getTask in interface CreateTaskRequestOrBuilder
      Returns:
      The task.

    • getTaskOrBuilder

      public TaskOrBuilder getTaskOrBuilder()
       Required. The task to add.

 Task names have the following format:
 `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.
 The user can optionally specify a task
 [name][google.cloud.tasks.v2beta2.Task.name]. If a name is not specified
 then the system will generate a random unique task id, which will be set in
 the task returned in the [response][google.cloud.tasks.v2beta2.Task.name].

 If [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] is not
 set or is in the past then Cloud Tasks will set it to the current time.

 Task De-duplication:

 Explicitly specifying a task ID enables task de-duplication.  If
 a task's ID is identical to that of an existing task or a task
 that was deleted or completed recently then the call will fail
 with [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS].
 If the task's queue was created using Cloud Tasks, then another task with
 the same name can't be created for ~1 hour after the original task was
 deleted or completed. If the task's queue was created using queue.yaml or
 queue.xml, then another task with the same name can't be created
 for ~9 days after the original task was deleted or completed.

 Because there is an extra lookup cost to identify duplicate task
 names, these [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask]
 calls have significantly increased latency. Using hashed strings for the
 task id or for the prefix of the task id is recommended. Choosing task ids
 that are sequential or have sequential prefixes, for example using a
 timestamp, causes an increase in latency and error rates in all
 task commands. The infrastructure relies on an approximately
 uniform distribution of task ids to store and serve tasks
 efficiently.
      .google.cloud.tasks.v2beta2.Task task = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getTaskOrBuilder in interface CreateTaskRequestOrBuilder

    • 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 = 3;
      Specified by:
      getResponseViewValue in interface CreateTaskRequestOrBuilder
      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 = 3;
      Specified by:
      getResponseView in interface CreateTaskRequestOrBuilder
      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 CreateTaskRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static CreateTaskRequest.Builder newBuilder()

    • newBuilder

      public static CreateTaskRequest.Builder newBuilder(CreateTaskRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static CreateTaskRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<CreateTaskRequest> 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 CreateTaskRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder