airflow.providers.google.cloud.transfers.calendar_to_gcs¶
Module Contents¶
Classes¶
Writes Google Calendar data into Google Cloud Storage. |
- class airflow.providers.google.cloud.transfers.calendar_to_gcs.GoogleCalendarToGCSOperator(*, destination_bucket, api_version, calendar_id='primary', i_cal_uid=None, max_attendees=None, max_results=None, order_by=None, private_extended_property=None, text_search_query=None, shared_extended_property=None, show_deleted=None, show_hidden_invitation=None, single_events=None, sync_token=None, time_max=None, time_min=None, time_zone=None, updated_min=None, destination_path=None, gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶
Bases:
airflow.models.BaseOperatorWrites Google Calendar data into Google Cloud Storage.
See also
For more information on how to use this operator, take a look at the guide: Upload data from Google Calendar to GCS
- Parameters
calendar_id (str) – The Google Calendar ID to interact with.
i_cal_uid (str | None) – Optional. Specifies event ID in the
iCalendarformat in the response.max_attendees (int | None) – Optional. If there are more than the specified number of attendees, only the participant is returned.
max_results (int | None) – Optional. Maximum number of events returned on one result page. Incomplete pages can be detected by a non-empty
nextPageTokenfield in the response. By default the value is 250 events. The page size can never be larger than 2500 eventsorder_by (str | None) – Optional. Acceptable values are
"startTime"or “updated”private_extended_property (str | None) – Optional. Extended properties constraint specified as
propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.text_search_query (str | None) – Optional. Free text search.
shared_extended_property (str | None) – Optional. Extended properties constraint specified as
propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.show_deleted (bool | None) – Optional. False by default
show_hidden_invitation (bool | None) – Optional. False by default
single_events (bool | None) – Optional. False by default
sync_token (str | None) – Optional. Token obtained from the
nextSyncTokenfield returnedtime_max (datetime.datetime | None) – Optional. Upper bound (exclusive) for an event’s start time to filter by. Default is no filter
time_min (datetime.datetime | None) – Optional. Lower bound (exclusive) for an event’s end time to filter by. Default is no filter
time_zone (str | None) – Optional. Time zone used in response. Default is calendars time zone.
updated_min (datetime.datetime | None) – Optional. Lower bound for an event’s last modification time
destination_bucket (str) – The destination Google Cloud Storage bucket where the report should be written to. (templated)
destination_path (str | None) – The Google Cloud Storage URI array for the object created by the operator. For example:
path/to/my/files.gcp_conn_id (str) – The connection ID to use when fetching connection info.
impersonation_chain (str | collections.abc.Sequence[str] | None) – Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).