public static final class CloudTasksGrpc.CloudTasksBlockingStub extends AbstractBlockingStub<CloudTasksGrpc.CloudTasksBlockingStub>
A stub to allow clients to do limited synchronous rpc calls to service CloudTasks.
Cloud Tasks allows developers to manage the execution of background
work in their applications.
Inheritance
java.lang.Object >
io.grpc.stub.AbstractStub >
io.grpc.stub.AbstractBlockingStub >
CloudTasksGrpc.CloudTasksBlockingStub
Inherited Members
io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)
io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.getCallOptions()
io.grpc.stub.AbstractStub.getChannel()
io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)
io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)
io.grpc.stub.AbstractStub.withCompression(java.lang.String)
io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)
io.grpc.stub.AbstractStub.withDeadlineAfter(java.time.Duration)
io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)
io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)
io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)
io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)
io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)
io.grpc.stub.AbstractStub.withOnReadyThreshold(int)
io.grpc.stub.AbstractStub.withWaitForReady()
Methods
batchCreateTasks(BatchCreateTasksRequest request)
public Operation batchCreateTasks(BatchCreateTasksRequest request)
Creates a batch of tasks and adds them to a queue.
This call is not atomic.
All tasks must be for the same queue.
A maximum of 100 tasks can be created in a single batch.
batchDeleteTasks(BatchDeleteTasksRequest request)
public Operation batchDeleteTasks(BatchDeleteTasksRequest request)
Deletes a batch of tasks.
This is a non-atomic operation: if deletion fails for some tasks, it
can still succeed for others. The metadata field of
google.longrunning.Operation contains details of failed deletions.
A maximum of 1000 tasks can be deleted in a batch.
build(Channel channel, CallOptions callOptions)
protected CloudTasksGrpc.CloudTasksBlockingStub build(Channel channel, CallOptions callOptions)
| Parameters |
| Name |
Description |
channel |
io.grpc.Channel
|
callOptions |
io.grpc.CallOptions
|
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
createQueue(CreateQueueRequest request)
public Queue createQueue(CreateQueueRequest request)
Creates a queue.
Queues created with this method allow tasks to live for a maximum of 31
days. After a task is 31 days old, the task will be deleted regardless of
whether it was dispatched or not.
WARNING: Using this method may have unintended side effects if you are
using an App Engine queue.yaml or queue.xml file to manage your queues.
Read
Overview of Queue Management and
queue.yaml before using
this method.
| Returns |
| Type |
Description |
Queue |
|
createTask(CreateTaskRequest request)
public Task createTask(CreateTaskRequest request)
Creates a task and adds it to a queue.
Tasks cannot be updated after creation; there is no UpdateTask command.
- The maximum task size is 100KB.
| Returns |
| Type |
Description |
Task |
|
deleteQueue(DeleteQueueRequest request)
public Empty deleteQueue(DeleteQueueRequest request)
Deletes a queue.
This command will delete the queue even if it has tasks in it.
Note : If you delete a queue, you may be prevented from creating a new
queue with the same name as the deleted queue for a tombstone window of up
to 3 days. During this window, the CreateQueue operation may appear to
recreate the queue, but this can be misleading. If you attempt to create
a queue with the same name as one that is in the tombstone window, run
GetQueue to confirm that the queue creation was successful. If GetQueue
returns 200 response code, your queue was successfully created with the
name of the previously deleted queue. Otherwise, your queue did not
successfully recreate.
WARNING: Using this method may have unintended side effects if you are
using an App Engine queue.yaml or queue.xml file to manage your queues.
Read
Overview of Queue Management and
queue.yaml before using
this method.
| Returns |
| Type |
Description |
Empty |
|
deleteTask(DeleteTaskRequest request)
public Empty deleteTask(DeleteTaskRequest request)
Deletes a task.
A task can be deleted if it is scheduled or dispatched. A task
cannot be deleted if it has executed successfully or permanently
failed.
| Returns |
| Type |
Description |
Empty |
|
getCmekConfig(GetCmekConfigRequest request)
public CmekConfig getCmekConfig(GetCmekConfigRequest request)
Gets the CMEK config.
Gets the Customer Managed Encryption Key configured with the Cloud Tasks
lcoation. By default there is no kms_key configured.
getIamPolicy(GetIamPolicyRequest request)
public Policy getIamPolicy(GetIamPolicyRequest request)
Gets the access control policy for a
Queue. Returns an empty policy if the
resource exists and does not have a policy set.
Authorization requires the following
Google IAM permission on the specified
resource parent:
cloudtasks.queues.getIamPolicy
| Parameter |
| Name |
Description |
request |
com.google.iam.v1.GetIamPolicyRequest
|
| Returns |
| Type |
Description |
com.google.iam.v1.Policy |
|
getQueue(GetQueueRequest request)
public Queue getQueue(GetQueueRequest request)
| Returns |
| Type |
Description |
Queue |
|
getTask(GetTaskRequest request)
public Task getTask(GetTaskRequest request)
Gets a task.
After a task is successfully executed or has exhausted its retry attempts,
the task is deleted. A GetTask request for a deleted task returns a
NOT_FOUND error.
| Returns |
| Type |
Description |
Task |
|
listQueues(ListQueuesRequest request)
public ListQueuesResponse listQueues(ListQueuesRequest request)
Lists queues.
Queues are returned in lexicographical order.
listTasks(ListTasksRequest request)
public ListTasksResponse listTasks(ListTasksRequest request)
Lists the tasks in a queue.
By default, only the BASIC
view is retrieved due to performance considerations;
response_view
controls the subset of information which is returned.
The tasks may be returned in any order. The ordering may change at any
time.
pauseQueue(PauseQueueRequest request)
public Queue pauseQueue(PauseQueueRequest request)
Pauses the queue.
If a queue is paused then the system will stop dispatching tasks
until the queue is resumed via
ResumeQueue. Tasks can
still be added when the queue is paused. A queue is paused if its
state is
PAUSED.
| Returns |
| Type |
Description |
Queue |
|
purgeQueue(PurgeQueueRequest request)
public Queue purgeQueue(PurgeQueueRequest request)
Purges a queue by deleting all of its tasks.
All tasks created before this method is called are permanently deleted.
Purge operations can take up to one minute to take effect. Tasks
might be dispatched before the purge takes effect. A purge is irreversible.
| Returns |
| Type |
Description |
Queue |
|
resumeQueue(ResumeQueueRequest request)
public Queue resumeQueue(ResumeQueueRequest request)
Resume a queue.
This method resumes a queue after it has been
PAUSED or
DISABLED. The state of a
queue is stored in the queue's
state; after calling this method
it will be set to
RUNNING.
WARNING: Resuming many high-QPS queues at the same time can
lead to target overloading. If you are resuming high-QPS
queues, follow the 500/50/5 pattern described in
Managing Cloud Tasks Scaling
Risks.
| Returns |
| Type |
Description |
Queue |
|
runTask(RunTaskRequest request)
public Task runTask(RunTaskRequest request)
Forces a task to run now.
When this method is called, Cloud Tasks will dispatch the task, even if
the task is already running, the queue has reached its
RateLimits or is
PAUSED.
This command is meant to be used for manual debugging. For
example, RunTask can be
used to retry a failed task after a fix has been made or to manually force
a task to be dispatched now.
The dispatched task is returned. That is, the task that is returned
contains the status after
the task is dispatched but before the task is received by its target.
If Cloud Tasks receives a successful response from the task's
target, then the task will be deleted; otherwise the task's
schedule_time will be
reset to the time that
RunTask was called plus
the retry delay specified in the queue's
RetryConfig.
RunTask returns
NOT_FOUND when it is called on a
task that has already succeeded or permanently failed.
| Returns |
| Type |
Description |
Task |
|
setIamPolicy(SetIamPolicyRequest request)
public Policy setIamPolicy(SetIamPolicyRequest request)
Sets the access control policy for a
Queue. Replaces any existing policy.
Note: The Cloud Console does not check queue-level IAM permissions yet.
Project-level permissions are required to use the Cloud Console.
Authorization requires the following
Google IAM permission on the specified
resource parent:
cloudtasks.queues.setIamPolicy
| Parameter |
| Name |
Description |
request |
com.google.iam.v1.SetIamPolicyRequest
|
| Returns |
| Type |
Description |
com.google.iam.v1.Policy |
|
testIamPermissions(TestIamPermissionsRequest request)
public TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)
Returns permissions that a caller has on a
Queue. If the resource does not exist,
this will return an empty set of permissions, not a
NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware
UIs and command-line tools, not for authorization checking. This operation
may "fail open" without warning.
| Parameter |
| Name |
Description |
request |
com.google.iam.v1.TestIamPermissionsRequest
|
| Returns |
| Type |
Description |
com.google.iam.v1.TestIamPermissionsResponse |
|
updateCmekConfig(UpdateCmekConfigRequest request)
public CmekConfig updateCmekConfig(UpdateCmekConfigRequest request)
Creates or Updates a CMEK config.
Updates the Customer Managed Encryption Key associated with the Cloud Tasks
location (Creates if the key does not already exist). All new tasks created
in the location will be encrypted at-rest with the KMS-key provided in the
config.
updateQueue(UpdateQueueRequest request)
public Queue updateQueue(UpdateQueueRequest request)
Updates a queue.
This method creates the queue if it does not exist and updates
the queue if it does exist.
Queues created with this method allow tasks to live for a maximum of 31
days. After a task is 31 days old, the task will be deleted regardless of
whether it was dispatched or not.
WARNING: Using this method may have unintended side effects if you are
using an App Engine queue.yaml or queue.xml file to manage your queues.
Read
Overview of Queue Management and
queue.yaml before using
this method.
| Returns |
| Type |
Description |
Queue |
|
