CloudMemorystoreListInstancesOperator

Google

Lists all Redis instances owned by a project in either the specified location (region) or all locations.

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

locationRequiredstrThe location of the Cloud Memorystore instance (for example europe-west1) If it is specified as - (wildcard), then all regions available to the project are queried, and the results are aggregated.
page_sizeRequiredintThe maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
project_idProject ID of the project that contains the instance. If set to None or missing, the default project_id from the Google Cloud connection is used.
retrygoogle.api_core.retry.RetryA retry object used to retry requests. If None is specified, requests will not be retried.
timeoutfloatThe amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadataSequence[Tuple[str, str]]Additional metadata that is provided to the method.
gcp_conn_idstrThe connection ID to use connecting to Google Cloud.
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

Lists all Redis instances owned by a project in either the specified location (region) or all locations.

See also

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

Was this page helpful?