airflow.providers.google.cloud.transfers.calendar_to_gcs

Module Contents

Classes

GoogleCalendarToGCSOperator

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', delegate_to=None, impersonation_chain=None, **kwargs)[source]

Bases: airflow.models.BaseOperator

Writes 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 (Optional[str]) – Optional. Specifies event ID in the iCalendar format in the response.

  • max_attendees (Optional[int]) – Optional. If there are more than the specified number of attendees, only the participant is returned.

  • max_results (Optional[int]) – Optional. Maximum number of events returned on one result page. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events

  • order_by (Optional[str]) – Optional. Acceptable values are "startTime" or “updated”

  • private_extended_property (Optional[str]) – 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 (Optional[str]) – Optional. Free text search.

  • shared_extended_property (Optional[str]) – 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 (Optional[bool]) – Optional. False by default

  • show_hidden_invitation (Optional[bool]) – Optional. False by default

  • single_events (Optional[bool]) – Optional. False by default

  • sync_token (Optional[str]) – Optional. Token obtained from the nextSyncToken field returned

  • time_max (Optional[datetime.datetime]) – Optional. Upper bound (exclusive) for an event’s start time to filter by. Default is no filter

  • time_min (Optional[datetime.datetime]) – Optional. Lower bound (exclusive) for an event’s end time to filter by. Default is no filter

  • time_zone (Optional[str]) – Optional. Time zone used in response. Default is calendars time zone.

  • updated_min (Optional[datetime.datetime]) – 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 (Optional[str]) – 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.

  • delegate_to (Optional[str]) – The account to impersonate using domain-wide delegation of authority, if any. For this to work, the service account making the request must have domain-wide delegation enabled.

  • impersonation_chain (Optional[Union[str, Sequence[str]]]) – 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).

template_fields = ['calendar_id', 'destination_bucket', 'destination_path', 'impersonation_chain'][source]
execute(context)[source]

This is the main method to derive when creating an operator. Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

Was this entry helpful?