airflow.providers.google.cloud.transfers.calendar_to_gcs¶
類¶
將 Google Calendar 資料寫入 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]¶
基類:
airflow.models.BaseOperator將 Google Calendar 資料寫入 Google Cloud Storage。
參見
有關如何使用此 operator 的更多資訊,請參閱指南:從 Google Calendar 上傳資料到 GCS
- 引數:
calendar_id (str) – 用於互動的 Google Calendar ID。
i_cal_uid (str | None) – 可選。指定響應中 `iCalendar` 格式的事件 ID。
max_attendees (int | None) – 可選。如果參與者多於指定數量,則只返回參與者。
max_results (int | None) – 可選。一頁結果返回的最大事件數。可以透過響應中非空的 `nextPageToken` 欄位檢測到不完整的頁面。預設值為 250 個事件。頁面大小不能超過 2500 個事件。
order_by (str | None) – 可選。可接受的值為 `"startTime"` 或 "updated"。
private_extended_property (str | None) – 可選。擴充套件屬性約束,格式為 `propertyName=value`。僅匹配私有屬性。此引數可以重複多次,以返回匹配所有給定約束的事件。
text_search_query (str | None) – 可選。自由文字搜尋。
shared_extended_property (str | None) – 可選。擴充套件屬性約束,格式為 `propertyName=value`。僅匹配共享屬性。此引數可以重複多次,以返回匹配所有給定約束的事件。
show_deleted (bool | None) – 可選。預設為 False。
show_hidden_invitation (bool | None) – 可選。預設為 False。
single_events (bool | None) – 可選。預設為 False。
sync_token (str | None) – 可選。從返回的 `nextSyncToken` 欄位獲取的令牌。
time_max (datetime.datetime | None) – 可選。過濾事件開始時間(不包含)的上限。預設為不過濾。
time_min (datetime.datetime | None) – 可選。過濾事件結束時間(不包含)的下限。預設為不過濾。
time_zone (str | None) – 可選。響應中使用的時區。預設為日曆的時區。
updated_min (datetime.datetime | None) – 可選。事件最後修改時間的下限。
destination_bucket (str) – 應將報告寫入的目標 Google Cloud Storage 儲存桶。(模板化)
destination_path (str | None) – Operator 建立的物件的 Google Cloud Storage URI 陣列。例如:`path/to/my/files`。
gcp_conn_id (str) – 獲取連線資訊時使用的連線 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可選的服務賬號,用於使用短期憑據進行模擬,或者獲取列表中最後一個賬號的 access_token 所需的賬號鏈,該賬號將在請求中被模擬。如果設定為字串,則該賬號必須授予原始賬號 Service Account Token Creator IAM 角色。如果設定為序列,列表中的身份必須授予緊接在其之前的身份 Service Account Token Creator IAM 角色,列表中第一個賬號將此角色授予原始賬號。(模板化)
- template_fields = ['calendar_id', 'destination_bucket', 'destination_path', 'impersonation_chain'][source]¶