diff --git a/google/cloud/tasks_v2/services/cloud_tasks/async_client.py b/google/cloud/tasks_v2/services/cloud_tasks/async_client.py index 47d21df..4056b22 100644 --- a/google/cloud/tasks_v2/services/cloud_tasks/async_client.py +++ b/google/cloud/tasks_v2/services/cloud_tasks/async_client.py @@ -234,6 +234,7 @@ async def list_queues( metadata: Sequence[Tuple[str, str]] = (), ) -> pagers.ListQueuesAsyncPager: r"""Lists queues. + Queues are returned in lexicographical order. .. code-block:: python @@ -860,8 +861,10 @@ async def purge_queue( metadata: Sequence[Tuple[str, str]] = (), ) -> queue.Queue: r"""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. @@ -1245,8 +1248,8 @@ async def sample_get_iam_policy(): The request object. Request message for ``GetIamPolicy`` method. resource (:class:`str`): REQUIRED: The resource for which the - policy is being requested. - See the operation documentation for the + policy is being requested. See the + operation documentation for the appropriate value for this field. This corresponds to the ``resource`` field @@ -1401,8 +1404,8 @@ async def sample_set_iam_policy(): The request object. Request message for ``SetIamPolicy`` method. resource (:class:`str`): REQUIRED: The resource for which the - policy is being specified. - See the operation documentation for the + policy is being specified. See the + operation documentation for the appropriate value for this field. This corresponds to the ``resource`` field @@ -1545,8 +1548,8 @@ async def sample_test_iam_permissions(): The request object. Request message for ``TestIamPermissions`` method. resource (:class:`str`): REQUIRED: The resource for which the - policy detail is being requested. - See the operation documentation for the + policy detail is being requested. See + the operation documentation for the appropriate value for this field. This corresponds to the ``resource`` field @@ -2036,6 +2039,7 @@ async def delete_task( metadata: Sequence[Tuple[str, str]] = (), ) -> None: r"""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. diff --git a/google/cloud/tasks_v2/services/cloud_tasks/client.py b/google/cloud/tasks_v2/services/cloud_tasks/client.py index 9a8dbee..38edb56 100644 --- a/google/cloud/tasks_v2/services/cloud_tasks/client.py +++ b/google/cloud/tasks_v2/services/cloud_tasks/client.py @@ -489,6 +489,7 @@ def list_queues( metadata: Sequence[Tuple[str, str]] = (), ) -> pagers.ListQueuesPager: r"""Lists queues. + Queues are returned in lexicographical order. .. code-block:: python @@ -1085,8 +1086,10 @@ def purge_queue( metadata: Sequence[Tuple[str, str]] = (), ) -> queue.Queue: r"""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. @@ -1470,8 +1473,8 @@ def sample_get_iam_policy(): The request object. Request message for ``GetIamPolicy`` method. resource (str): REQUIRED: The resource for which the - policy is being requested. - See the operation documentation for the + policy is being requested. See the + operation documentation for the appropriate value for this field. This corresponds to the ``resource`` field @@ -1613,8 +1616,8 @@ def sample_set_iam_policy(): The request object. Request message for ``SetIamPolicy`` method. resource (str): REQUIRED: The resource for which the - policy is being specified. - See the operation documentation for the + policy is being specified. See the + operation documentation for the appropriate value for this field. This corresponds to the ``resource`` field @@ -1754,8 +1757,8 @@ def sample_test_iam_permissions(): The request object. Request message for ``TestIamPermissions`` method. resource (str): REQUIRED: The resource for which the - policy detail is being requested. - See the operation documentation for the + policy detail is being requested. See + the operation documentation for the appropriate value for this field. This corresponds to the ``resource`` field @@ -2213,6 +2216,7 @@ def delete_task( metadata: Sequence[Tuple[str, str]] = (), ) -> None: r"""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. diff --git a/google/cloud/tasks_v2/services/cloud_tasks/transports/grpc.py b/google/cloud/tasks_v2/services/cloud_tasks/transports/grpc.py index 897e980..fe23dfc 100644 --- a/google/cloud/tasks_v2/services/cloud_tasks/transports/grpc.py +++ b/google/cloud/tasks_v2/services/cloud_tasks/transports/grpc.py @@ -244,6 +244,7 @@ def list_queues( r"""Return a callable for the list queues method over gRPC. Lists queues. + Queues are returned in lexicographical order. Returns: @@ -405,8 +406,10 @@ def purge_queue(self) -> Callable[[cloudtasks.PurgeQueueRequest], queue.Queue]: r"""Return a callable for the purge queue method over gRPC. 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. @@ -700,6 +703,7 @@ def delete_task(self) -> Callable[[cloudtasks.DeleteTaskRequest], empty_pb2.Empt r"""Return a callable for the delete task method over gRPC. 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. diff --git a/google/cloud/tasks_v2/services/cloud_tasks/transports/grpc_asyncio.py b/google/cloud/tasks_v2/services/cloud_tasks/transports/grpc_asyncio.py index 6e0fc44..eaae6f3 100644 --- a/google/cloud/tasks_v2/services/cloud_tasks/transports/grpc_asyncio.py +++ b/google/cloud/tasks_v2/services/cloud_tasks/transports/grpc_asyncio.py @@ -249,6 +249,7 @@ def list_queues( r"""Return a callable for the list queues method over gRPC. Lists queues. + Queues are returned in lexicographical order. Returns: @@ -414,8 +415,10 @@ def purge_queue( r"""Return a callable for the purge queue method over gRPC. 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. @@ -719,6 +722,7 @@ def delete_task( r"""Return a callable for the delete task method over gRPC. 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. diff --git a/google/cloud/tasks_v2/types/queue.py b/google/cloud/tasks_v2/types/queue.py index e6533ac..5fa6d9e 100644 --- a/google/cloud/tasks_v2/types/queue.py +++ b/google/cloud/tasks_v2/types/queue.py @@ -320,6 +320,7 @@ class RateLimits(proto.Message): class RetryConfig(proto.Message): r"""Retry config. + These settings determine when a failed task attempt is retried. Attributes: diff --git a/google/cloud/tasks_v2/types/target.py b/google/cloud/tasks_v2/types/target.py index c170b84..2ab2dc6 100644 --- a/google/cloud/tasks_v2/types/target.py +++ b/google/cloud/tasks_v2/types/target.py @@ -305,6 +305,7 @@ class AppEngineHttpRequest(proto.Message): app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing]. relative_uri (str): The relative URI. + The relative URI must begin with "/" and must be a valid HTTP relative URI. It can contain a path and query string arguments. If the relative URI diff --git a/google/cloud/tasks_v2beta2/services/cloud_tasks/async_client.py b/google/cloud/tasks_v2beta2/services/cloud_tasks/async_client.py index 23afd2d..e824ec6 100644 --- a/google/cloud/tasks_v2beta2/services/cloud_tasks/async_client.py +++ b/google/cloud/tasks_v2beta2/services/cloud_tasks/async_client.py @@ -235,6 +235,7 @@ async def list_queues( metadata: Sequence[Tuple[str, str]] = (), ) -> pagers.ListQueuesAsyncPager: r"""Lists queues. + Queues are returned in lexicographical order. .. code-block:: python @@ -862,8 +863,10 @@ async def purge_queue( metadata: Sequence[Tuple[str, str]] = (), ) -> queue.Queue: r"""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. @@ -1205,6 +1208,7 @@ async def upload_queue_yaml( metadata: Sequence[Tuple[str, str]] = (), ) -> None: r"""Update queue list by uploading a queue.yaml file. + The queue.yaml file is supplied in the request body as a YAML encoded string. This method was added to support gcloud clients versions before 322.0.0. New clients @@ -1313,8 +1317,8 @@ async def sample_get_iam_policy(): The request object. Request message for ``GetIamPolicy`` method. resource (:class:`str`): REQUIRED: The resource for which the - policy is being requested. - See the operation documentation for the + policy is being requested. See the + operation documentation for the appropriate value for this field. This corresponds to the ``resource`` field @@ -1469,8 +1473,8 @@ async def sample_set_iam_policy(): The request object. Request message for ``SetIamPolicy`` method. resource (:class:`str`): REQUIRED: The resource for which the - policy is being specified. - See the operation documentation for the + policy is being specified. See the + operation documentation for the appropriate value for this field. This corresponds to the ``resource`` field @@ -1613,8 +1617,8 @@ async def sample_test_iam_permissions(): The request object. Request message for ``TestIamPermissions`` method. resource (:class:`str`): REQUIRED: The resource for which the - policy detail is being requested. - See the operation documentation for the + policy detail is being requested. See + the operation documentation for the appropriate value for this field. This corresponds to the ``resource`` field @@ -2108,6 +2112,7 @@ async def delete_task( metadata: Sequence[Tuple[str, str]] = (), ) -> None: r"""Deletes a task. + A task can be deleted if it is scheduled or dispatched. A task cannot be deleted if it has completed successfully or permanently failed. diff --git a/google/cloud/tasks_v2beta2/services/cloud_tasks/client.py b/google/cloud/tasks_v2beta2/services/cloud_tasks/client.py index c2beba2..3120b9e 100644 --- a/google/cloud/tasks_v2beta2/services/cloud_tasks/client.py +++ b/google/cloud/tasks_v2beta2/services/cloud_tasks/client.py @@ -490,6 +490,7 @@ def list_queues( metadata: Sequence[Tuple[str, str]] = (), ) -> pagers.ListQueuesPager: r"""Lists queues. + Queues are returned in lexicographical order. .. code-block:: python @@ -1087,8 +1088,10 @@ def purge_queue( metadata: Sequence[Tuple[str, str]] = (), ) -> queue.Queue: r"""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. @@ -1430,6 +1433,7 @@ def upload_queue_yaml( metadata: Sequence[Tuple[str, str]] = (), ) -> None: r"""Update queue list by uploading a queue.yaml file. + The queue.yaml file is supplied in the request body as a YAML encoded string. This method was added to support gcloud clients versions before 322.0.0. New clients @@ -1539,8 +1543,8 @@ def sample_get_iam_policy(): The request object. Request message for ``GetIamPolicy`` method. resource (str): REQUIRED: The resource for which the - policy is being requested. - See the operation documentation for the + policy is being requested. See the + operation documentation for the appropriate value for this field. This corresponds to the ``resource`` field @@ -1682,8 +1686,8 @@ def sample_set_iam_policy(): The request object. Request message for ``SetIamPolicy`` method. resource (str): REQUIRED: The resource for which the - policy is being specified. - See the operation documentation for the + policy is being specified. See the + operation documentation for the appropriate value for this field. This corresponds to the ``resource`` field @@ -1823,8 +1827,8 @@ def sample_test_iam_permissions(): The request object. Request message for ``TestIamPermissions`` method. resource (str): REQUIRED: The resource for which the - policy detail is being requested. - See the operation documentation for the + policy detail is being requested. See + the operation documentation for the appropriate value for this field. This corresponds to the ``resource`` field @@ -2286,6 +2290,7 @@ def delete_task( metadata: Sequence[Tuple[str, str]] = (), ) -> None: r"""Deletes a task. + A task can be deleted if it is scheduled or dispatched. A task cannot be deleted if it has completed successfully or permanently failed. diff --git a/google/cloud/tasks_v2beta2/services/cloud_tasks/transports/grpc.py b/google/cloud/tasks_v2beta2/services/cloud_tasks/transports/grpc.py index 34f9481..7812462 100644 --- a/google/cloud/tasks_v2beta2/services/cloud_tasks/transports/grpc.py +++ b/google/cloud/tasks_v2beta2/services/cloud_tasks/transports/grpc.py @@ -244,6 +244,7 @@ def list_queues( r"""Return a callable for the list queues method over gRPC. Lists queues. + Queues are returned in lexicographical order. Returns: @@ -405,8 +406,10 @@ def purge_queue(self) -> Callable[[cloudtasks.PurgeQueueRequest], queue.Queue]: r"""Return a callable for the purge queue method over gRPC. 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. @@ -505,6 +508,7 @@ def upload_queue_yaml( r"""Return a callable for the upload queue yaml method over gRPC. Update queue list by uploading a queue.yaml file. + The queue.yaml file is supplied in the request body as a YAML encoded string. This method was added to support gcloud clients versions before 322.0.0. New clients @@ -734,6 +738,7 @@ def delete_task(self) -> Callable[[cloudtasks.DeleteTaskRequest], empty_pb2.Empt r"""Return a callable for the delete task method over gRPC. Deletes a task. + A task can be deleted if it is scheduled or dispatched. A task cannot be deleted if it has completed successfully or permanently failed. diff --git a/google/cloud/tasks_v2beta2/services/cloud_tasks/transports/grpc_asyncio.py b/google/cloud/tasks_v2beta2/services/cloud_tasks/transports/grpc_asyncio.py index a8b6004..ca3d162 100644 --- a/google/cloud/tasks_v2beta2/services/cloud_tasks/transports/grpc_asyncio.py +++ b/google/cloud/tasks_v2beta2/services/cloud_tasks/transports/grpc_asyncio.py @@ -249,6 +249,7 @@ def list_queues( r"""Return a callable for the list queues method over gRPC. Lists queues. + Queues are returned in lexicographical order. Returns: @@ -414,8 +415,10 @@ def purge_queue( r"""Return a callable for the purge queue method over gRPC. 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. @@ -518,6 +521,7 @@ def upload_queue_yaml( r"""Return a callable for the upload queue yaml method over gRPC. Update queue list by uploading a queue.yaml file. + The queue.yaml file is supplied in the request body as a YAML encoded string. This method was added to support gcloud clients versions before 322.0.0. New clients @@ -753,6 +757,7 @@ def delete_task( r"""Return a callable for the delete task method over gRPC. Deletes a task. + A task can be deleted if it is scheduled or dispatched. A task cannot be deleted if it has completed successfully or permanently failed. diff --git a/google/cloud/tasks_v2beta2/types/queue.py b/google/cloud/tasks_v2beta2/types/queue.py index db6db09..b6d8e55 100644 --- a/google/cloud/tasks_v2beta2/types/queue.py +++ b/google/cloud/tasks_v2beta2/types/queue.py @@ -394,6 +394,7 @@ class RateLimits(proto.Message): class RetryConfig(proto.Message): r"""Retry config. + These settings determine how a failed task attempt is retried. This message has `oneof`_ fields (mutually exclusive fields). diff --git a/google/cloud/tasks_v2beta2/types/target.py b/google/cloud/tasks_v2beta2/types/target.py index faba695..bbcc1de 100644 --- a/google/cloud/tasks_v2beta2/types/target.py +++ b/google/cloud/tasks_v2beta2/types/target.py @@ -249,6 +249,7 @@ class AppEngineHttpRequest(proto.Message): app_engine_routing][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing]. relative_url (str): The relative URL. + The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path and query string arguments. If the relative URL @@ -517,6 +518,7 @@ class AppEngineRouting(proto.Message): class HttpRequest(proto.Message): r"""HTTP request. + The task will be pushed to the worker as an HTTP request. An HTTP request embodies a url, an http method, headers, body and authorization for the http task. @@ -648,6 +650,7 @@ class HttpRequest(proto.Message): class PathOverride(proto.Message): r"""PathOverride. + Path message defines path override for HTTP targets. Attributes: @@ -664,6 +667,7 @@ class PathOverride(proto.Message): class QueryOverride(proto.Message): r"""QueryOverride. + Query message defines query override for HTTP targets. Attributes: @@ -681,6 +685,7 @@ class QueryOverride(proto.Message): class UriOverride(proto.Message): r"""Uri Override. + When specified, all the HTTP tasks inside the queue will be partially or fully overridden depending on the configured values. @@ -691,6 +696,7 @@ class UriOverride(proto.Message): Attributes: scheme (google.cloud.tasks_v2beta2.types.UriOverride.Scheme): Scheme override. + When specified, the task URI scheme is replaced by the provided value (HTTP or HTTPS). @@ -707,6 +713,7 @@ class UriOverride(proto.Message): This field is a member of `oneof`_ ``_host``. port (int): Port override. + When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the @@ -718,16 +725,19 @@ class UriOverride(proto.Message): This field is a member of `oneof`_ ``_port``. path_override (google.cloud.tasks_v2beta2.types.PathOverride): URI path. + When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment. query_override (google.cloud.tasks_v2beta2.types.QueryOverride): URI Query. + When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment. uri_override_enforce_mode (google.cloud.tasks_v2beta2.types.UriOverride.UriOverrideEnforceMode): URI Override Enforce Mode + When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS. @@ -819,6 +829,7 @@ class HttpTarget(proto.Message): Attributes: uri_override (google.cloud.tasks_v2beta2.types.UriOverride): Uri override. + When specified, overrides the execution Uri for all the tasks in the queue. http_method (google.cloud.tasks_v2beta2.types.HttpMethod): diff --git a/google/cloud/tasks_v2beta3/services/cloud_tasks/async_client.py b/google/cloud/tasks_v2beta3/services/cloud_tasks/async_client.py index 26e8a80..13ae750 100644 --- a/google/cloud/tasks_v2beta3/services/cloud_tasks/async_client.py +++ b/google/cloud/tasks_v2beta3/services/cloud_tasks/async_client.py @@ -235,6 +235,7 @@ async def list_queues( metadata: Sequence[Tuple[str, str]] = (), ) -> pagers.ListQueuesAsyncPager: r"""Lists queues. + Queues are returned in lexicographical order. .. code-block:: python @@ -862,8 +863,10 @@ async def purge_queue( metadata: Sequence[Tuple[str, str]] = (), ) -> queue.Queue: r"""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. @@ -1247,8 +1250,8 @@ async def sample_get_iam_policy(): The request object. Request message for ``GetIamPolicy`` method. resource (:class:`str`): REQUIRED: The resource for which the - policy is being requested. - See the operation documentation for the + policy is being requested. See the + operation documentation for the appropriate value for this field. This corresponds to the ``resource`` field @@ -1403,8 +1406,8 @@ async def sample_set_iam_policy(): The request object. Request message for ``SetIamPolicy`` method. resource (:class:`str`): REQUIRED: The resource for which the - policy is being specified. - See the operation documentation for the + policy is being specified. See the + operation documentation for the appropriate value for this field. This corresponds to the ``resource`` field @@ -1547,8 +1550,8 @@ async def sample_test_iam_permissions(): The request object. Request message for ``TestIamPermissions`` method. resource (:class:`str`): REQUIRED: The resource for which the - policy detail is being requested. - See the operation documentation for the + policy detail is being requested. See + the operation documentation for the appropriate value for this field. This corresponds to the ``resource`` field @@ -2038,6 +2041,7 @@ async def delete_task( metadata: Sequence[Tuple[str, str]] = (), ) -> None: r"""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. diff --git a/google/cloud/tasks_v2beta3/services/cloud_tasks/client.py b/google/cloud/tasks_v2beta3/services/cloud_tasks/client.py index d0a9122..568dfe6 100644 --- a/google/cloud/tasks_v2beta3/services/cloud_tasks/client.py +++ b/google/cloud/tasks_v2beta3/services/cloud_tasks/client.py @@ -490,6 +490,7 @@ def list_queues( metadata: Sequence[Tuple[str, str]] = (), ) -> pagers.ListQueuesPager: r"""Lists queues. + Queues are returned in lexicographical order. .. code-block:: python @@ -1087,8 +1088,10 @@ def purge_queue( metadata: Sequence[Tuple[str, str]] = (), ) -> queue.Queue: r"""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. @@ -1472,8 +1475,8 @@ def sample_get_iam_policy(): The request object. Request message for ``GetIamPolicy`` method. resource (str): REQUIRED: The resource for which the - policy is being requested. - See the operation documentation for the + policy is being requested. See the + operation documentation for the appropriate value for this field. This corresponds to the ``resource`` field @@ -1615,8 +1618,8 @@ def sample_set_iam_policy(): The request object. Request message for ``SetIamPolicy`` method. resource (str): REQUIRED: The resource for which the - policy is being specified. - See the operation documentation for the + policy is being specified. See the + operation documentation for the appropriate value for this field. This corresponds to the ``resource`` field @@ -1756,8 +1759,8 @@ def sample_test_iam_permissions(): The request object. Request message for ``TestIamPermissions`` method. resource (str): REQUIRED: The resource for which the - policy detail is being requested. - See the operation documentation for the + policy detail is being requested. See + the operation documentation for the appropriate value for this field. This corresponds to the ``resource`` field @@ -2215,6 +2218,7 @@ def delete_task( metadata: Sequence[Tuple[str, str]] = (), ) -> None: r"""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. diff --git a/google/cloud/tasks_v2beta3/services/cloud_tasks/transports/grpc.py b/google/cloud/tasks_v2beta3/services/cloud_tasks/transports/grpc.py index d7ec378..22ae3cf 100644 --- a/google/cloud/tasks_v2beta3/services/cloud_tasks/transports/grpc.py +++ b/google/cloud/tasks_v2beta3/services/cloud_tasks/transports/grpc.py @@ -244,6 +244,7 @@ def list_queues( r"""Return a callable for the list queues method over gRPC. Lists queues. + Queues are returned in lexicographical order. Returns: @@ -405,8 +406,10 @@ def purge_queue(self) -> Callable[[cloudtasks.PurgeQueueRequest], queue.Queue]: r"""Return a callable for the purge queue method over gRPC. 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. @@ -700,6 +703,7 @@ def delete_task(self) -> Callable[[cloudtasks.DeleteTaskRequest], empty_pb2.Empt r"""Return a callable for the delete task method over gRPC. 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. diff --git a/google/cloud/tasks_v2beta3/services/cloud_tasks/transports/grpc_asyncio.py b/google/cloud/tasks_v2beta3/services/cloud_tasks/transports/grpc_asyncio.py index cd48cac..c138c66 100644 --- a/google/cloud/tasks_v2beta3/services/cloud_tasks/transports/grpc_asyncio.py +++ b/google/cloud/tasks_v2beta3/services/cloud_tasks/transports/grpc_asyncio.py @@ -249,6 +249,7 @@ def list_queues( r"""Return a callable for the list queues method over gRPC. Lists queues. + Queues are returned in lexicographical order. Returns: @@ -414,8 +415,10 @@ def purge_queue( r"""Return a callable for the purge queue method over gRPC. 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. @@ -719,6 +722,7 @@ def delete_task( r"""Return a callable for the delete task method over gRPC. 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. diff --git a/google/cloud/tasks_v2beta3/types/queue.py b/google/cloud/tasks_v2beta3/types/queue.py index 9aa3eff..9bf29b0 100644 --- a/google/cloud/tasks_v2beta3/types/queue.py +++ b/google/cloud/tasks_v2beta3/types/queue.py @@ -408,6 +408,7 @@ class RateLimits(proto.Message): class RetryConfig(proto.Message): r"""Retry config. + These settings determine when a failed task attempt is retried. Attributes: diff --git a/google/cloud/tasks_v2beta3/types/target.py b/google/cloud/tasks_v2beta3/types/target.py index 4850ed8..3f04cd9 100644 --- a/google/cloud/tasks_v2beta3/types/target.py +++ b/google/cloud/tasks_v2beta3/types/target.py @@ -109,6 +109,7 @@ class PullMessage(proto.Message): class PathOverride(proto.Message): r"""PathOverride. + Path message defines path override for HTTP targets. Attributes: @@ -125,6 +126,7 @@ class PathOverride(proto.Message): class QueryOverride(proto.Message): r"""QueryOverride. + Query message defines query override for HTTP targets. Attributes: @@ -142,6 +144,7 @@ class QueryOverride(proto.Message): class UriOverride(proto.Message): r"""URI Override. + When specified, all the HTTP tasks inside the queue will be partially or fully overridden depending on the configured values. @@ -152,6 +155,7 @@ class UriOverride(proto.Message): Attributes: scheme (google.cloud.tasks_v2beta3.types.UriOverride.Scheme): Scheme override. + When specified, the task URI scheme is replaced by the provided value (HTTP or HTTPS). @@ -168,6 +172,7 @@ class UriOverride(proto.Message): This field is a member of `oneof`_ ``_host``. port (int): Port override. + When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the @@ -179,16 +184,19 @@ class UriOverride(proto.Message): This field is a member of `oneof`_ ``_port``. path_override (google.cloud.tasks_v2beta3.types.PathOverride): URI path. + When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment. query_override (google.cloud.tasks_v2beta3.types.QueryOverride): URI Query. + When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment. uri_override_enforce_mode (google.cloud.tasks_v2beta3.types.UriOverride.UriOverrideEnforceMode): URI Override Enforce Mode + When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS. @@ -280,6 +288,7 @@ class HttpTarget(proto.Message): Attributes: uri_override (google.cloud.tasks_v2beta3.types.UriOverride): URI override. + When specified, overrides the execution URI for all the tasks in the queue. http_method (google.cloud.tasks_v2beta3.types.HttpMethod): @@ -698,6 +707,7 @@ class AppEngineHttpRequest(proto.Message): app_engine_routing][google.cloud.tasks.v2beta3.AppEngineHttpRequest.app_engine_routing]. relative_uri (str): The relative URI. + The relative URI must begin with "/" and must be a valid HTTP relative URI. It can contain a path and query string arguments. If the relative URI diff --git a/samples/generated_samples/snippet_metadata_google.cloud.tasks.v2.json b/samples/generated_samples/snippet_metadata_google.cloud.tasks.v2.json index 2f6146c..164c51d 100644 --- a/samples/generated_samples/snippet_metadata_google.cloud.tasks.v2.json +++ b/samples/generated_samples/snippet_metadata_google.cloud.tasks.v2.json @@ -8,7 +8,7 @@ ], "language": "PYTHON", "name": "google-cloud-tasks", - "version": "2.14.1" + "version": "0.1.0" }, "snippets": [ { diff --git a/samples/generated_samples/snippet_metadata_google.cloud.tasks.v2beta2.json b/samples/generated_samples/snippet_metadata_google.cloud.tasks.v2beta2.json index 7ded9bc..9f72991 100644 --- a/samples/generated_samples/snippet_metadata_google.cloud.tasks.v2beta2.json +++ b/samples/generated_samples/snippet_metadata_google.cloud.tasks.v2beta2.json @@ -8,7 +8,7 @@ ], "language": "PYTHON", "name": "google-cloud-tasks", - "version": "2.14.1" + "version": "0.1.0" }, "snippets": [ { diff --git a/samples/generated_samples/snippet_metadata_google.cloud.tasks.v2beta3.json b/samples/generated_samples/snippet_metadata_google.cloud.tasks.v2beta3.json index 6ed7829..c5d7f81 100644 --- a/samples/generated_samples/snippet_metadata_google.cloud.tasks.v2beta3.json +++ b/samples/generated_samples/snippet_metadata_google.cloud.tasks.v2beta3.json @@ -8,7 +8,7 @@ ], "language": "PYTHON", "name": "google-cloud-tasks", - "version": "2.14.1" + "version": "0.1.0" }, "snippets": [ {