airflow.providers.google.cloud.hooks.compute¶
此模块包含一个 Google Compute Engine Hook。
属性¶
类¶
包含 GCE 操作状态的类。 |
|
用于 Google Compute Engine API 的 Hook。 |
模块内容¶
- class airflow.providers.google.cloud.hooks.compute.ComputeEngineHook(api_version='v1', gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶
Bases:
airflow.providers.google.common.hooks.base_google.GoogleBaseHook
用于 Google Compute Engine API 的 Hook。
Hook 中所有使用 project_id 的方法必须使用关键字参数而不是位置参数调用。
- insert_instance_template(body, request_id=None, project_id=PROVIDE_PROJECT_ID, retry=None, timeout=None, metadata=())[source]¶
使用指定的 body 创建实例模板。
必须使用关键字参数而不是位置参数调用。
- 参数:
body (dict) – 实例模板的对象表示。
request_id (str | None) – 一个唯一的 request_id,您可以添加它以实现完全幂等性(例如,当客户端调用超时时,使用相同的 request id 重复请求将不会再次创建新的实例模板)。它应该采用 RFC 4122 中定义的 UUID 格式。
project_id (str) – Compute Engine 实例模板所在的 Google Cloud 项目 ID。如果设置为 None 或缺失,则使用 Google Cloud 连接中的默认 project_id。
retry (google.api_core.retry.Retry | None) – 用于重试请求的重试对象。如果指定为 None,则不会重试请求。
timeout (float | None) – 等待请求完成的秒数。请注意,如果指定了 retry,则超时适用于每次单独的尝试。
metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的附加元数据。
- delete_instance_template(resource_id, request_id=None, project_id=PROVIDE_PROJECT_ID, retry=None, timeout=None, metadata=())[source]¶
删除实例模板。
删除实例模板是永久性的,无法撤消。无法删除已被托管实例组使用的模板。必须使用关键字参数而不是位置参数调用。
- 参数:
resource_id (str) – Compute Engine 实例模板资源的名称。
request_id (str | None) – 一个唯一的 request_id,您可以添加它以实现完全幂等性(例如,当客户端调用超时时,使用相同的 request id 重复请求将不会再次创建新的实例模板)。它应该采用 RFC 4122 中定义的 UUID 格式。
project_id (str) – Compute Engine 实例模板所在的 Google Cloud 项目 ID。如果设置为 None 或缺失,则使用 Google Cloud 连接中的默认 project_id。
retry (google.api_core.retry.Retry | None) – 用于重试请求的重试对象。如果指定为 None,则不会重试请求。
timeout (float | None) – 等待请求完成的秒数。请注意,如果指定了 retry,则超时适用于每次单独的尝试。
metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的附加元数据。
- get_instance_template(resource_id, project_id=PROVIDE_PROJECT_ID, retry=None, timeout=None, metadata=())[source]¶
通过 project_id 和 resource_id 检索实例模板。
必须使用关键字参数而不是位置参数调用。
- 参数:
resource_id (str) – 实例模板的名称。
project_id (str) – Compute Engine 实例模板所在的 Google Cloud 项目 ID。如果设置为 None 或缺失,则使用 Google Cloud 连接中的默认 project_id。
retry (google.api_core.retry.Retry | None) – 用于重试请求的重试对象。如果指定为 None,则不会重试请求。
timeout (float | None) – 等待请求完成的秒数。请注意,如果指定了 retry,则超时适用于每次单独的尝试。
metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的附加元数据。
- 返回:
实例模板的对象表示,详见 https://cloud.google.com/compute/docs/reference/rest/v1/instanceTemplates
- 返回类型:
- insert_instance(body, zone, project_id=PROVIDE_PROJECT_ID, request_id=None, source_instance_template=None, retry=None, timeout=None, metadata=())[source]¶
使用指定的 body 创建实例。
必须使用关键字参数而不是位置参数调用。
- 参数:
body (dict) – 实例的对象表示。应至少包含 'name'、'machine_type'、'disks' 和 'network_interfaces' 字段,但不包含 'zone' 字段,因为它将在 'zone' 参数中指定。可以是完整或部分的 URL,示例如下:1. “machine_type”: “projects/your-project-name/zones/your-zone/machineTypes/your-machine-type” 2. “source_image”: “projects/your-project-name/zones/your-zone/diskTypes/your-disk-type” 3. “subnetwork”: “projects/your-project-name/regions/your-region/subnetworks/your-subnetwork”
zone (str) – 实例所在的 Google Cloud 区域。
project_id (str) – Compute Engine 实例模板所在的 Google Cloud 项目 ID。如果设置为 None 或缺失,则使用 Google Cloud 连接中的默认 project_id。
source_instance_template (str | None) – 现有的实例模板,将用作创建新实例的基础。指定此参数时,仅需在 'body' 参数中提供新实例的名称作为输入参数。所有其他参数将按照实例模板中的指定传递给新实例。可以是完整或部分的 URL,示例如下:1. “https://www.googleapis.com/compute/v1/projects/your-project/global/instanceTemplates/temp” 2. “projects/your-project/global/instanceTemplates/temp” 3. “global/instanceTemplates/temp”
request_id (str | None) – 一个唯一的 request_id,您可以添加它以实现完全幂等性(例如,当客户端调用超时时,使用相同的 request id 重复请求将不会再次创建新的实例模板)。它应该采用 RFC 4122 中定义的 UUID 格式。
retry (google.api_core.retry.Retry | None) – 用于重试请求的重试对象。如果指定为 None,则不会重试请求。
timeout (float | None) – 等待请求完成的秒数。请注意,如果指定了 retry,则超时适用于每次单独的尝试。
metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的附加元数据。
- get_instance(resource_id, zone, project_id=PROVIDE_PROJECT_ID, retry=None, timeout=None, metadata=())[source]¶
通过 project_id 和 resource_id 检索实例。
必须使用关键字参数而不是位置参数调用。
- 参数:
resource_id (str) – 实例的名称
zone (str) – 实例所在的 Google Cloud 区域。
project_id (str) – Compute Engine 实例所在的 Google Cloud 项目 ID。如果设置为 None 或缺失,则使用 Google Cloud 连接中的默认 project_id。
retry (google.api_core.retry.Retry | None) – 用于重试请求的重试对象。如果指定为 None,则不会重试请求。
timeout (float | None) – 等待请求完成的秒数。请注意,如果指定了 retry,则超时适用于每次单独的尝试。
metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的附加元数据。
- 返回:
实例的对象表示,详见 https://cloud.google.com/compute/docs/reference/rest/v1/instances
- 返回类型:
- delete_instance(resource_id, zone, project_id=PROVIDE_PROJECT_ID, request_id=None, retry=None, timeout=None, metadata=())[source]¶
永久且不可撤销地删除实例。
无法删除已被托管实例组使用的实例。必须使用关键字参数而不是位置参数调用。
- 参数:
resource_id (str) – Compute Engine 实例模板资源的名称。
request_id (str | None) – 一个唯一的 request_id,您可以添加它以实现完全幂等性(例如,当客户端调用超时时,使用相同的 request id 重复请求将不会再次创建新的实例模板)。它应该采用 RFC 4122 中定义的 UUID 格式。
project_id (str) – Compute Engine 实例模板所在的 Google Cloud 项目 ID。如果设置为 None 或缺失,则使用 Google Cloud 连接中的默认 project_id。
zone (str) – 实例所在的 Google Cloud 区域。
retry (google.api_core.retry.Retry | None) – 用于重试请求的重试对象。如果指定为 None,则不会重试请求。
timeout (float | None) – 等待请求完成的秒数。请注意,如果指定了 retry,则超时适用于每次单独的尝试。
metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的附加元数据。
- start_instance(zone, resource_id, project_id)[source]¶
启动由 project_id、zone 和 resource_id 定义的现有实例。
必须使用关键字参数而不是位置参数调用。
- stop_instance(zone, resource_id, project_id)[source]¶
停止由 project_id、zone 和 resource_id 定义的实例。
必须使用关键字参数而不是位置参数调用。
- set_machine_type(zone, resource_id, body, project_id)[source]¶
设置由 project_id、zone 和 resource_id 定义的实例的机器类型。
必须使用关键字参数而不是位置参数调用。
- 参数:
zone (str) – 实例所在的 Google Cloud 区域。
resource_id (str) – Compute Engine 实例资源的名称
body (dict) – Compute Engine setMachineType API 所需的 body,详见 https://cloud.google.com/compute/docs/reference/rest/v1/instances/setMachineType
project_id (str) – 可选,Compute Engine 实例所在的 Google Cloud 项目 ID。如果设置为 None 或缺失,则使用 Google Cloud 连接中的默认 project_id。
- 返回:
None
- 返回类型:
None
- insert_instance_group_manager(body, zone, project_id=PROVIDE_PROJECT_ID, request_id=None, retry=None, timeout=None, metadata=())[source]¶
使用指定的 body 创建实例组管理器。
创建组后,组中的实例将使用指定的实例模板创建。必须使用关键字参数而不是位置参数调用。
- 参数:
body (dict) – 实例组管理器的对象表示。
request_id (str | None) – 一个唯一的 request_id,您可以添加它以实现完全幂等性(例如,当客户端调用超时时,使用相同的 request id 重复请求将不会再次创建新的实例组管理器)。它应该采用 RFC 4122 中定义的 UUID 格式。
project_id (str) – Compute Engine 实例组管理器所在的 Google Cloud 项目 ID。如果设置为 None 或缺失,则使用 Google Cloud 连接中的默认 project_id。
zone (str) – 实例所在的 Google Cloud 区域。
retry (google.api_core.retry.Retry | None) – 用于重试请求的重试对象。如果指定为 None,则不会重试请求。
timeout (float | None) – 等待请求完成的秒数。请注意,如果指定了 retry,则超时适用于每次单独的尝试。
metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的附加元数据。
- get_instance_group_manager(resource_id, zone, project_id=PROVIDE_PROJECT_ID, retry=None, timeout=None, metadata=())[source]¶
通过 project_id、zone 和 resource_id 检索实例组管理器。
必须使用关键字参数而不是位置参数调用。
- 参数:
resource_id (str) – 托管实例组的名称
zone (str) – 实例组管理器所在的 Google Cloud 区域
project_id (str) – Compute Engine 实例组管理器所在的 Google Cloud 项目 ID。如果设置为 None 或缺失,则使用 Google Cloud 连接中的默认 project_id。
retry (google.api_core.retry.Retry | None) – 用于重试请求的重试对象。如果指定为 None,则不会重试请求。
timeout (float | None) – 等待请求完成的秒数。请注意,如果指定了 retry,则超时适用于每次单独的尝试。
metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的附加元数据。
- 返回:
实例组管理器的对象表示,详见 https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers
- 返回类型:
- delete_instance_group_manager(resource_id, zone, project_id=PROVIDE_PROJECT_ID, request_id=None, retry=None, timeout=None, metadata=())[source]¶
永久且不可撤销地删除实例组管理器。
必须使用关键字参数而不是位置参数调用。
- 参数:
resource_id (str) – Compute Engine 实例组管理器资源的名称。
request_id (str | None) – 一个唯一的 request_id,您可以添加它以实现完全幂等性(例如,当客户端调用超时时,使用相同的 request id 重复请求将不会再次创建新的实例模板)。它应该采用 RFC 4122 中定义的 UUID 格式。
project_id (str) – Compute Engine 实例组管理器所在的 Google Cloud 项目 ID。如果设置为 None 或缺失,则使用 Google Cloud 连接中的默认 project_id。
zone (str) – 实例组管理器所在的 Google Cloud 区域
retry (google.api_core.retry.Retry | None) – 用于重试请求的重试对象。如果指定为 None,则不会重试请求。
timeout (float | None) – 等待请求完成的秒数。请注意,如果指定了 retry,则超时适用于每次单独的尝试。
metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的附加元数据。
- patch_instance_group_manager(zone, resource_id, body, project_id, request_id=None)[source]¶
使用指定的 body 修补实例组管理器。
必须使用关键字参数而不是位置参数调用。
- 参数:
zone (str) – 实例组管理器所在的 Google Cloud 区域
resource_id (str) – 实例组管理器的名称
body (dict) – 实例组管理器的 json 合并补丁对象表示,详见 https://cloud.google.com/compute/docs/reference/rest/beta/instanceTemplates/patch
request_id (str | None) – 可选,一个唯一的 request_id,您可以添加它以实现完全幂等性(例如,当客户端调用超时时,使用相同的 request id 重复请求将不会再次创建新的实例模板)。它应该采用 RFC 4122 中定义的 UUID 格式。
project_id (str) – 可选,Compute Engine 实例所在的 Google Cloud 项目 ID。如果设置为 None 或缺失,则使用 Google Cloud 连接中的默认 project_id。
- 返回:
None
- 返回类型:
None
- get_instance_address(zone, resource_id, project_id=PROVIDE_PROJECT_ID, use_internal_ip=False)[source]¶
返回与实例关联的网络地址。