Package Methods (2.18.0)

Version latest

• 2.18.0 (latest)
• 2.17.1
• 2.16.5
• 2.15.1
• 2.14.2
• 2.13.2
• 2.12.1
• 2.11.0
• 2.10.4
• 2.9.1
• 2.8.1
• 2.7.2
• 2.6.0
• 2.5.3
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.5.2
• 1.4.0
• 1.3.0
• 1.2.1

Summary of entries of Methods for cloudtasks.

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient

CloudTasksAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.tasks_v2.services.cloud_tasks.transports.base.CloudTasksTransport, typing.Callable[[...], google.cloud.tasks_v2.services.cloud_tasks.transports.base.CloudTasksTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = 

Instantiates the cloud tasks async client.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.common_billing_account_path

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.common_folder_path

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.common_location_path

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.common_organization_path

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.common_project_path

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.create_queue

create_queue(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2.types.cloudtasks.CreateQueueRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    queue: typing.Optional[google.cloud.tasks_v2.types.queue.Queue] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2.types.queue.Queue

Creates a queue.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.create_queue

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.create_task

create_task(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2.types.cloudtasks.CreateTaskRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    task: typing.Optional[google.cloud.tasks_v2.types.task.Task] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2.types.task.Task

Creates a task and adds it to a queue.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.create_task

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.delete_queue

delete_queue(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2.types.cloudtasks.DeleteQueueRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a queue.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.delete_queue

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.delete_task

delete_task(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2.types.cloudtasks.DeleteTaskRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a task.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.delete_task

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.from_service_account_file

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.from_service_account_info

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.from_service_account_json

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.get_iam_policy

get_iam_policy(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.policy_pb2.Policy

Gets the access control policy for a xref_Queue.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.get_iam_policy

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.get_location

get_location(
    request: typing.Optional[
        google.cloud.location.locations_pb2.GetLocationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.Location

Gets information about a location.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.get_location

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.get_queue

get_queue(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2.types.cloudtasks.GetQueueRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2.types.queue.Queue

Gets a queue.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.get_queue

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.get_task

get_task(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2.types.cloudtasks.GetTaskRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2.types.task.Task

Gets a task.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.get_task

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.tasks_v2.services.cloud_tasks.transports.base.CloudTasksTransport
]

Returns an appropriate transport class.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.get_transport_class

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.list_locations

list_locations(
    request: typing.Optional[
        google.cloud.location.locations_pb2.ListLocationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse

Lists information about the supported locations for this service.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.list_locations

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.list_queues

list_queues(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2.types.cloudtasks.ListQueuesRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2.services.cloud_tasks.pagers.ListQueuesAsyncPager

Lists queues.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.list_queues

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.list_tasks

list_tasks(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2.types.cloudtasks.ListTasksRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2.services.cloud_tasks.pagers.ListTasksAsyncPager

Lists the tasks in a queue.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.list_tasks

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.parse_common_billing_account_path

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.parse_common_folder_path

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.parse_common_location_path

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.parse_common_organization_path

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.parse_common_project_path

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.parse_queue_path

parse_queue_path(path: str) -> typing.Dict[str, str]

Parses a queue path into its component segments.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.parse_queue_path

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.parse_task_path

parse_task_path(path: str) -> typing.Dict[str, str]

Parses a task path into its component segments.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.parse_task_path

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.pause_queue

pause_queue(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2.types.cloudtasks.PauseQueueRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2.types.queue.Queue

Pauses the queue.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.pause_queue

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.purge_queue

purge_queue(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2.types.cloudtasks.PurgeQueueRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2.types.queue.Queue

Purges a queue by deleting all of its tasks.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.purge_queue

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.queue_path

queue_path(project: str, location: str, queue: str) -> str

Returns a fully-qualified queue string.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.queue_path

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.resume_queue

resume_queue(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2.types.cloudtasks.ResumeQueueRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2.types.queue.Queue

Resume a queue.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.resume_queue

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.run_task

run_task(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2.types.cloudtasks.RunTaskRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2.types.task.Task

Forces a task to run now.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.run_task

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.set_iam_policy

set_iam_policy(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.policy_pb2.Policy

Sets the access control policy for a xref_Queue.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.set_iam_policy

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.task_path

task_path(project: str, location: str, queue: str, task: str) -> str

Returns a fully-qualified task string.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.task_path

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.test_iam_permissions

test_iam_permissions(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    permissions: typing.Optional[typing.MutableSequence[str]] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse

Returns permissions that a caller has on a xref_Queue.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.test_iam_permissions

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.update_queue

update_queue(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2.types.cloudtasks.UpdateQueueRequest, dict]
    ] = None,
    *,
    queue: typing.Optional[google.cloud.tasks_v2.types.queue.Queue] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2.types.queue.Queue

Updates a queue.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksAsyncClient.update_queue

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient

CloudTasksClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.tasks_v2.services.cloud_tasks.transports.base.CloudTasksTransport, typing.Callable[[...], google.cloud.tasks_v2.services.cloud_tasks.transports.base.CloudTasksTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = 

Instantiates the cloud tasks client.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.exit

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.common_billing_account_path

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.common_folder_path

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.common_location_path

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.common_organization_path

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.common_project_path

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.create_queue

create_queue(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2.types.cloudtasks.CreateQueueRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    queue: typing.Optional[google.cloud.tasks_v2.types.queue.Queue] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2.types.queue.Queue

Creates a queue.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.create_queue

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.create_task

create_task(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2.types.cloudtasks.CreateTaskRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    task: typing.Optional[google.cloud.tasks_v2.types.task.Task] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2.types.task.Task

Creates a task and adds it to a queue.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.create_task

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.delete_queue

delete_queue(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2.types.cloudtasks.DeleteQueueRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a queue.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.delete_queue

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.delete_task

delete_task(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2.types.cloudtasks.DeleteTaskRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a task.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.delete_task

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.from_service_account_file

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.from_service_account_info

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.from_service_account_json

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.get_iam_policy

get_iam_policy(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.policy_pb2.Policy

Gets the access control policy for a xref_Queue.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.get_iam_policy

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.get_location

get_location(
    request: typing.Optional[
        google.cloud.location.locations_pb2.GetLocationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.Location

Gets information about a location.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.get_location

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.get_mtls_endpoint_and_cert_source

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.get_queue

get_queue(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2.types.cloudtasks.GetQueueRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2.types.queue.Queue

Gets a queue.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.get_queue

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.get_task

get_task(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2.types.cloudtasks.GetTaskRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2.types.task.Task

Gets a task.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.get_task

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.list_locations

list_locations(
    request: typing.Optional[
        google.cloud.location.locations_pb2.ListLocationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse

Lists information about the supported locations for this service.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.list_locations

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.list_queues

list_queues(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2.types.cloudtasks.ListQueuesRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2.services.cloud_tasks.pagers.ListQueuesPager

Lists queues.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.list_queues

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.list_tasks

list_tasks(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2.types.cloudtasks.ListTasksRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2.services.cloud_tasks.pagers.ListTasksPager

Lists the tasks in a queue.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.list_tasks

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.parse_common_billing_account_path

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.parse_common_folder_path

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.parse_common_location_path

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.parse_common_organization_path

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.parse_common_project_path

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.parse_queue_path

parse_queue_path(path: str) -> typing.Dict[str, str]

Parses a queue path into its component segments.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.parse_queue_path

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.parse_task_path

parse_task_path(path: str) -> typing.Dict[str, str]

Parses a task path into its component segments.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.parse_task_path

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.pause_queue

pause_queue(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2.types.cloudtasks.PauseQueueRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2.types.queue.Queue

Pauses the queue.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.pause_queue

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.purge_queue

purge_queue(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2.types.cloudtasks.PurgeQueueRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2.types.queue.Queue

Purges a queue by deleting all of its tasks.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.purge_queue

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.queue_path

queue_path(project: str, location: str, queue: str) -> str

Returns a fully-qualified queue string.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.queue_path

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.resume_queue

resume_queue(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2.types.cloudtasks.ResumeQueueRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2.types.queue.Queue

Resume a queue.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.resume_queue

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.run_task

run_task(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2.types.cloudtasks.RunTaskRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2.types.task.Task

Forces a task to run now.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.run_task

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.set_iam_policy

set_iam_policy(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.policy_pb2.Policy

Sets the access control policy for a xref_Queue.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.set_iam_policy

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.task_path

task_path(project: str, location: str, queue: str, task: str) -> str

Returns a fully-qualified task string.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.task_path

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.test_iam_permissions

test_iam_permissions(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    permissions: typing.Optional[typing.MutableSequence[str]] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse

Returns permissions that a caller has on a xref_Queue.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.test_iam_permissions

google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.update_queue

update_queue(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2.types.cloudtasks.UpdateQueueRequest, dict]
    ] = None,
    *,
    queue: typing.Optional[google.cloud.tasks_v2.types.queue.Queue] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2.types.queue.Queue

Updates a queue.

See more: google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient.update_queue

google.cloud.tasks_v2.services.cloud_tasks.pagers.ListQueuesAsyncPager

ListQueuesAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[google.cloud.tasks_v2.types.cloudtasks.ListQueuesResponse],
    ],
    request: google.cloud.tasks_v2.types.cloudtasks.ListQueuesRequest,
    response: google.cloud.tasks_v2.types.cloudtasks.ListQueuesResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiates the pager.

See more: google.cloud.tasks_v2.services.cloud_tasks.pagers.ListQueuesAsyncPager

google.cloud.tasks_v2.services.cloud_tasks.pagers.ListQueuesPager

ListQueuesPager(
    method: typing.Callable[
        [...], google.cloud.tasks_v2.types.cloudtasks.ListQueuesResponse
    ],
    request: google.cloud.tasks_v2.types.cloudtasks.ListQueuesRequest,
    response: google.cloud.tasks_v2.types.cloudtasks.ListQueuesResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiate the pager.

See more: google.cloud.tasks_v2.services.cloud_tasks.pagers.ListQueuesPager

google.cloud.tasks_v2.services.cloud_tasks.pagers.ListTasksAsyncPager

ListTasksAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[google.cloud.tasks_v2.types.cloudtasks.ListTasksResponse],
    ],
    request: google.cloud.tasks_v2.types.cloudtasks.ListTasksRequest,
    response: google.cloud.tasks_v2.types.cloudtasks.ListTasksResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiates the pager.

See more: google.cloud.tasks_v2.services.cloud_tasks.pagers.ListTasksAsyncPager

google.cloud.tasks_v2.services.cloud_tasks.pagers.ListTasksPager

ListTasksPager(
    method: typing.Callable[
        [...], google.cloud.tasks_v2.types.cloudtasks.ListTasksResponse
    ],
    request: google.cloud.tasks_v2.types.cloudtasks.ListTasksRequest,
    response: google.cloud.tasks_v2.types.cloudtasks.ListTasksResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiate the pager.

See more: google.cloud.tasks_v2.services.cloud_tasks.pagers.ListTasksPager

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient

CloudTasksAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.tasks_v2beta2.services.cloud_tasks.transports.base.CloudTasksTransport, typing.Callable[[...], google.cloud.tasks_v2beta2.services.cloud_tasks.transports.base.CloudTasksTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = 

Instantiates the cloud tasks async client.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.acknowledge_task

acknowledge_task(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta2.types.cloudtasks.AcknowledgeTaskRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    schedule_time: typing.Optional[google.protobuf.timestamp_pb2.Timestamp] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Acknowledges a pull task.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.acknowledge_task

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.cancel_lease

cancel_lease(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta2.types.cloudtasks.CancelLeaseRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    schedule_time: typing.Optional[google.protobuf.timestamp_pb2.Timestamp] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta2.types.task.Task

Cancel a pull task's lease.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.cancel_lease

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.common_billing_account_path

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.common_folder_path

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.common_location_path

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.common_organization_path

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.common_project_path

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.create_queue

create_queue(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta2.types.cloudtasks.CreateQueueRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    queue: typing.Optional[google.cloud.tasks_v2beta2.types.queue.Queue] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta2.types.queue.Queue

Creates a queue.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.create_queue

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.create_task

create_task(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta2.types.cloudtasks.CreateTaskRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    task: typing.Optional[google.cloud.tasks_v2beta2.types.task.Task] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta2.types.task.Task

Creates a task and adds it to a queue.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.create_task

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.delete_queue

delete_queue(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta2.types.cloudtasks.DeleteQueueRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a queue.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.delete_queue

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.delete_task

delete_task(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta2.types.cloudtasks.DeleteTaskRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a task.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.delete_task

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.from_service_account_file

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.from_service_account_info

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.from_service_account_json

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.get_iam_policy

get_iam_policy(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.policy_pb2.Policy

Gets the access control policy for a xref_Queue.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.get_iam_policy

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.get_location

get_location(
    request: typing.Optional[
        google.cloud.location.locations_pb2.GetLocationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.Location

Gets information about a location.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.get_location

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.get_queue

get_queue(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2beta2.types.cloudtasks.GetQueueRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta2.types.queue.Queue

Gets a queue.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.get_queue

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.get_task

get_task(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2beta2.types.cloudtasks.GetTaskRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta2.types.task.Task

Gets a task.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.get_task

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.tasks_v2beta2.services.cloud_tasks.transports.base.CloudTasksTransport
]

Returns an appropriate transport class.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.get_transport_class

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.lease_tasks

lease_tasks(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta2.types.cloudtasks.LeaseTasksRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    lease_duration: typing.Optional[google.protobuf.duration_pb2.Duration] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta2.types.cloudtasks.LeaseTasksResponse

Leases tasks from a pull queue for xref_lease_duration.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.lease_tasks

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.list_locations

list_locations(
    request: typing.Optional[
        google.cloud.location.locations_pb2.ListLocationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse

Lists information about the supported locations for this service.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.list_locations

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.list_queues

list_queues(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta2.types.cloudtasks.ListQueuesRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta2.services.cloud_tasks.pagers.ListQueuesAsyncPager

Lists queues.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.list_queues

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.list_tasks

list_tasks(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2beta2.types.cloudtasks.ListTasksRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta2.services.cloud_tasks.pagers.ListTasksAsyncPager

Lists the tasks in a queue.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.list_tasks

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.parse_common_billing_account_path

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.parse_common_folder_path

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.parse_common_location_path

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.parse_common_organization_path

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.parse_common_project_path

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.parse_queue_path

parse_queue_path(path: str) -> typing.Dict[str, str]

Parses a queue path into its component segments.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.parse_queue_path

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.parse_task_path

parse_task_path(path: str) -> typing.Dict[str, str]

Parses a task path into its component segments.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.parse_task_path

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.pause_queue

pause_queue(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta2.types.cloudtasks.PauseQueueRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta2.types.queue.Queue

Pauses the queue.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.pause_queue

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.purge_queue

purge_queue(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta2.types.cloudtasks.PurgeQueueRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta2.types.queue.Queue

Purges a queue by deleting all of its tasks.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.purge_queue

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.queue_path

queue_path(project: str, location: str, queue: str) -> str

Returns a fully-qualified queue string.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.queue_path

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.renew_lease

renew_lease(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta2.types.cloudtasks.RenewLeaseRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    schedule_time: typing.Optional[google.protobuf.timestamp_pb2.Timestamp] = None,
    lease_duration: typing.Optional[google.protobuf.duration_pb2.Duration] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta2.types.task.Task

Renew the current lease of a pull task.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.renew_lease

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.resume_queue

resume_queue(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta2.types.cloudtasks.ResumeQueueRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta2.types.queue.Queue

Resume a queue.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.resume_queue

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.run_task

run_task(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2beta2.types.cloudtasks.RunTaskRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta2.types.task.Task

Forces a task to run now.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.run_task

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.set_iam_policy

set_iam_policy(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.policy_pb2.Policy

Sets the access control policy for a xref_Queue.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.set_iam_policy

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.task_path

task_path(project: str, location: str, queue: str, task: str) -> str

Returns a fully-qualified task string.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.task_path

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.test_iam_permissions

test_iam_permissions(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    permissions: typing.Optional[typing.MutableSequence[str]] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse

Returns permissions that a caller has on a xref_Queue.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.test_iam_permissions

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.update_queue

update_queue(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta2.types.cloudtasks.UpdateQueueRequest, dict
        ]
    ] = None,
    *,
    queue: typing.Optional[google.cloud.tasks_v2beta2.types.queue.Queue] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta2.types.queue.Queue

Updates a queue.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.update_queue

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.upload_queue_yaml

upload_queue_yaml(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta2.types.cloudtasks.UploadQueueYamlRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Update queue list by uploading a queue.yaml file.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksAsyncClient.upload_queue_yaml

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient

CloudTasksClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.tasks_v2beta2.services.cloud_tasks.transports.base.CloudTasksTransport, typing.Callable[[...], google.cloud.tasks_v2beta2.services.cloud_tasks.transports.base.CloudTasksTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = 

Instantiates the cloud tasks client.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.exit

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.acknowledge_task

acknowledge_task(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta2.types.cloudtasks.AcknowledgeTaskRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    schedule_time: typing.Optional[google.protobuf.timestamp_pb2.Timestamp] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Acknowledges a pull task.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.acknowledge_task

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.cancel_lease

cancel_lease(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta2.types.cloudtasks.CancelLeaseRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    schedule_time: typing.Optional[google.protobuf.timestamp_pb2.Timestamp] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta2.types.task.Task

Cancel a pull task's lease.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.cancel_lease

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.common_billing_account_path

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.common_folder_path

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.common_location_path

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.common_organization_path

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.common_project_path

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.create_queue

create_queue(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta2.types.cloudtasks.CreateQueueRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    queue: typing.Optional[google.cloud.tasks_v2beta2.types.queue.Queue] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta2.types.queue.Queue

Creates a queue.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.create_queue

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.create_task

create_task(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta2.types.cloudtasks.CreateTaskRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    task: typing.Optional[google.cloud.tasks_v2beta2.types.task.Task] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta2.types.task.Task

Creates a task and adds it to a queue.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.create_task

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.delete_queue

delete_queue(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta2.types.cloudtasks.DeleteQueueRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a queue.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.delete_queue

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.delete_task

delete_task(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta2.types.cloudtasks.DeleteTaskRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a task.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.delete_task

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.from_service_account_file

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.from_service_account_info

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.from_service_account_json

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.get_iam_policy

get_iam_policy(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.policy_pb2.Policy

Gets the access control policy for a xref_Queue.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.get_iam_policy

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.get_location

get_location(
    request: typing.Optional[
        google.cloud.location.locations_pb2.GetLocationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.Location

Gets information about a location.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.get_location

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.get_mtls_endpoint_and_cert_source

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.get_queue

get_queue(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2beta2.types.cloudtasks.GetQueueRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta2.types.queue.Queue

Gets a queue.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.get_queue

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.get_task

get_task(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2beta2.types.cloudtasks.GetTaskRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta2.types.task.Task

Gets a task.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.get_task

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.lease_tasks

lease_tasks(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta2.types.cloudtasks.LeaseTasksRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    lease_duration: typing.Optional[google.protobuf.duration_pb2.Duration] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta2.types.cloudtasks.LeaseTasksResponse

Leases tasks from a pull queue for xref_lease_duration.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.lease_tasks

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.list_locations

list_locations(
    request: typing.Optional[
        google.cloud.location.locations_pb2.ListLocationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse

Lists information about the supported locations for this service.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.list_locations

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.list_queues

list_queues(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta2.types.cloudtasks.ListQueuesRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta2.services.cloud_tasks.pagers.ListQueuesPager

Lists queues.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.list_queues

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.list_tasks

list_tasks(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2beta2.types.cloudtasks.ListTasksRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta2.services.cloud_tasks.pagers.ListTasksPager

Lists the tasks in a queue.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.list_tasks

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.parse_common_billing_account_path

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.parse_common_folder_path

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.parse_common_location_path

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.parse_common_organization_path

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.parse_common_project_path

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.parse_queue_path

parse_queue_path(path: str) -> typing.Dict[str, str]

Parses a queue path into its component segments.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.parse_queue_path

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.parse_task_path

parse_task_path(path: str) -> typing.Dict[str, str]

Parses a task path into its component segments.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.parse_task_path

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.pause_queue

pause_queue(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta2.types.cloudtasks.PauseQueueRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta2.types.queue.Queue

Pauses the queue.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.pause_queue

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.purge_queue

purge_queue(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta2.types.cloudtasks.PurgeQueueRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta2.types.queue.Queue

Purges a queue by deleting all of its tasks.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.purge_queue

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.queue_path

queue_path(project: str, location: str, queue: str) -> str

Returns a fully-qualified queue string.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.queue_path

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.renew_lease

renew_lease(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta2.types.cloudtasks.RenewLeaseRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    schedule_time: typing.Optional[google.protobuf.timestamp_pb2.Timestamp] = None,
    lease_duration: typing.Optional[google.protobuf.duration_pb2.Duration] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta2.types.task.Task

Renew the current lease of a pull task.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.renew_lease

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.resume_queue

resume_queue(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta2.types.cloudtasks.ResumeQueueRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta2.types.queue.Queue

Resume a queue.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.resume_queue

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.run_task

run_task(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2beta2.types.cloudtasks.RunTaskRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta2.types.task.Task

Forces a task to run now.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.run_task

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.set_iam_policy

set_iam_policy(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.policy_pb2.Policy

Sets the access control policy for a xref_Queue.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.set_iam_policy

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.task_path

task_path(project: str, location: str, queue: str, task: str) -> str

Returns a fully-qualified task string.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.task_path

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.test_iam_permissions

test_iam_permissions(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    permissions: typing.Optional[typing.MutableSequence[str]] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse

Returns permissions that a caller has on a xref_Queue.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.test_iam_permissions

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.update_queue

update_queue(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta2.types.cloudtasks.UpdateQueueRequest, dict
        ]
    ] = None,
    *,
    queue: typing.Optional[google.cloud.tasks_v2beta2.types.queue.Queue] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta2.types.queue.Queue

Updates a queue.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.update_queue

google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.upload_queue_yaml

upload_queue_yaml(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta2.types.cloudtasks.UploadQueueYamlRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Update queue list by uploading a queue.yaml file.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.CloudTasksClient.upload_queue_yaml

google.cloud.tasks_v2beta2.services.cloud_tasks.pagers.ListQueuesAsyncPager

ListQueuesAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.tasks_v2beta2.types.cloudtasks.ListQueuesResponse
        ],
    ],
    request: google.cloud.tasks_v2beta2.types.cloudtasks.ListQueuesRequest,
    response: google.cloud.tasks_v2beta2.types.cloudtasks.ListQueuesResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiates the pager.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.pagers.ListQueuesAsyncPager

google.cloud.tasks_v2beta2.services.cloud_tasks.pagers.ListQueuesPager

ListQueuesPager(
    method: typing.Callable[
        [...], google.cloud.tasks_v2beta2.types.cloudtasks.ListQueuesResponse
    ],
    request: google.cloud.tasks_v2beta2.types.cloudtasks.ListQueuesRequest,
    response: google.cloud.tasks_v2beta2.types.cloudtasks.ListQueuesResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiate the pager.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.pagers.ListQueuesPager

google.cloud.tasks_v2beta2.services.cloud_tasks.pagers.ListTasksAsyncPager

ListTasksAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[google.cloud.tasks_v2beta2.types.cloudtasks.ListTasksResponse],
    ],
    request: google.cloud.tasks_v2beta2.types.cloudtasks.ListTasksRequest,
    response: google.cloud.tasks_v2beta2.types.cloudtasks.ListTasksResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiates the pager.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.pagers.ListTasksAsyncPager

google.cloud.tasks_v2beta2.services.cloud_tasks.pagers.ListTasksPager

ListTasksPager(
    method: typing.Callable[
        [...], google.cloud.tasks_v2beta2.types.cloudtasks.ListTasksResponse
    ],
    request: google.cloud.tasks_v2beta2.types.cloudtasks.ListTasksRequest,
    response: google.cloud.tasks_v2beta2.types.cloudtasks.ListTasksResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiate the pager.

See more: google.cloud.tasks_v2beta2.services.cloud_tasks.pagers.ListTasksPager

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient

CloudTasksAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.tasks_v2beta3.services.cloud_tasks.transports.base.CloudTasksTransport, typing.Callable[[...], google.cloud.tasks_v2beta3.services.cloud_tasks.transports.base.CloudTasksTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = 

Instantiates the cloud tasks async client.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.common_billing_account_path

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.common_folder_path

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.common_location_path

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.common_organization_path

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.common_project_path

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.create_queue

create_queue(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta3.types.cloudtasks.CreateQueueRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    queue: typing.Optional[google.cloud.tasks_v2beta3.types.queue.Queue] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta3.types.queue.Queue

Creates a queue.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.create_queue

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.create_task

create_task(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta3.types.cloudtasks.CreateTaskRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    task: typing.Optional[google.cloud.tasks_v2beta3.types.task.Task] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta3.types.task.Task

Creates a task and adds it to a queue.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.create_task

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.delete_queue

delete_queue(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta3.types.cloudtasks.DeleteQueueRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a queue.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.delete_queue

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.delete_task

delete_task(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta3.types.cloudtasks.DeleteTaskRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a task.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.delete_task

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.from_service_account_file

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.from_service_account_info

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.from_service_account_json

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.get_iam_policy

get_iam_policy(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.policy_pb2.Policy

Gets the access control policy for a xref_Queue.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.get_iam_policy

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.get_location

get_location(
    request: typing.Optional[
        google.cloud.location.locations_pb2.GetLocationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.Location

Gets information about a location.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.get_location

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.get_queue

get_queue(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2beta3.types.cloudtasks.GetQueueRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta3.types.queue.Queue

Gets a queue.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.get_queue

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.get_task

get_task(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2beta3.types.cloudtasks.GetTaskRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta3.types.task.Task

Gets a task.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.get_task

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.tasks_v2beta3.services.cloud_tasks.transports.base.CloudTasksTransport
]

Returns an appropriate transport class.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.get_transport_class

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.list_locations

list_locations(
    request: typing.Optional[
        google.cloud.location.locations_pb2.ListLocationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse

Lists information about the supported locations for this service.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.list_locations

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.list_queues

list_queues(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta3.types.cloudtasks.ListQueuesRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta3.services.cloud_tasks.pagers.ListQueuesAsyncPager

Lists queues.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.list_queues

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.list_tasks

list_tasks(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2beta3.types.cloudtasks.ListTasksRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta3.services.cloud_tasks.pagers.ListTasksAsyncPager

Lists the tasks in a queue.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.list_tasks

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.parse_common_billing_account_path

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.parse_common_folder_path

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.parse_common_location_path

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.parse_common_organization_path

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.parse_common_project_path

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.parse_queue_path

parse_queue_path(path: str) -> typing.Dict[str, str]

Parses a queue path into its component segments.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.parse_queue_path

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.parse_task_path

parse_task_path(path: str) -> typing.Dict[str, str]

Parses a task path into its component segments.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.parse_task_path

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.pause_queue

pause_queue(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta3.types.cloudtasks.PauseQueueRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta3.types.queue.Queue

Pauses the queue.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.pause_queue

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.purge_queue

purge_queue(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta3.types.cloudtasks.PurgeQueueRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta3.types.queue.Queue

Purges a queue by deleting all of its tasks.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.purge_queue

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.queue_path

queue_path(project: str, location: str, queue: str) -> str

Returns a fully-qualified queue string.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.queue_path

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.resume_queue

resume_queue(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta3.types.cloudtasks.ResumeQueueRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta3.types.queue.Queue

Resume a queue.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.resume_queue

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.run_task

run_task(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2beta3.types.cloudtasks.RunTaskRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta3.types.task.Task

Forces a task to run now.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.run_task

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.set_iam_policy

set_iam_policy(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.policy_pb2.Policy

Sets the access control policy for a xref_Queue.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.set_iam_policy

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.task_path

task_path(project: str, location: str, queue: str, task: str) -> str

Returns a fully-qualified task string.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.task_path

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.test_iam_permissions

test_iam_permissions(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    permissions: typing.Optional[typing.MutableSequence[str]] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse

Returns permissions that a caller has on a xref_Queue.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.test_iam_permissions

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.update_queue

update_queue(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta3.types.cloudtasks.UpdateQueueRequest, dict
        ]
    ] = None,
    *,
    queue: typing.Optional[google.cloud.tasks_v2beta3.types.queue.Queue] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta3.types.queue.Queue

Updates a queue.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksAsyncClient.update_queue

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient

CloudTasksClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.tasks_v2beta3.services.cloud_tasks.transports.base.CloudTasksTransport, typing.Callable[[...], google.cloud.tasks_v2beta3.services.cloud_tasks.transports.base.CloudTasksTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = 

Instantiates the cloud tasks client.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.exit

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.common_billing_account_path

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.common_folder_path

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.common_location_path

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.common_organization_path

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.common_project_path

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.create_queue

create_queue(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta3.types.cloudtasks.CreateQueueRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    queue: typing.Optional[google.cloud.tasks_v2beta3.types.queue.Queue] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta3.types.queue.Queue

Creates a queue.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.create_queue

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.create_task

create_task(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta3.types.cloudtasks.CreateTaskRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    task: typing.Optional[google.cloud.tasks_v2beta3.types.task.Task] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta3.types.task.Task

Creates a task and adds it to a queue.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.create_task

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.delete_queue

delete_queue(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta3.types.cloudtasks.DeleteQueueRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a queue.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.delete_queue

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.delete_task

delete_task(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta3.types.cloudtasks.DeleteTaskRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a task.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.delete_task

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.from_service_account_file

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.from_service_account_info

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.from_service_account_json

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.get_iam_policy

get_iam_policy(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.policy_pb2.Policy

Gets the access control policy for a xref_Queue.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.get_iam_policy

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.get_location

get_location(
    request: typing.Optional[
        google.cloud.location.locations_pb2.GetLocationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.Location

Gets information about a location.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.get_location

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.get_mtls_endpoint_and_cert_source

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.get_queue

get_queue(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2beta3.types.cloudtasks.GetQueueRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta3.types.queue.Queue

Gets a queue.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.get_queue

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.get_task

get_task(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2beta3.types.cloudtasks.GetTaskRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta3.types.task.Task

Gets a task.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.get_task

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.list_locations

list_locations(
    request: typing.Optional[
        google.cloud.location.locations_pb2.ListLocationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse

Lists information about the supported locations for this service.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.list_locations

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.list_queues

list_queues(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta3.types.cloudtasks.ListQueuesRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta3.services.cloud_tasks.pagers.ListQueuesPager

Lists queues.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.list_queues

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.list_tasks

list_tasks(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2beta3.types.cloudtasks.ListTasksRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta3.services.cloud_tasks.pagers.ListTasksPager

Lists the tasks in a queue.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.list_tasks

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.parse_common_billing_account_path

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.parse_common_folder_path

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.parse_common_location_path

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.parse_common_organization_path

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.parse_common_project_path

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.parse_queue_path

parse_queue_path(path: str) -> typing.Dict[str, str]

Parses a queue path into its component segments.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.parse_queue_path

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.parse_task_path

parse_task_path(path: str) -> typing.Dict[str, str]

Parses a task path into its component segments.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.parse_task_path

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.pause_queue

pause_queue(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta3.types.cloudtasks.PauseQueueRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta3.types.queue.Queue

Pauses the queue.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.pause_queue

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.purge_queue

purge_queue(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta3.types.cloudtasks.PurgeQueueRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta3.types.queue.Queue

Purges a queue by deleting all of its tasks.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.purge_queue

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.queue_path

queue_path(project: str, location: str, queue: str) -> str

Returns a fully-qualified queue string.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.queue_path

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.resume_queue

resume_queue(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta3.types.cloudtasks.ResumeQueueRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta3.types.queue.Queue

Resume a queue.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.resume_queue

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.run_task

run_task(
    request: typing.Optional[
        typing.Union[google.cloud.tasks_v2beta3.types.cloudtasks.RunTaskRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta3.types.task.Task

Forces a task to run now.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.run_task

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.set_iam_policy

set_iam_policy(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.policy_pb2.Policy

Sets the access control policy for a xref_Queue.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.set_iam_policy

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.task_path

task_path(project: str, location: str, queue: str, task: str) -> str

Returns a fully-qualified task string.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.task_path

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.test_iam_permissions

test_iam_permissions(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    permissions: typing.Optional[typing.MutableSequence[str]] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse

Returns permissions that a caller has on a xref_Queue.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.test_iam_permissions

google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.update_queue

update_queue(
    request: typing.Optional[
        typing.Union[
            google.cloud.tasks_v2beta3.types.cloudtasks.UpdateQueueRequest, dict
        ]
    ] = None,
    *,
    queue: typing.Optional[google.cloud.tasks_v2beta3.types.queue.Queue] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.tasks_v2beta3.types.queue.Queue

Updates a queue.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.CloudTasksClient.update_queue

google.cloud.tasks_v2beta3.services.cloud_tasks.pagers.ListQueuesAsyncPager

ListQueuesAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.tasks_v2beta3.types.cloudtasks.ListQueuesResponse
        ],
    ],
    request: google.cloud.tasks_v2beta3.types.cloudtasks.ListQueuesRequest,
    response: google.cloud.tasks_v2beta3.types.cloudtasks.ListQueuesResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiates the pager.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.pagers.ListQueuesAsyncPager

google.cloud.tasks_v2beta3.services.cloud_tasks.pagers.ListQueuesPager

ListQueuesPager(
    method: typing.Callable[
        [...], google.cloud.tasks_v2beta3.types.cloudtasks.ListQueuesResponse
    ],
    request: google.cloud.tasks_v2beta3.types.cloudtasks.ListQueuesRequest,
    response: google.cloud.tasks_v2beta3.types.cloudtasks.ListQueuesResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiate the pager.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.pagers.ListQueuesPager

google.cloud.tasks_v2beta3.services.cloud_tasks.pagers.ListTasksAsyncPager

ListTasksAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[google.cloud.tasks_v2beta3.types.cloudtasks.ListTasksResponse],
    ],
    request: google.cloud.tasks_v2beta3.types.cloudtasks.ListTasksRequest,
    response: google.cloud.tasks_v2beta3.types.cloudtasks.ListTasksResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiates the pager.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.pagers.ListTasksAsyncPager

google.cloud.tasks_v2beta3.services.cloud_tasks.pagers.ListTasksPager

ListTasksPager(
    method: typing.Callable[
        [...], google.cloud.tasks_v2beta3.types.cloudtasks.ListTasksResponse
    ],
    request: google.cloud.tasks_v2beta3.types.cloudtasks.ListTasksRequest,
    response: google.cloud.tasks_v2beta3.types.cloudtasks.ListTasksResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiate the pager.

See more: google.cloud.tasks_v2beta3.services.cloud_tasks.pagers.ListTasksPager