ProjectsLocationsQueuesResourceApi class

Constructors

ProjectsLocationsQueuesResourceApi(ApiRequester client)

Properties

hashCode int
The hash code for this object. [...]
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
tasks ProjectsLocationsQueuesTasksResourceApi
read-only

Methods

create(Queue request, String parent, {String $fields}) Future<Queue>
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. [...]
delete(String name, {String $fields}) Future<Empty>
Deletes a queue. This command will delete the queue even if it has tasks in it. Note: If you delete a queue, a queue with the same name can't be created for 7 days. 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. [...]
get(String name, {String $fields}) Future<Queue>
Gets a queue. [...]
getIamPolicy(GetIamPolicyRequest request, String resource, {String $fields}) Future<Policy>
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 [...]
list(String parent, {String pageToken, int pageSize, String filter, String $fields}) Future<ListQueuesResponse>
Lists queues. Queues are returned in lexicographical order. [...]
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
patch(Queue request, String name, {String updateMask, String $fields}) Future<Queue>
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. [...]
pause(PauseQueueRequest request, String name, {String $fields}) Future<Queue>
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. [...]
purge(PurgeQueueRequest request, String name, {String $fields}) Future<Queue>
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. [...]
resume(ResumeQueueRequest request, String name, {String $fields}) Future<Queue>
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. [...]
setIamPolicy(SetIamPolicyRequest request, String resource, {String $fields}) Future<Policy>
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 [...]
testIamPermissions(TestIamPermissionsRequest request, String resource, {String $fields}) Future<TestIamPermissionsResponse>
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. [...]
toString() String
Returns a string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator. [...]
inherited