public final class CreateTaskRequest extends GeneratedMessageV3 implements CreateTaskRequestOrBuilder
Request message for
CreateTask.
Protobuf type google.cloud.tasks.v2.CreateTaskRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RESPONSE_VIEW_FIELD_NUMBER
public static final int RESPONSE_VIEW_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TASK_FIELD_NUMBER
public static final int TASK_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static CreateTaskRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static CreateTaskRequest.Builder newBuilder()
newBuilder(CreateTaskRequest prototype)
public static CreateTaskRequest.Builder newBuilder(CreateTaskRequest prototype)
public static CreateTaskRequest parseDelimitedFrom(InputStream input)
public static CreateTaskRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static CreateTaskRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CreateTaskRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static CreateTaskRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CreateTaskRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CreateTaskRequest parseFrom(CodedInputStream input)
public static CreateTaskRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CreateTaskRequest parseFrom(InputStream input)
public static CreateTaskRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static CreateTaskRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CreateTaskRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<CreateTaskRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public CreateTaskRequest getDefaultInstanceForType()
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) = { ... }
| Returns |
| Type |
Description |
String |
The parent.
|
getParentBytes()
public 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) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for parent.
|
getParserForType()
public Parser<CreateTaskRequest> getParserForType()
Overrides
getResponseView()
public 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.v2.Task.View response_view = 3;
| Returns |
| Type |
Description |
Task.View |
The responseView.
|
getResponseViewValue()
public int getResponseViewValue()
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.v2.Task.View response_view = 3;
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for responseView.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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. 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.
If 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.
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
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];
| Returns |
| Type |
Description |
Task |
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. 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.
If 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.
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
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];
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. 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.
If 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.
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
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];
| Returns |
| Type |
Description |
boolean |
Whether the task field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public CreateTaskRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CreateTaskRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public CreateTaskRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
