The 2.0 release of thegoogle-cloud-tasks client is a significant upgrade based on anext-gen code generator, and includes substantial interface changes. Existing code written for earlier versions of this library will likely require updates to use this version. This document describes the changes that have been made, and what you need to do to update your usage.

If you experience issues or have questions, please file anissue.

Supported Python Versions

WARNING: Breaking change

The 2.0.0 release requires Python 3.6+.

Method Calls

WARNING: Breaking change

Methods expect request objects. We provide a script that will convert most common use cases.

• Install the library withlibcst.

python3 -m pip install google-cloud-tasks[libcst]

• The scriptfixup_tasks_v2_keywords.py is shipped with the library. It expectsan input directory (with the code to convert) and an empty destination directory.

$ fixup_tasks_v2_keywords.py --input-directory .samples/ --output-directory samples/

Before:

from google.cloud importtasks_v2client =tasks_v2.CloudTasksClient()build = client.get_queue("queue_name")

After:

from google.cloud importtasks_v2client =tasks_v2.CloudTasksClient()build = client.get_queue(request={'name': "queue_name"})

More Details

Ingoogle-cloud-tasks<2.0.0, parameters required by the API were positional parameters and optional parameters were keyword parameters.

Before:

    def create_queue(        self,        parent,        queue,        retry=google.api_core.gapic_v1.method.DEFAULT,        timeout=google.api_core.gapic_v1.method.DEFAULT,        metadata=None,    ):

In the 2.0.0 release, all methods have a single positional parameterrequest. Method docstrings indicate whether a parameter is required or optional.

Some methods have additional keyword only parameters. The available parameters depend on thegoogle.api.method_signature annotation specified by the API producer.

After:

    def create_queue(        self,        request: cloudtasks.CreateQueueRequest = None,        *,        parent: str = None,        queue: gct_queue.Queue = None,        retry: retries.Retry = gapic_v1.method.DEFAULT,        timeout: float = None,        metadata: Sequence[Tuple[str, str]] = (),    ) -> gct_queue.Queue:

NOTE: Therequest parameter and flattened keyword parameters for the API are mutually exclusive.Passing both will result in an error.

Both of these calls are valid:

response = client.create_queue(    request={        "parent": parent,        "queue": queue,    })

response = client.create_queue(    parent=parent,    queue=queue,)

This call is invalid because it mixesrequest with a keyword argumentqueue. Executing this codewill result in an error.

response = client.create_queue(    request={        "parent": parent,    },    queue=queue)

Enums and Types

WARNING: Breaking change

The submodulesenums andtypes have been removed.

Before:

from google.cloud importtasks_v2http_method =tasks_v2.enums.HttpMethod.POSTqueue =tasks_v2.types.Queue(name="name")

After:

from google.cloud importtasks_v2http_method =tasks_v2.HttpMethod.POSTqueue =tasks_v2.Queue(name="name")

Location Path Helper Method

Location path helper method has been removed. Please constructthe path manually.

project = 'my-project'location = 'location'location_path = f'projects/{project}/locations/{location}'