GoogletasksClient
Attributes
module-attribute
TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'OnNewTaskList': {'operation_id': 'OnNewTaskList', 'path': '/{connectionId}/trigger1/users/@me/lists', 'method': 'get', 'required_parameters': [], 'callback_payload_type': 'TaskListList'}, 'OnNewTaskInList': {'operation_id': 'OnNewTaskInList', 'path': '/{connectionId}/trigger2/lists/{taskListId}/tasks', 'method': 'get', 'required_parameters': ['taskListId'], 'callback_payload_type': 'TaskList'}, 'OnDueTaskInList': {'operation_id': 'OnDueTaskInList', 'path': '/{connectionId}/trigger4/lists/{taskListId}/tasks', 'method': 'get', 'required_parameters': ['taskListId'], 'callback_payload_type': 'TaskList'}, 'OnCompletedTaskInListV2': {'operation_id': 'OnCompletedTaskInListV2', 'path': '/{connectionId}/trigger5/lists/{taskListId}/tasks', 'method': 'get', 'required_parameters': ['taskListId'], 'callback_payload_type': 'TaskList'}}
Classes
dataclass
dataclass
TaskListEntry(*, id: Optional[str] = None, title: Optional[str] = None, self_link: Optional[str] = None, updated: Optional[str] = None)
Response for Create a task list
Attributes
class-attribute
instance-attribute
The identifier of the task list.
class-attribute
instance-attribute
The title of the task list.
dataclass
dataclass
TaskObject(*, id: Optional[str] = None, title: Optional[str] = None, updated: Optional[str] = None, self_link: Optional[str] = None, parent: Optional[str] = None, position: Optional[str] = None, notes: Optional[str] = None, status: Optional[str] = None, due: Optional[str] = None, completed: Optional[str] = None)
Response for Create a task in a task list
Attributes
class-attribute
instance-attribute
The identifier of the task.
class-attribute
instance-attribute
The title of the task.
class-attribute
instance-attribute
The last time the task was updated.
class-attribute
instance-attribute
self_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'selfLink'})
A link to the task.
class-attribute
instance-attribute
The parent of the task.
class-attribute
instance-attribute
The position of the task.
class-attribute
instance-attribute
The notes for the task.
class-attribute
instance-attribute
The status of the task.
class-attribute
instance-attribute
The datetime the task is due.
dataclass
dataclass
Definition: TaskCreate
Attributes
class-attribute
instance-attribute
The notes for the task.
GoogletasksClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)
Bases: ConnectorClientBase
Typed client for googletasks connector.
Initialize a GoogletasksClient.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_runtime_url
|
str
|
The connection runtime URL from Azure Portal. |
required |
credential
|
AsyncTokenCredential | AzureKeyCredential
|
Caller-owned Azure Core credential. |
required |
max_retry_attempts
|
int
|
The maximum number of request attempts. |
3
|
timeout
|
float
|
The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. |
30.0
|
use_exponential_backoff
|
bool
|
Whether retries use exponential backoff. |
True
|
initial_retry_delay_seconds
|
float
|
The initial retry delay in seconds. |
0.5
|
maximum_retry_delay_seconds
|
float
|
The maximum retry delay in seconds. |
120.0
|
retry_jitter_factor
|
float
|
The jitter fraction applied to retry delays. |
0.1
|
retry_unsafe_http_methods
|
bool
|
Whether unsafe HTTP methods may be retried. |
False
|
transport
|
Optional[AsyncHttpTransport]
|
Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle. |
None
|
**kwargs
|
Any
|
Optional Azure Core pipeline policy settings. |
{}
|
Methods:
list_task_lists(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
List task lists
List all task lists.
Returns a single-page Azure Core async collection.
Swagger operation ID: ListTaskLists.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
create_task_list(input: TaskListCreate | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Create a task list
Creates a new task list.
Swagger operation ID: CreateTaskList.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
TaskListCreate | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_tasks(task_list_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Lists the tasks for a task list
Lists the tasks for a specific task list.
Returns a single-page Azure Core async collection.
Swagger operation ID: ListTasks.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
task_list_id
|
str
|
The id of the task list. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
create_task(input: TaskCreate | Mapping[str, Any], task_list_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Create a task in a task list
Create a task in a specific task list.
Swagger operation ID: CreateTask.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
TaskCreate | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
task_list_id
|
str
|
The id of the task list. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
list_task(task_list_id: str, task_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get a task from a task list
Get specific task from the specified task list.
Swagger operation ID: ListTask.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
task_list_id
|
str
|
The id of the task list. |
required |
task_id
|
str
|
The id of the task. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |