or run

npx @tessl/cli init

Version

Tile

Overview

Evals

Files

docs

client-operations.md iam-security.md index.md queue-configuration.md queue-management.md task-management.md task-targeting.md

tile.json

tessl/pypi-google-cloud-tasks

Google Cloud Tasks API client library for managing distributed task queues.

Workspace: tessl
Visibility: Public
Created: 3 months ago
Last updated: 3 months ago
Describes: pkg:pypi/google-cloud-tasks@2.19.x

To install, run

npx @tessl/cli install tessl/pypi-google-cloud-tasks@2.19.0

Google Cloud Tasks

Google Cloud Tasks is a fully managed service that allows you to manage the execution, dispatch and delivery of a large number of distributed tasks. It enables asynchronous task execution with HTTP endpoints or App Engine applications, featuring automatic retry logic, rate limiting, and comprehensive queue management.

Package Information

Package Name: google-cloud-tasks
Language: Python
Installation: pip install google-cloud-tasks

Core Imports

from google.cloud import tasks

For specific components:

from google.cloud.tasks import CloudTasksClient, CloudTasksAsyncClient
from google.cloud.tasks import Queue, Task, HttpRequest, AppEngineHttpRequest
from typing import Dict

Basic Usage

from google.cloud import tasks

# Create a client
client = tasks.CloudTasksClient()

# Define project, location, and queue
project = 'my-project-id'
location = 'us-central1'
queue_name = 'my-queue'

# Create a queue
parent = client.common_location_path(project, location)
queue_path = client.queue_path(project, location, queue_name)

queue = tasks.Queue(name=queue_path)
created_queue = client.create_queue(parent=parent, queue=queue)

# Create an HTTP task
task = tasks.Task(
    http_request=tasks.HttpRequest(
        url='https://example.com/task-handler',
        http_method=tasks.HttpMethod.POST,
        body=b'{"data": "example"}'
    )
)

# Add the task to the queue
response = client.create_task(parent=queue_path, task=task)
print(f'Created task: {response.name}')

# Using context manager for automatic resource cleanup
with tasks.CloudTasksClient() as client:
    queue = client.get_queue(name=queue_path)
    print(f'Queue state: {queue.state}')

Architecture

Google Cloud Tasks provides a comprehensive task queue system with these key components:

Clients: Synchronous and asynchronous clients for API operations
Queues: Containers for tasks with configurable rate limits, retry policies, and routing
Tasks: Units of work that can target HTTP endpoints or App Engine applications
Request/Response Types: Structured message types for all API operations
Authentication: OAuth and OIDC token support for secure task execution

The service integrates with Google Cloud IAM for access control and provides automatic scaling, monitoring, and error handling for distributed task processing.

Capabilities

Client Operations

Core client functionality for managing Cloud Tasks service connections, authentication, and transport configuration. Includes both synchronous and asynchronous clients with identical APIs.

class CloudTasksClient:
    def __init__(
        self, 
        *, 
        credentials=None, 
        transport=None, 
        client_options=None, 
        client_info=None
    ): ...
    
    @classmethod
    def from_service_account_file(cls, filename: str, *args, **kwargs): ...
    
    @classmethod
    def from_service_account_info(cls, info: dict, *args, **kwargs): ...

class CloudTasksAsyncClient:
    def __init__(
        self, 
        *, 
        credentials=None, 
        transport=None, 
        client_options=None, 
        client_info=None
    ): ...

Client Operations

Queue Management

Comprehensive queue lifecycle management including creation, configuration, monitoring, and control operations. Queues serve as containers for tasks with configurable rate limits, retry policies, and routing rules.

def list_queues(self, request=None, *, parent=None, retry=DEFAULT, timeout=DEFAULT, metadata=()) -> ListQueuesPager: ...
def get_queue(self, request=None, *, name=None, retry=DEFAULT, timeout=DEFAULT, metadata=()) -> Queue: ...
def create_queue(self, request=None, *, parent=None, queue=None, retry=DEFAULT, timeout=DEFAULT, metadata=()) -> Queue: ...
def update_queue(self, request=None, *, queue=None, update_mask=None, retry=DEFAULT, timeout=DEFAULT, metadata=()) -> Queue: ...
def delete_queue(self, request=None, *, name=None, retry=DEFAULT, timeout=DEFAULT, metadata=()) -> None: ...
def purge_queue(self, request=None, *, name=None, retry=DEFAULT, timeout=DEFAULT, metadata=()) -> Queue: ...
def pause_queue(self, request=None, *, name=None, retry=DEFAULT, timeout=DEFAULT, metadata=()) -> Queue: ...
def resume_queue(self, request=None, *, name=None, retry=DEFAULT, timeout=DEFAULT, metadata=()) -> Queue: ...

Queue Management

Task Management

Task lifecycle operations for creating, monitoring, and executing distributed work units. Tasks can target HTTP endpoints or App Engine applications with configurable scheduling, authentication, and retry behavior.

def list_tasks(self, request=None, *, parent=None, retry=DEFAULT, timeout=DEFAULT, metadata=()) -> ListTasksPager: ...
def get_task(self, request=None, *, name=None, retry=DEFAULT, timeout=DEFAULT, metadata=()) -> Task: ...
def create_task(self, request=None, *, parent=None, task=None, retry=DEFAULT, timeout=DEFAULT, metadata=()) -> Task: ...
def delete_task(self, request=None, *, name=None, retry=DEFAULT, timeout=DEFAULT, metadata=()) -> None: ...
def run_task(self, request=None, *, name=None, retry=DEFAULT, timeout=DEFAULT, metadata=()) -> Task: ...

