airflow.providers.google.cloud.operators.cloud_memorystore

Operators for Google Cloud Memorystore service.

Module Contents

Classes

CloudMemorystoreCreateInstanceOperator

Creates a Redis instance based on the specified tier and memory size.

CloudMemorystoreDeleteInstanceOperator

Deletes a specific Redis instance. Instance stops serving and data is deleted.

CloudMemorystoreExportInstanceOperator

Export Redis instance data into a Redis RDB format file in Cloud Storage.

CloudMemorystoreFailoverInstanceOperator

Initiate a failover of the primary node for a specific STANDARD tier Cloud Memorystore for Redis instance.

CloudMemorystoreGetInstanceOperator

Gets the details of a specific Redis instance.

CloudMemorystoreImportOperator

Import a Redis RDB snapshot file from Cloud Storage into a Redis instance.

CloudMemorystoreListInstancesOperator

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

CloudMemorystoreUpdateInstanceOperator

Updates the metadata and configuration of a specific Redis instance.

CloudMemorystoreScaleInstanceOperator

Updates the metadata and configuration of a specific Redis instance.

CloudMemorystoreCreateInstanceAndImportOperator

Create a Redis instance and import a Redis RDB snapshot file from Cloud Storage into this instance.

CloudMemorystoreExportAndDeleteInstanceOperator

Export Redis instance data into a Redis RDB format file in Cloud Storage.

CloudMemorystoreMemcachedApplyParametersOperator

Will update current set of Parameters to the set of specified nodes of the Memcached Instance.

CloudMemorystoreMemcachedCreateInstanceOperator

Creates a Memcached instance based on the specified tier and memory size.

CloudMemorystoreMemcachedDeleteInstanceOperator

Deletes a specific Memcached instance. Instance stops serving and data is deleted.

CloudMemorystoreMemcachedGetInstanceOperator

Gets the details of a specific Memcached instance.

CloudMemorystoreMemcachedListInstancesOperator

List all Memcached instances owned by a project in either the specified location/region or all locations.

CloudMemorystoreMemcachedUpdateInstanceOperator

Updates the metadata and configuration of a specific Memcached instance.

CloudMemorystoreMemcachedUpdateParametersOperator

