Package com.google.cloud.tasks.v2

Class CreateTaskRequest

  • All Implemented Interfaces:
    CreateTaskRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class CreateTaskRequest
extends com.google.protobuf.GeneratedMessageV3
implements CreateTaskRequestOrBuilder
     Request message for
 [CreateTask][google.cloud.tasks.v2.CloudTasks.CreateTask].
    Protobuf type google.cloud.tasks.v2.CreateTaskRequest
    See Also:
    Serialized Form

    • Nested Class Summary

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

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int PARENT_FIELD_NUMBER  
      static int RESPONSE_VIEW_FIELD_NUMBER  
      static int TASK_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • 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.v2.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.v2.Task.name].

 If [schedule_time][google.cloud.tasks.v2.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 executed 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 ~1hour after the original task was
 deleted or executed. 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 ~9days after the original task was deleted or executed.

 Because there is an extra lookup cost to identify duplicate task
 names, these [CreateTask][google.cloud.tasks.v2.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.v2.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.v2.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.v2.Task.name].

 If [schedule_time][google.cloud.tasks.v2.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 executed 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 ~1hour after the original task was
 deleted or executed. 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 ~9days after the original task was deleted or executed.

 Because there is an extra lookup cost to identify duplicate task
 names, these [CreateTask][google.cloud.tasks.v2.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.v2.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.v2.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.v2.Task.name].

 If [schedule_time][google.cloud.tasks.v2.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 executed 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 ~1hour after the original task was
 deleted or executed. 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 ~9days after the original task was deleted or executed.

 Because there is an extra lookup cost to identify duplicate task
 names, these [CreateTask][google.cloud.tasks.v2.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.v2.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.v2.Task] will be returned.

 By default response_view is [BASIC][google.cloud.tasks.v2.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.v2.Task.View.FULL] requires
 `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
 permission on the [Task][google.cloud.tasks.v2.Task] resource.
        .google.cloud.tasks.v2.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.v2.Task] will be returned.

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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​(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

      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • 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.GeneratedMessageV3

      • getDefaultInstanceForType

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