Task Management

Queue Configuration

Advanced queue configuration options including rate limiting, retry policies, App Engine routing, and logging settings for fine-tuned task processing behavior.

class Queue:
    name: str
    app_engine_routing_override: AppEngineRouting
    rate_limits: RateLimits
    retry_config: RetryConfig
    state: Queue.State
    purge_time: Timestamp
    stackdriver_logging_config: StackdriverLoggingConfig

class RateLimits:
    max_dispatches_per_second: float
    max_burst_size: int
    max_concurrent_dispatches: int

class RetryConfig:
    max_attempts: int
    max_retry_duration: Duration
    min_backoff: Duration
    max_backoff: Duration
    max_doublings: int

Queue Configuration

Task Targeting

Task target configuration for HTTP endpoints and App Engine applications, including authentication, routing, and request formatting options.

class HttpRequest:
    url: str
    http_method: HttpMethod
    headers: MutableMapping[str, str]
    body: bytes
    oauth_token: OAuthToken  # mutually exclusive with oidc_token
    oidc_token: OidcToken    # mutually exclusive with oauth_token

class AppEngineHttpRequest:
    http_method: HttpMethod
    app_engine_routing: AppEngineRouting
    relative_uri: str
    headers: MutableMapping[str, str]
    body: bytes

class AppEngineRouting:
    service: str
    version: str
    instance: str
    host: str

Task Targeting

IAM and Security

Identity and Access Management integration for queue-level access control, including policy management and permission testing for secure task queue operations.

def get_iam_policy(self, request=None, *, resource=None, retry=DEFAULT, timeout=DEFAULT, metadata=()) -> Policy: ...
def set_iam_policy(self, request=None, *, resource=None, retry=DEFAULT, timeout=DEFAULT, metadata=()) -> Policy: ...
def test_iam_permissions(self, request=None, *, resource=None, permissions=None, retry=DEFAULT, timeout=DEFAULT, metadata=()): ...

IAM and Security

Location Management

Service location discovery and information retrieval for managing Google Cloud Tasks across different geographic regions.

def get_location(self, request=None, *, name=None, retry=DEFAULT, timeout=DEFAULT, metadata=()) -> Location: ...
def list_locations(self, request=None, *, name=None, retry=DEFAULT, timeout=DEFAULT, metadata=()) -> ListLocationsResponse: ...

Path Utilities

Resource path construction and parsing utilities for building proper resource names and extracting components from resource paths.

@staticmethod
def queue_path(project: str, location: str, queue: str) -> str: ...
@staticmethod  
def task_path(project: str, location: str, queue: str, task: str) -> str: ...
@staticmethod
def common_location_path(project: str, location: str) -> str: ...
@staticmethod
def common_project_path(project: str) -> str: ...
@staticmethod
def parse_queue_path(path: str) -> Dict[str, str]: ...
@staticmethod
def parse_task_path(path: str) -> Dict[str, str]: ...
@staticmethod
def parse_common_location_path(path: str) -> Dict[str, str]: ...

Usage example:

# Build resource paths
queue_path = client.queue_path('my-project', 'us-central1', 'my-queue')
task_path = client.task_path('my-project', 'us-central1', 'my-queue', 'task-123')

# Parse resource paths
components = client.parse_queue_path(queue_path)
# Returns: {'project': 'my-project', 'location': 'us-central1', 'queue': 'my-queue'}

Client Properties

Advanced client configuration and introspection capabilities for transport management and endpoint configuration.

@property
def transport(self) -> CloudTasksTransport: ...
@property  
def api_endpoint(self) -> str: ...
@property
def universe_domain(self) -> str: ...

Common Types

HttpMethod

class HttpMethod:
    HTTP_METHOD_UNSPECIFIED = 0
    POST = 1
    GET = 2
    HEAD = 3
    PUT = 4
    DELETE = 5
    PATCH = 6
    OPTIONS = 7

Authentication Types

class OAuthToken:
    service_account_email: str
    scope: str

class OidcToken:
    service_account_email: str
    audience: str

Task and Attempt Types

class Task:
    name: str
    app_engine_http_request: AppEngineHttpRequest  # mutually exclusive with http_request
    http_request: HttpRequest                      # mutually exclusive with app_engine_http_request
    schedule_time: Timestamp
    create_time: Timestamp
    dispatch_deadline: Duration
    dispatch_count: int
    response_count: int
    first_attempt: Attempt
    last_attempt: Attempt
    view: Task.View

class Attempt:
    schedule_time: Timestamp
    dispatch_time: Timestamp
    response_time: Timestamp
    response_status: Status

Additional Types

class StackdriverLoggingConfig:
    sampling_ratio: float

Enums

class Queue.State:
    STATE_UNSPECIFIED = 0
    RUNNING = 1
    PAUSED = 2
    DISABLED = 3

class Task.View:
    VIEW_UNSPECIFIED = 0
    BASIC = 1
    FULL = 2

Version

Tile

Files

tessl/pypi-google-cloud-tasks

To install, run

index.md.css-3qkkll{font-size:var(--chakra-font-sizes-sm);font-weight:var(--chakra-font-weights-normal);color:var(--chakra-colors-gray-300);}docs/

Google Cloud Tasks

Package Information

Core Imports

Basic Usage

Architecture

Capabilities

Client Operations

Queue Management

Task Management

Queue Configuration

Task Targeting

IAM and Security

Location Management

Path Utilities

Client Properties

Common Types

HttpMethod

Authentication Types

Task and Attempt Types

Additional Types

Enums

index.mddocs/