Updates the defined Memcached Parameters for an existing Instance.
class airflow.providers.google.cloud.operators.cloud_memorystore.CloudMemorystoreCreateInstanceOperator(*, location, instance_id, instance, project_id=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

Creates a Redis instance based on the specified tier and memory size.

By default, the instance is accessible from the project’s default network.

See also

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

Parameters

  • location (str) – The location of the Cloud Memorystore instance (for example europe-west1)

  • instance_id (str) –

    Required. The logical name of the Redis instance in the customer project with the following restrictions:

    • Must contain only lowercase letters, numbers, and hyphens.

    • Must start with a letter.

    • Must be between 1-40 characters.

    • Must end with a number or a letter.

    • Must be unique within the customer project / location

  • instance (dict | google.cloud.redis_v1.Instance) –

    Required. A Redis [Instance] resource

    If a dict is provided, it must be of the same form as the protobuf message Instance

  • project_id (str | None) – Project 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.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The 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.

  • metadata (Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

  • gcp_conn_id (str) – The connection ID to use connecting to Google Cloud.

  • impersonation_chain (str | Sequence[str] | None) – 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: Sequence[str] = ('location', 'instance_id', 'instance', 'project_id', 'retry', 'timeout', 'metadata',...[source]
execute(context)[source]

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.cloud_memorystore.CloudMemorystoreDeleteInstanceOperator(*, location, instance, project_id=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

Deletes a specific Redis instance. Instance stops serving and data is deleted.

See also

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

Parameters

  • location (str) – The location of the Cloud Memorystore instance (for example europe-west1)

  • instance (str) – The logical name of the Redis instance in the customer project.

  • project_id (str | None) – Project 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.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The 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.

  • metadata (Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

  • gcp_conn_id (str) – The connection ID to use connecting to Google Cloud.

  • impersonation_chain (str | Sequence[str] | None) – 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: Sequence[str] = ('location', 'instance', 'project_id', 'retry', 'timeout', 'metadata', 'gcp_conn_id',...[source]
execute(context)[source]

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.cloud_memorystore.CloudMemorystoreExportInstanceOperator(*, location, instance, output_config, project_id=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

Export Redis instance data into a Redis RDB format file in Cloud Storage.

Redis will continue serving during this operation.

See also

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

Parameters

  • location (str) – The location of the Cloud Memorystore instance (for example europe-west1)

  • instance (str) – The logical name of the Redis instance in the customer project.

  • output_config (dict | google.cloud.redis_v1.OutputConfig) –

    Required. Specify data to be exported.

    If a dict is provided, it must be of the same form as the protobuf message OutputConfig

  • project_id (str | None) – Project 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.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The 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.

  • metadata (Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

  • gcp_conn_id (str) – The connection ID to use connecting to Google Cloud.

  • impersonation_chain (str | Sequence[str] | None) – 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: Sequence[str] = ('location', 'instance', 'output_config', 'project_id', 'retry', 'timeout', 'metadata',...[source]
execute(context)[source]

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.cloud_memorystore.CloudMemorystoreFailoverInstanceOperator(*, location, instance, data_protection_mode, project_id=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

Initiate a failover of the primary node for a specific STANDARD tier Cloud Memorystore for Redis instance.

Uses the current replica node.

See also

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

Parameters

  • location (str) – The location of the Cloud Memorystore instance (for example europe-west1)

  • instance (str) – The logical name of the Redis instance in the customer project.

  • data_protection_mode (google.cloud.redis_v1.FailoverInstanceRequest.DataProtectionMode) – Optional. Available data protection modes that the user can choose. If it’s unspecified, data protection mode will be LIMITED_DATA_LOSS by default.

  • project_id (str | None) – Project 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.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The 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.

  • metadata (Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

  • gcp_conn_id (str) – The connection ID to use connecting to Google Cloud.

  • impersonation_chain (str | Sequence[str] | None) – 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: Sequence[str] = ('location', 'instance', 'data_protection_mode', 'project_id', 'retry', 'timeout', 'metadata',...[source]
execute(context)[source]

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.cloud_memorystore.CloudMemorystoreGetInstanceOperator(*, location, instance, project_id=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

Gets the details of a specific Redis instance.

See also

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

Parameters

  • location (str) – The location of the Cloud Memorystore instance (for example europe-west1)

  • instance (str) – The logical name of the Redis instance in the customer project.

  • project_id (str | None) – Project 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.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The 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.

  • metadata (Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

  • gcp_conn_id (str) – The connection ID to use connecting to Google Cloud.

  • impersonation_chain (str | Sequence[str] | None) – 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: Sequence[str] = ('location', 'instance', 'project_id', 'retry', 'timeout', 'metadata', 'gcp_conn_id',...[source]
execute(context)[source]

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.cloud_memorystore.CloudMemorystoreImportOperator(*, location, instance, input_config, project_id=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

Import a Redis RDB snapshot file from Cloud Storage into a Redis instance.

Redis may stop serving during this operation. Instance state will be IMPORTING for entire operation. When complete, the instance will contain only data from the imported file.

See also

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

Parameters

  • location (str) – The location of the Cloud Memorystore instance (for example europe-west1)

  • instance (str) – The logical name of the Redis instance in the customer project.

  • input_config (dict | google.cloud.redis_v1.InputConfig) –

    Required. Specify data to be imported.

    If a dict is provided, it must be of the same form as the protobuf message InputConfig

  • project_id (str | None) – Project 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.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The 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.

  • metadata (Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

  • gcp_conn_id (str) – The connection ID to use connecting to Google Cloud.

  • impersonation_chain (str | Sequence[str] | None) – 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: Sequence[str] = ('location', 'instance', 'input_config', 'project_id', 'retry', 'timeout', 'metadata',...[source]
execute(context)[source]

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.cloud_memorystore.CloudMemorystoreListInstancesOperator(*, location, page_size, project_id=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

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

Parameters

  • location (str) – The 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_size (int) – The 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_id (str | None) – Project 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.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The 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.

  • metadata (Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

  • gcp_conn_id (str) – The connection ID to use connecting to Google Cloud.

  • impersonation_chain (str | Sequence[str] | None) – 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: Sequence[str] = ('location', 'page_size', 'project_id', 'retry', 'timeout', 'metadata', 'gcp_conn_id',...[source]
execute(context)[source]

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.cloud_memorystore.CloudMemorystoreUpdateInstanceOperator(*, update_mask, instance, location=None, instance_id=None, project_id=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

Updates the metadata and configuration of a specific Redis instance.

Parameters

update_mask (dict | google.protobuf.field_mask_pb2.FieldMask) –

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from Instance:

  • displayName

  • labels

  • memorySizeGb

  • redisConfig

If a dict is provided, it must be of the same form as the protobuf message FieldMask

See also

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

Parameters

  • instance (dict | google.cloud.redis_v1.Instance) –

    Required. Update description. Only fields specified in update_mask are updated.

    If a dict is provided, it must be of the same form as the protobuf message Instance

  • location (str | None) – The location of the Cloud Memorystore instance (for example europe-west1)

  • instance_id (str | None) – The logical name of the Redis instance in the customer project.

  • project_id (str | None) – Project 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.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The 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.

  • metadata (Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

  • gcp_conn_id (str) – The connection ID to use connecting to Google Cloud.

  • impersonation_chain (str | Sequence[str] | None) – 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: Sequence[str] = ('update_mask', 'instance', 'location', 'instance_id', 'project_id', 'retry', 'timeout',...[source]
execute(context)[source]

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.cloud_memorystore.CloudMemorystoreScaleInstanceOperator(*, memory_size_gb, location=None, instance_id=None, project_id=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

Updates the metadata and configuration of a specific Redis instance.

See also

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

Parameters

  • memory_size_gb (int) – Redis memory size in GiB.

  • location (str | None) – The location of the Cloud Memorystore instance (for example europe-west1)

  • instance_id (str | None) – The logical name of the Redis instance in the customer project.

  • project_id (str | None) – Project 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.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The 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.

  • metadata (Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

  • gcp_conn_id (str) – The connection ID to use connecting to Google Cloud.

  • impersonation_chain (str | Sequence[str] | None) – 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: Sequence[str] = ('memory_size_gb', 'location', 'instance_id', 'project_id', 'retry', 'timeout', 'metadata',...[source]
execute(context)[source]

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.cloud_memorystore.CloudMemorystoreCreateInstanceAndImportOperator(*, location, instance_id, instance, input_config, project_id=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

Create a Redis instance and import a Redis RDB snapshot file from Cloud Storage into this instance.

By default, the instance is accessible from the project’s default network.

See also

For more information on how to use this operator, take a look at the guide: Create instance and import

Parameters

  • location (str) – The location of the Cloud Memorystore instance (for example europe-west1)

  • instance_id (str) –

    Required. The logical name of the Redis instance in the customer project with the following restrictions:

    • Must contain only lowercase letters, numbers, and hyphens.

    • Must start with a letter.

    • Must be between 1-40 characters.

    • Must end with a number or a letter.

    • Must be unique within the customer project / location

  • instance (dict | google.cloud.redis_v1.Instance) –

    Required. A Redis [Instance] resource

    If a dict is provided, it must be of the same form as the protobuf message Instance

  • input_config (dict | google.cloud.redis_v1.InputConfig) –

    Required. Specify data to be imported.

    If a dict is provided, it must be of the same form as the protobuf message InputConfig

  • project_id (str | None) – Project 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.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The 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.

  • metadata (Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

  • gcp_conn_id (str) – The connection ID to use connecting to Google Cloud.

  • impersonation_chain (str | Sequence[str] | None) – 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: Sequence[str] = ('location', 'instance_id', 'instance', 'input_config', 'project_id', 'retry', 'timeout',...[source]
execute(context)[source]

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.cloud_memorystore.CloudMemorystoreExportAndDeleteInstanceOperator(*, location, instance, output_config, project_id=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

Export Redis instance data into a Redis RDB format file in Cloud Storage.

In next step, deletes this instance.

Redis will continue serving during this operation.

See also

For more information on how to use this operator, take a look at the guide: Export and delete instance

Parameters

  • location (str) – The location of the Cloud Memorystore instance (for example europe-west1)

  • instance (str) – The logical name of the Redis instance in the customer project.

  • output_config (dict | google.cloud.redis_v1.OutputConfig) –

    Required. Specify data to be exported.

    If a dict is provided, it must be of the same form as the protobuf message OutputConfig

  • project_id (str | None) – Project 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.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The 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.

  • metadata (Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

  • gcp_conn_id (str) – The connection ID to use connecting to Google Cloud.

  • impersonation_chain (str | Sequence[str] | None) – 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: Sequence[str] = ('location', 'instance', 'output_config', 'project_id', 'retry', 'timeout', 'metadata',...[source]
execute(context)[source]

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.cloud_memorystore.CloudMemorystoreMemcachedApplyParametersOperator(*, node_ids, apply_all, location, instance_id, project_id, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

Will update current set of Parameters to the set of specified nodes of the Memcached Instance.

See also

For more information on how to use this operator, take a look at the guide: Update and apply parameters to an instance

Parameters

  • node_ids (Sequence[str]) – Nodes to which we should apply the instance-level parameter group.

  • apply_all (bool) – Whether to apply instance-level parameter group to all nodes. If set to true, will explicitly restrict users from specifying any nodes, and apply parameter group updates to all nodes within the instance.

  • location (str) – The location of the Cloud Memorystore instance (for example europe-west1)

  • instance_id (str) – The logical name of the Memcached instance in the customer project.

  • project_id (str) – Project 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.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The 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.

  • metadata (Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

template_fields: Sequence[str] = ('node_ids', 'apply_all', 'location', 'instance_id', 'project_id', 'retry', 'timeout',...[source]
execute(context)[source]

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.cloud_memorystore.CloudMemorystoreMemcachedCreateInstanceOperator(location, instance_id, instance, project_id=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', *args, **kwargs)[source]

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

Creates a Memcached instance based on the specified tier and memory size.

By default, the instance is accessible from the project’s default network.

See also

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

Parameters

  • location (str) – The location of the Cloud Memorystore instance (for example europe-west1)

  • instance_id (str) –

    Required. The logical name of the Memcached instance in the customer project with the following restrictions:

    • Must contain only lowercase letters, numbers, and hyphens.

    • Must start with a letter.

    • Must be between 1-40 characters.

    • Must end with a number or a letter.

    • Must be unique within the customer project / location

  • instance (dict | google.cloud.memcache_v1beta2.types.cloud_memcache.Instance) –

    Required. A Memcached [Instance] resource

    If a dict is provided, it must be of the same form as the protobuf message Instance

  • project_id (str | None) – Project ID of the project that contains the instance. If set to None or missing, the default project_id from the GCP connection is used.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The 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.

  • metadata (Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

  • gcp_conn_id (str) – The connection ID to use connecting to Google Cloud Platform.

template_fields: Sequence[str] = ('location', 'instance_id', 'instance', 'project_id', 'retry', 'timeout', 'metadata', 'gcp_conn_id')[source]
execute(context)[source]

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.cloud_memorystore.CloudMemorystoreMemcachedDeleteInstanceOperator(location, instance, project_id=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', *args, **kwargs)[source]

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

Deletes a specific Memcached instance. Instance stops serving and data is deleted.

See also

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

Parameters

  • location (str) – The location of the Cloud Memorystore instance (for example europe-west1)

  • instance (str) – The logical name of the Memcached instance in the customer project.

  • project_id (str | None) – Project ID of the project that contains the instance. If set to None or missing, the default project_id from the GCP connection is used.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The 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.

  • metadata (Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

  • gcp_conn_id (str) – The connection ID to use connecting to Google Cloud Platform.

template_fields: Sequence[str] = ('location', 'instance', 'project_id', 'retry', 'timeout', 'metadata', 'gcp_conn_id')[source]
execute(context)[source]

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.cloud_memorystore.CloudMemorystoreMemcachedGetInstanceOperator(*, location, instance, project_id=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

Gets the details of a specific Memcached instance.

See also

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

Parameters

  • location (str) – The location of the Cloud Memorystore instance (for example europe-west1)

  • instance (str) – The logical name of the Memcached instance in the customer project.

  • project_id (str | None) – Project 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.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The 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.

  • metadata (Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

  • gcp_conn_id (str) – The connection ID to use connecting to Google Cloud Platform.

  • impersonation_chain (str | Sequence[str] | None) – 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: Sequence[str] = ('location', 'instance', 'project_id', 'retry', 'timeout', 'metadata', 'gcp_conn_id',...[source]
execute(context)[source]

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.cloud_memorystore.CloudMemorystoreMemcachedListInstancesOperator(*, location, project_id=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

List all Memcached 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

Parameters

  • location (str) – The 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.

  • project_id (str | None) – Project 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.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The 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.

  • metadata (Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

  • gcp_conn_id (str) – The connection ID to use connecting to Google Cloud.

  • impersonation_chain (str | Sequence[str] | None) – 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: Sequence[str] = ('location', 'project_id', 'retry', 'timeout', 'metadata', 'gcp_conn_id', 'impersonation_chain')[source]
execute(context)[source]

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.cloud_memorystore.CloudMemorystoreMemcachedUpdateInstanceOperator(*, update_mask, instance, location=None, instance_id=None, project_id=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

Updates the metadata and configuration of a specific Memcached instance.

Parameters

update_mask (dict | google.protobuf.field_mask_pb2.FieldMask) –

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from Instance:

  • displayName

If a dict is provided, it must be of the same form as the protobuf message FieldMask

See also

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

Parameters

  • instance (dict | google.cloud.memcache_v1beta2.types.cloud_memcache.Instance) –

    Required. Update description. Only fields specified in update_mask are updated.

    If a dict is provided, it must be of the same form as the protobuf message Instance

  • location (str | None) – The location of the Cloud Memorystore instance (for example europe-west1)

  • instance_id (str | None) – The logical name of the Memcached instance in the customer project.

  • project_id (str | None) – Project 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.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The 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.

  • metadata (Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

  • gcp_conn_id (str) – The connection ID to use connecting to Google Cloud.

  • impersonation_chain (str | Sequence[str] | None) – 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: Sequence[str] = ('update_mask', 'instance', 'location', 'instance_id', 'project_id', 'retry', 'timeout',...[source]
execute(context)[source]

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.cloud_memorystore.CloudMemorystoreMemcachedUpdateParametersOperator(*, update_mask, parameters, location, instance_id, project_id, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

Updates the defined Memcached Parameters for an existing Instance.

This method only stages the parameters, it must be followed by apply_parameters to apply the parameters to nodes of the Memcached Instance.

See also

For more information on how to use this operator, take a look at the guide: Update and apply parameters to an instance

Parameters

  • update_mask (dict | google.protobuf.field_mask_pb2.FieldMask) – Required. Mask of fields to update. If a dict is provided, it must be of the same form as the protobuf message FieldMask

  • parameters (dict | google.cloud.memcache_v1beta2.types.cloud_memcache.MemcacheParameters) – The parameters to apply to the instance. If a dict is provided, it must be of the same form as the protobuf message MemcacheParameters

  • location (str) – The location of the Cloud Memorystore instance (for example europe-west1)

  • instance_id (str) – The logical name of the Memcached instance in the customer project.

  • project_id (str) – Project 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.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The 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.

  • metadata (Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

template_fields: Sequence[str] = ('update_mask', 'parameters', 'location', 'instance_id', 'project_id', 'retry', 'timeout',...[source]
execute(context)[source]

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?