Class Instance (0.2.0) 

Instance(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A Memorystore instance.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name Description
gcs_source google.cloud.memorystore_v1.types.Instance.GcsBackupSource
Optional. Immutable. Backups that stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the instances. Read permission is required to import from the provided Cloud Storage Objects. This field is a member of oneof_ import_sources.
managed_backup_source google.cloud.memorystore_v1.types.Instance.ManagedBackupSource
Optional. Immutable. Backups that generated and managed by memorystore service. This field is a member of oneof_ import_sources.
name str
Identifier. Unique name of the instance. Format: projects/{project}/locations/{location}/instances/{instance}
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. Creation timestamp of the instance.
update_time google.protobuf.timestamp_pb2.Timestamp
Output only. Latest update timestamp of the instance.
labels MutableMapping[str, str]
Optional. Labels to represent user-provided metadata.
state google.cloud.memorystore_v1.types.Instance.State
Output only. Current state of the instance.
state_info google.cloud.memorystore_v1.types.Instance.StateInfo
Output only. Additional information about the state of the instance.
uid str
Output only. System assigned, unique identifier for the instance.
replica_count int
Optional. Number of replica nodes per shard. If omitted the default is 0 replicas. This field is a member of oneof_ _replica_count.
authorization_mode google.cloud.memorystore_v1.types.Instance.AuthorizationMode
Optional. Immutable. Authorization mode of the instance.
transit_encryption_mode google.cloud.memorystore_v1.types.Instance.TransitEncryptionMode
Optional. Immutable. In-transit encryption mode of the instance.
shard_count int
Optional. Number of shards for the instance.
discovery_endpoints MutableSequence[google.cloud.memorystore_v1.types.DiscoveryEndpoint]
Output only. Deprecated: Use the endpoints.connections.psc_auto_connection or endpoints.connections.psc_connection values instead.
node_type google.cloud.memorystore_v1.types.Instance.NodeType
Optional. Machine type for individual nodes of the instance.
persistence_config google.cloud.memorystore_v1.types.PersistenceConfig
Optional. Persistence configuration of the instance.
engine_version str
Optional. Engine version of the instance.
engine_configs MutableMapping[str, str]
Optional. User-provided engine configurations for the instance.
node_config google.cloud.memorystore_v1.types.NodeConfig
Output only. Configuration of individual nodes of the instance.
zone_distribution_config google.cloud.memorystore_v1.types.ZoneDistributionConfig
Optional. Immutable. Zone distribution configuration of the instance for node allocation.
deletion_protection_enabled bool
Optional. If set to true deletion of the instance will fail. This field is a member of oneof_ _deletion_protection_enabled.
psc_auto_connections MutableSequence[google.cloud.memorystore_v1.types.PscAutoConnection]
Optional. Immutable. Deprecated: Use the endpoints.connections.psc_auto_connection value instead.
psc_attachment_details MutableSequence[google.cloud.memorystore_v1.types.PscAttachmentDetail]
Output only. Service attachment details to configure PSC connections.
endpoints MutableSequence[google.cloud.memorystore_v1.types.Instance.InstanceEndpoint]
Optional. Endpoints for the instance.
mode google.cloud.memorystore_v1.types.Instance.Mode
Optional. The mode config for the instance.
ondemand_maintenance bool
Optional. Input only. Ondemand maintenance for the instance. This field is a member of oneof_ _ondemand_maintenance.
maintenance_policy google.cloud.memorystore_v1.types.MaintenancePolicy
Optional. The maintenance policy for the instance. If not provided, the maintenance event will be performed based on Memorystore internal rollout schedule.
maintenance_schedule google.cloud.memorystore_v1.types.MaintenanceSchedule
Output only. Published maintenance schedule.
cross_instance_replication_config google.cloud.memorystore_v1.types.CrossInstanceReplicationConfig
Optional. The config for cross instance replication.
async_instance_endpoints_deletion_enabled bool
Optional. If true, instance endpoints that are created and registered by customers can be deleted asynchronously. That is, such an instance endpoint can be de-registered before the forwarding rules in the instance endpoint are deleted. This field is a member of oneof_ _async_instance_endpoints_deletion_enabled.
backup_collection str
Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection} This field is a member of oneof_ _backup_collection.
automated_backup_config google.cloud.memorystore_v1.types.AutomatedBackupConfig
Optional. The automated backup config for the instance.

Classes

AuthorizationMode

AuthorizationMode(value)

Possible authorization modes of the instance.

ConnectionDetail

ConnectionDetail(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Information of each PSC connection.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

EngineConfigsEntry

EngineConfigsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.
mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

GcsBackupSource

GcsBackupSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Backups that stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the instances.

InstanceEndpoint

InstanceEndpoint(mapping=None, *, ignore_unknown_fields=False, **kwargs)

InstanceEndpoint consists of PSC connections that are created as a group in each VPC network for accessing the instance. In each group, there shall be one connection for each service attachment in the cluster.

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.
mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

ManagedBackupSource

ManagedBackupSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Backups that generated and managed by memorystore.

Mode

Mode(value)

The mode config, which is used to enable/disable cluster mode.

NodeType

NodeType(value)

Possible node types of the instance. See https://cloud.google.com/memorystore/docs/valkey/instance-node-specification for more information.

State

State(value)

Possible states of the instance.

StateInfo

StateInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Additional information about the state of the instance.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

TransitEncryptionMode

TransitEncryptionMode(value)

Possible in-transit encryption modes of the instance.