Client for Cloud Tasks API#
-
class
google.cloud.tasks_v2.
CloudTasksClient
(transport=None, channel=None, credentials=None, client_config=None, client_info=None, client_options=None)[source]# Cloud Tasks allows developers to manage the execution of background work in their applications.
Constructor.
- Parameters
(Union[CloudTasksGrpcTransport, (transport) – Callable[[~.Credentials, type], ~.CloudTasksGrpcTransport]): A transport instance, responsible for actually making the API calls. The default transport uses the gRPC protocol. This argument may also be a callable which returns a transport instance. Callables will be sent the credentials as the first argument and the default transport class as the second argument.
channel (grpc.Channel) – DEPRECATED. A
Channel
instance through which to make calls. This argument is mutually exclusive withcredentials
; providing both will raise an exception.credentials (google.auth.credentials.Credentials) – The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment. This argument is mutually exclusive with providing a transport instance to
transport
; doing so will raise an exception.client_config (dict) – DEPRECATED. A dictionary of call options for each method. If not specified, the default configuration is used.
client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If
None
, then default info will be used. Generally, you only need to set this if you’re developing your own client library.client_options (Union[dict, google.api_core.client_options.ClientOptions]) – Client options used to set user options on the client. API Endpoint should be set through client_options.
-
create_queue
(parent, queue, retry=<object object>, timeout=<object object>, metadata=None)[source]# 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
orqueue.xml
file to manage your queues. Read Overview of Queue Management and queue.yaml before using this method.Example
>>> from google.cloud import tasks_v2 >>> >>> client = tasks_v2.CloudTasksClient() >>> >>> parent = client.location_path('[PROJECT]', '[LOCATION]') >>> >>> # TODO: Initialize `queue`: >>> queue = {} >>> >>> response = client.create_queue(parent, queue)
- Parameters
parent (str) –
Required.
The location name in which the queue will be created. For example:
projects/PROJECT_ID/locations/LOCATION_ID
The list of allowed locations can be obtained by calling Cloud Tasks’ implementation of
ListLocations
.Required.
The queue to create.
Queue's name
cannot be the same as an existing queue.If a dict is provided, it must be of the same form as the protobuf message
Queue
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will be retried using a default configuration.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Queue
instance.- Raises
google.api_core.exceptions.GoogleAPICallError – If the request failed for any reason.
google.api_core.exceptions.RetryError – If the request failed due to a retryable error and retry attempts failed.
ValueError – If the parameters are invalid.
-
create_task
(parent, task, response_view=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# 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.
Example
>>> from google.cloud import tasks_v2 >>> >>> client = tasks_v2.CloudTasksClient() >>> >>> parent = client.queue_path('[PROJECT]', '[LOCATION]', '[QUEUE]') >>> >>> # TODO: Initialize `task`: >>> task = {} >>> >>> response = client.create_task(parent, task)
- Parameters
parent (str) –
Required.
The queue name. For example:
projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID
The queue must already exist.
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 taskname
. 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 theresponse
.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.If a dict is provided, it must be of the same form as the protobuf message
Task
response_view (View) –
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
requirescloudtasks.tasks.fullView
Google IAM <https://cloud.google.com/iam/>`___ permission on the ``Task` resource.retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will be retried using a default configuration.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Task
instance.- Raises
google.api_core.exceptions.GoogleAPICallError – If the request failed for any reason.
google.api_core.exceptions.RetryError – If the request failed due to a retryable error and retry attempts failed.
ValueError – If the parameters are invalid.
-
delete_queue
(name, retry=<object object>, timeout=<object object>, metadata=None)[source]# 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
orqueue.xml
file to manage your queues. Read Overview of Queue Management and queue.yaml before using this method.Example
>>> from google.cloud import tasks_v2 >>> >>> client = tasks_v2.CloudTasksClient() >>> >>> name = client.queue_path('[PROJECT]', '[LOCATION]', '[QUEUE]') >>> >>> client.delete_queue(name)
- Parameters
name (str) –
Required.
The queue name. For example:
projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will be retried using a default configuration.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Raises
google.api_core.exceptions.GoogleAPICallError – If the request failed for any reason.
google.api_core.exceptions.RetryError – If the request failed due to a retryable error and retry attempts failed.
ValueError – If the parameters are invalid.
-
delete_task
(name, retry=<object object>, timeout=<object object>, metadata=None)[source]# 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.
Example
>>> from google.cloud import tasks_v2 >>> >>> client = tasks_v2.CloudTasksClient() >>> >>> name = client.task_path('[PROJECT]', '[LOCATION]', '[QUEUE]', '[TASK]') >>> >>> client.delete_task(name)
- Parameters
name (str) –
Required.
The task name. For example:
projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will be retried using a default configuration.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Raises
google.api_core.exceptions.GoogleAPICallError – If the request failed for any reason.
google.api_core.exceptions.RetryError – If the request failed due to a retryable error and retry attempts failed.
ValueError – If the parameters are invalid.
-
enums
= <module 'google.cloud.tasks_v2.gapic.enums' from '/usr/local/lib/python3.7/site-packages/google/cloud/tasks_v2/gapic/enums.py'>#
-
classmethod
from_service_account_file
(filename, *args, **kwargs)[source]# Creates an instance of this client using the provided credentials file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
-
classmethod
from_service_account_json
(filename, *args, **kwargs)# Creates an instance of this client using the provided credentials file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
-
get_iam_policy
(resource, options_=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# 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
Example
>>> from google.cloud import tasks_v2 >>> >>> client = tasks_v2.CloudTasksClient() >>> >>> resource = client.queue_path('[PROJECT]', '[LOCATION]', '[QUEUE]') >>> >>> response = client.get_iam_policy(resource)
- Parameters
resource (str) – REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
options_ (Union[dict, GetPolicyOptions]) –
OPTIONAL: A
GetPolicyOptions
object for specifying options toGetIamPolicy
. This field is only used by Cloud IAM.If a dict is provided, it must be of the same form as the protobuf message
GetPolicyOptions
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will be retried using a default configuration.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Policy
instance.- Raises
google.api_core.exceptions.GoogleAPICallError – If the request failed for any reason.
google.api_core.exceptions.RetryError – If the request failed due to a retryable error and retry attempts failed.
ValueError – If the parameters are invalid.
-
get_queue
(name, retry=<object object>, timeout=<object object>, metadata=None)[source]# Gets a queue.
Example
>>> from google.cloud import tasks_v2 >>> >>> client = tasks_v2.CloudTasksClient() >>> >>> name = client.queue_path('[PROJECT]', '[LOCATION]', '[QUEUE]') >>> >>> response = client.get_queue(name)
- Parameters
name (str) –
Required.
The resource name of the queue. For example:
projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will be retried using a default configuration.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Queue
instance.- Raises
google.api_core.exceptions.GoogleAPICallError – If the request failed for any reason.
google.api_core.exceptions.RetryError – If the request failed due to a retryable error and retry attempts failed.
ValueError – If the parameters are invalid.
-
get_task
(name, response_view=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# Gets a task.
Example
>>> from google.cloud import tasks_v2 >>> >>> client = tasks_v2.CloudTasksClient() >>> >>> name = client.task_path('[PROJECT]', '[LOCATION]', '[QUEUE]', '[TASK]') >>> >>> response = client.get_task(name)
- Parameters
name (str) –
Required.
The task name. For example:
projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID
response_view (View) –
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
requirescloudtasks.tasks.fullView
Google IAM <https://cloud.google.com/iam/>`___ permission on the ``Task` resource.retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will be retried using a default configuration.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Task
instance.- Raises
google.api_core.exceptions.GoogleAPICallError – If the request failed for any reason.
google.api_core.exceptions.RetryError – If the request failed due to a retryable error and retry attempts failed.
ValueError – If the parameters are invalid.
-
list_queues
(parent, filter_=None, page_size=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# Lists queues.
Queues are returned in lexicographical order.
Example
>>> from google.cloud import tasks_v2 >>> >>> client = tasks_v2.CloudTasksClient() >>> >>> parent = client.location_path('[PROJECT]', '[LOCATION]') >>> >>> # Iterate over all results >>> for element in client.list_queues(parent): ... # process element ... pass >>> >>> >>> # Alternatively: >>> >>> # Iterate over results one page at a time >>> for page in client.list_queues(parent).pages: ... for element in page: ... # process element ... pass
- Parameters
parent (str) –
Required.
The location name. For example:
projects/PROJECT_ID/locations/LOCATION_ID
filter_ (str) –
filter
can be used to specify a subset of queues. AnyQueue
field can be used as a filter and several operators as supported. For example:<=, <, >=, >, !=, =, :
. The filter syntax is the same as described in Stackdriver’s Advanced Logs Filters.Sample filter “state: PAUSED”.
Note that using filters might cause fewer queues than the requested page_size to be returned.
page_size (int) – The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will be retried using a default configuration.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
PageIterator
instance. An iterable ofQueue
instances. You can also iterate over the pages of the response using its pages property.- Raises
google.api_core.exceptions.GoogleAPICallError – If the request failed for any reason.
google.api_core.exceptions.RetryError – If the request failed due to a retryable error and retry attempts failed.
ValueError – If the parameters are invalid.
-
list_tasks
(parent, response_view=None, page_size=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# 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.
Example
>>> from google.cloud import tasks_v2 >>> >>> client = tasks_v2.CloudTasksClient() >>> >>> parent = client.queue_path('[PROJECT]', '[LOCATION]', '[QUEUE]') >>> >>> # Iterate over all results >>> for element in client.list_tasks(parent): ... # process element ... pass >>> >>> >>> # Alternatively: >>> >>> # Iterate over results one page at a time >>> for page in client.list_tasks(parent).pages: ... for element in page: ... # process element ... pass
- Parameters
parent (str) –
Required.
The queue name. For example:
projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID
response_view (View) –
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
requirescloudtasks.tasks.fullView
Google IAM <https://cloud.google.com/iam/>`___ permission on the ``Task` resource.page_size (int) – The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will be retried using a default configuration.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
PageIterator
instance. An iterable ofTask
instances. You can also iterate over the pages of the response using its pages property.- Raises
google.api_core.exceptions.GoogleAPICallError – If the request failed for any reason.
google.api_core.exceptions.RetryError – If the request failed due to a retryable error and retry attempts failed.
ValueError – If the parameters are invalid.
-
pause_queue
(name, retry=<object object>, timeout=<object object>, metadata=None)[source]# 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 itsstate
isPAUSED
.Example
>>> from google.cloud import tasks_v2 >>> >>> client = tasks_v2.CloudTasksClient() >>> >>> name = client.queue_path('[PROJECT]', '[LOCATION]', '[QUEUE]') >>> >>> response = client.pause_queue(name)
- Parameters
name (str) –
Required.
The queue name. For example:
projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will be retried using a default configuration.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Queue
instance.- Raises
google.api_core.exceptions.GoogleAPICallError – If the request failed for any reason.
google.api_core.exceptions.RetryError – If the request failed due to a retryable error and retry attempts failed.
ValueError – If the parameters are invalid.
-
purge_queue
(name, retry=<object object>, timeout=<object object>, metadata=None)[source]# 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.
Example
>>> from google.cloud import tasks_v2 >>> >>> client = tasks_v2.CloudTasksClient() >>> >>> name = client.queue_path('[PROJECT]', '[LOCATION]', '[QUEUE]') >>> >>> response = client.purge_queue(name)
- Parameters
name (str) –
Required.
The queue name. For example:
projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will be retried using a default configuration.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Queue
instance.- Raises
google.api_core.exceptions.GoogleAPICallError – If the request failed for any reason.
google.api_core.exceptions.RetryError – If the request failed due to a retryable error and retry attempts failed.
ValueError – If the parameters are invalid.
-
resume_queue
(name, retry=<object object>, timeout=<object object>, metadata=None)[source]# Resume a queue.
This method resumes a queue after it has been
PAUSED
orDISABLED
. The state of a queue is stored in the queue’sstate
; after calling this method it will be set toRUNNING
.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.
Example
>>> from google.cloud import tasks_v2 >>> >>> client = tasks_v2.CloudTasksClient() >>> >>> name = client.queue_path('[PROJECT]', '[LOCATION]', '[QUEUE]') >>> >>> response = client.resume_queue(name)
- Parameters
name (str) –
Required.
The queue name. For example:
projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will be retried using a default configuration.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Queue
instance.- Raises
google.api_core.exceptions.GoogleAPICallError – If the request failed for any reason.
google.api_core.exceptions.RetryError – If the request failed due to a retryable error and retry attempts failed.
ValueError – If the parameters are invalid.
-
run_task
(name, response_view=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# 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 isPAUSED
.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 thatRunTask
was called plus the retry delay specified in the queue’sRetryConfig
.RunTask
returnsNOT_FOUND
when it is called on a task that has already succeeded or permanently failed.Example
>>> from google.cloud import tasks_v2 >>> >>> client = tasks_v2.CloudTasksClient() >>> >>> name = client.task_path('[PROJECT]', '[LOCATION]', '[QUEUE]', '[TASK]') >>> >>> response = client.run_task(name)
- Parameters
name (str) –
Required.
The task name. For example:
projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID
response_view (View) –
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
requirescloudtasks.tasks.fullView
Google IAM <https://cloud.google.com/iam/>`___ permission on the ``Task` resource.retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will be retried using a default configuration.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Task
instance.- Raises
google.api_core.exceptions.GoogleAPICallError – If the request failed for any reason.
google.api_core.exceptions.RetryError – If the request failed due to a retryable error and retry attempts failed.
ValueError – If the parameters are invalid.
-
set_iam_policy
(resource, policy, retry=<object object>, timeout=<object object>, metadata=None)[source]# 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
Example
>>> from google.cloud import tasks_v2 >>> >>> client = tasks_v2.CloudTasksClient() >>> >>> resource = client.queue_path('[PROJECT]', '[LOCATION]', '[QUEUE]') >>> >>> # TODO: Initialize `policy`: >>> policy = {} >>> >>> response = client.set_iam_policy(resource, policy)
- Parameters
resource (str) – REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
policy (Union[dict, Policy]) –
REQUIRED: The complete policy to be applied to the
resource
. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.If a dict is provided, it must be of the same form as the protobuf message
Policy
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will be retried using a default configuration.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Policy
instance.- Raises
google.api_core.exceptions.GoogleAPICallError – If the request failed for any reason.
google.api_core.exceptions.RetryError – If the request failed due to a retryable error and retry attempts failed.
ValueError – If the parameters are invalid.
-
classmethod
task_path
(project, location, queue, task)[source]# Return a fully-qualified task string.
-
test_iam_permissions
(resource, permissions, retry=<object object>, timeout=<object object>, metadata=None)[source]# Returns permissions that a caller has on a
Queue
. If the resource does not exist, this will return an empty set of permissions, not aNOT_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.
Example
>>> from google.cloud import tasks_v2 >>> >>> client = tasks_v2.CloudTasksClient() >>> >>> resource = client.queue_path('[PROJECT]', '[LOCATION]', '[QUEUE]') >>> >>> # TODO: Initialize `permissions`: >>> permissions = [] >>> >>> response = client.test_iam_permissions(resource, permissions)
- Parameters
resource (str) – REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
permissions (list[str]) – The set of permissions to check for the
resource
. Permissions with wildcards (such as ‘*’ or ‘storage.*’) are not allowed. For more information see IAM Overview.retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will be retried using a default configuration.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
TestIamPermissionsResponse
instance.- Raises
google.api_core.exceptions.GoogleAPICallError – If the request failed for any reason.
google.api_core.exceptions.RetryError – If the request failed due to a retryable error and retry attempts failed.
ValueError – If the parameters are invalid.
-
update_queue
(queue, update_mask=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# 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
orqueue.xml
file to manage your queues. Read Overview of Queue Management and queue.yaml before using this method.Example
>>> from google.cloud import tasks_v2 >>> >>> client = tasks_v2.CloudTasksClient() >>> >>> # TODO: Initialize `queue`: >>> queue = {} >>> >>> response = client.update_queue(queue)
- Parameters
Required.
The queue to create or update.
The queue’s
name
must be specified.Output only fields cannot be modified using UpdateQueue. Any value specified for an output only field will be ignored. The queue’s
name
cannot be changed.If a dict is provided, it must be of the same form as the protobuf message
Queue
update_mask (Union[dict, FieldMask]) –
A mask used to specify which fields of the queue are being updated.
If empty, then all fields will be updated.
If a dict is provided, it must be of the same form as the protobuf message
FieldMask
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will be retried using a default configuration.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Queue
instance.- Raises
google.api_core.exceptions.GoogleAPICallError – If the request failed for any reason.
google.api_core.exceptions.RetryError – If the request failed due to a retryable error and retry attempts failed.
ValueError – If the parameters are invalid.