GooglecalendarClient
Attributes
module-attribute
TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'OnNewEventInCalendar': {'operation_id': 'OnNewEventInCalendar', 'path': '/{connectionId}/trigger1/calendars/{calendar_id}/events', 'method': 'get', 'required_parameters': ['calendar_id'], 'callback_payload_type': 'CalendarEventList'}, 'OnUpdatedEventInCalendar': {'operation_id': 'OnUpdatedEventInCalendar', 'path': '/{connectionId}/trigger2/calendars/{calendar_id}/events', 'method': 'get', 'required_parameters': ['calendar_id'], 'callback_payload_type': 'CalendarEventList'}, 'OnDeletedEventInCalendar': {'operation_id': 'OnDeletedEventInCalendar', 'path': '/{connectionId}/trigger3/calendars/{calendar_id}/events', 'method': 'get', 'required_parameters': ['calendar_id'], 'callback_payload_type': 'CalendarEventList'}, 'OnChangedEventInCalendar': {'operation_id': 'OnChangedEventInCalendar', 'path': '/{connectionId}/trigger4/calendars/{calendar_id}/events', 'method': 'get', 'required_parameters': ['calendar_id'], 'callback_payload_type': 'CalendarEventChangedList'}, 'OnEventStarted': {'operation_id': 'OnEventStarted', 'path': '/{connectionId}/eventstarted/calendars/{calendar_id}/events', 'method': 'get', 'required_parameters': ['calendar_id'], 'callback_payload_type': 'CalendarEventList'}}
Classes
dataclass
dataclass
dataclass
ResponseEvent(*, summary: Optional[str] = None, start: Optional[str] = None, end: Optional[str] = None, description: Optional[str] = None, location: Optional[str] = None, status: Optional[str] = None, html_link: Optional[str] = None, id: Optional[str] = None, attendees: Optional[str] = None, creator: Optional[str] = None, organizer: Optional[str] = None, created: Optional[str] = None, updated: Optional[str] = None, end_time_unspecified: Optional[bool] = None)
Response for Create an event
Attributes
class-attribute
instance-attribute
A summary of the event.
class-attribute
instance-attribute
The (inclusive) start time of the event.
class-attribute
instance-attribute
The (exclusive) end time of the event.
class-attribute
instance-attribute
Description of the event.
class-attribute
instance-attribute
Geographic location of the event as free-form text.
class-attribute
instance-attribute
Status of the event. Possible values are "confirmed", "tentative", or "cancelled".
class-attribute
instance-attribute
html_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'htmlLink'})
Unique ID of the list.
class-attribute
instance-attribute
Opaque identifier of the event.
class-attribute
instance-attribute
The event's attendees.
class-attribute
instance-attribute
The creator of the event.
class-attribute
instance-attribute
The organizer of the event.
class-attribute
instance-attribute
Creation time of the event.
class-attribute
instance-attribute
Last modification time of the event.
class-attribute
instance-attribute
end_time_unspecified: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'endTimeUnspecified'})
Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True.
dataclass
dataclass
dataclass
CalendarListEntry(*, id: Optional[str] = None, summary: Optional[str] = None, description: Optional[str] = None, location: Optional[str] = None, time_zone: Optional[str] = None)
Definition: CalendarListEntry
Attributes
class-attribute
instance-attribute
Identifier of the calendar.
class-attribute
instance-attribute
Title of the calendar.
class-attribute
instance-attribute
Description of the calendar.
class-attribute
instance-attribute
Geographic location of the calendar as free-form text.
dataclass
RequestEvent(start: str, end: str, *, summary: Optional[str] = None, description: Optional[str] = None, location: Optional[str] = None, attendees: Optional[str] = None, status: Optional[str] = None, is_all_day: Optional[bool] = None)
Definition: RequestEvent
Attributes
class-attribute
instance-attribute
A summary of the event.
class-attribute
instance-attribute
Description of the event.
class-attribute
instance-attribute
Geographic location of the event as free-form text.
class-attribute
instance-attribute
Enter a comma-separated list of attendee emails.
class-attribute
instance-attribute
Status of the event. Possible values are "confirmed", "tentative", or "cancelled".
dataclass
PatchEvent(*, summary: Optional[str] = None, start: Optional[str] = None, end: Optional[str] = None, description: Optional[str] = None, location: Optional[str] = None, attendees: Optional[str] = None, status: Optional[str] = None, is_all_day: Optional[bool] = None)
Definition: PatchEvent
Attributes
class-attribute
instance-attribute
A summary of the event.
class-attribute
instance-attribute
The (inclusive) start time of the event.
class-attribute
instance-attribute
The (exclusive) end time of the event.
class-attribute
instance-attribute
Description of the event.
class-attribute
instance-attribute
Geographic location of the event as free-form text.
class-attribute
instance-attribute
Enter a comma-separated list of attendee emails.
class-attribute
instance-attribute
Status of the event. Possible values are "confirmed", "tentative", or "cancelled.
dataclass
ResponseEventWithActionType(*, action_type: Optional[str] = None, summary: Optional[str] = None, start: Optional[str] = None, end: Optional[str] = None, description: Optional[str] = None, location: Optional[str] = None, status: Optional[str] = None, html_link: Optional[str] = None, id: Optional[str] = None, attendees: Optional[str] = None, creator: Optional[str] = None, organizer: Optional[str] = None, created: Optional[str] = None, updated: Optional[str] = None, end_time_unspecified: Optional[bool] = None)
Definition: ResponseEventWithActionType
Attributes
class-attribute
instance-attribute
action_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'actionType'})
Type of action which changed the event in change trigger.
class-attribute
instance-attribute
A summary of the event.
class-attribute
instance-attribute
The (inclusive) start time of the event.
class-attribute
instance-attribute
The (exclusive) end time of the event.
class-attribute
instance-attribute
Description of the event.
class-attribute
instance-attribute
Geographic location of the event as free-form text.
class-attribute
instance-attribute
Status of the event. Possible values are "confirmed", "tentative", or "cancelled".
class-attribute
instance-attribute
html_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'htmlLink'})
Unique ID of the list.
class-attribute
instance-attribute
Opaque identifier of the event.
class-attribute
instance-attribute
The event's attendees.
class-attribute
instance-attribute
The creator of the event.
class-attribute
instance-attribute
The organizer of the event.
class-attribute
instance-attribute
Creation time of the event.
class-attribute
instance-attribute
Last modification time of the event.
class-attribute
instance-attribute
end_time_unspecified: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'endTimeUnspecified'})
Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True.
GooglecalendarClient(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 googlecalendar connector.
Initialize a GooglecalendarClient.
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_calendars(*, min_access_role: Optional[str] = None, 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 calendars
This operation is used to list all calendars in your Google account.
Returns a single-page Azure Core async collection.
Swagger operation ID: ListCalendars.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
min_access_role
|
Optional[str]
|
The minimum access role users must have to view calendars. |
None
|
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. |
list_events(calendar_id: str, *, time_min: Optional[str] = None, time_max: Optional[str] = None, q: Optional[str] = None, 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 the events on a calendar
This operation is used to return the first page of arbitrarily ordered events on the selected calendar.
Returns a single-page Azure Core async collection.
Swagger operation ID: ListEvents.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
calendar_id
|
str
|
Unique ID of the calendar to fetch events from. |
required |
time_min
|
Optional[str]
|
Time format: yyyy-MM-ddTHH:mm:ss.fffZ (2016-07-20T08:00:00.000Z). |
None
|
time_max
|
Optional[str]
|
Time format: yyyy-MM-ddTHH:mm:ss.fffZ (2016-07-20T09:00:59.000Z). |
None
|
q
|
Optional[str]
|
Text search terms to find events that match these terms in any fields. |
None
|
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_event(input: RequestEvent | Mapping[str, Any], calendar_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 an event
This operation is used to create an event on a specific calendar.
Swagger operation ID: CreateEvent.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
RequestEvent | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
calendar_id
|
str
|
Unique ID of the calendar to fetch events from. |
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
get_event(calendar_id: str, event_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 an event
This operation is used to get the details of a specific event from a calendar.
Swagger operation ID: GetEvent.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
calendar_id
|
str
|
Unique ID of the calendar to fetch events from. |
required |
event_id
|
str
|
Unique ID of the event to get. |
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
delete_event(calendar_id: str, event_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
Delete an event
This operation is used to delete an event from a calendar.
Swagger operation ID: DeleteEvent.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
calendar_id
|
str
|
Unique ID of the calendar to fetch events from. |
required |
event_id
|
str
|
Unique ID of the event to update. |
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
update_event(input: PatchEvent | Mapping[str, Any], calendar_id: str, event_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
Update an event
This operation is used to update an existing event on a calendar.
Swagger operation ID: UpdateEvent.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PatchEvent | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
calendar_id
|
str
|
Unique ID of the calendar to fetch events from. |
required |
event_id
|
str
|
Unique ID of the event to get. |
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_writable_calendars(*, 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 writable calendars
This operation is used to list all calendars in your Google account that you can write to.
Returns a single-page Azure Core async collection.
Swagger operation ID: ListWritableCalendars.
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. |