ComputeEngineSetMachineTypeOperator

Google

the request.

View on GitHub

Last Updated: May. 7, 2021

Access Instructions

Install the Google provider package into your Airflow environment.

Import the module into your DAG file and instantiate it with your desired params.

Parameters

zoneRequiredstrGoogle Cloud zone where the instance exists.
resource_idRequiredstrName of the Compute Engine instance resource.
bodyRequireddictBody required by the Compute Engine setMachineType API, as described in https://cloud.google.com/compute/docs/reference/rest/v1/instances/setMachineType#request-body
project_idstrOptional, Google Cloud Project ID where the Compute Engine Instance exists. If set to None or missing, the default project_id from the Google Cloud connection is used.
gcp_conn_idstrOptional, The connection ID used to connect to Google Cloud. Defaults to ‘google_cloud_default’.
api_versionstrOptional, API version used (for example v1 - or beta). Defaults to v1.
validate_bodyboolOptional, If set to False, body validation is not performed. Defaults to False.
impersonation_chainUnion[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).

Documentation

See also

For more information on how to use this operator, take a look at the guide: ComputeEngineSetMachineTypeOperator

param zone

Google Cloud zone where the instance exists.

type zone

str

param resource_id

Name of the Compute Engine instance resource.

type resource_id

str

param body

Body required by the Compute Engine setMachineType API, as described in https://cloud.google.com/compute/docs/reference/rest/v1/instances/setMachineType#request-body

type body

dict

param project_id

Optional, Google Cloud Project ID where the Compute Engine Instance exists. If set to None or missing, the default project_id from the Google Cloud connection is used.

type project_id

str

param gcp_conn_id

Optional, The connection ID used to connect to Google Cloud. Defaults to ‘google_cloud_default’.

type gcp_conn_id

str

param api_version

Optional, API version used (for example v1 - or beta). Defaults to v1.

type api_version

str

param validate_body

Optional, If set to False, body validation is not performed. Defaults to False.

type validate_body

bool

param impersonation_chain

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).

type impersonation_chain

Union[str, Sequence[str]]

Was this page helpful?