Package Classes (0.2.0) Stay organized with collections Save and categorize content based on your preferences.
Summary of entries of Classes for google-cloud-memorystore.
Classes
MemorystoreClient
Service describing handlers for resources
ListBackupCollectionsPager
A pager for iterating throughlist_backup_collections requests.
This class thinly wraps an initialListBackupCollectionsResponse object, andprovides an__iter__ method to iterate through itsbackup_collections field.
If there are more pages, the__iter__ method will make additionalListBackupCollections requests and continue to iteratethrough thebackup_collections field on thecorresponding responses.
All the usualListBackupCollectionsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListBackupsPager
A pager for iterating throughlist_backups requests.
This class thinly wraps an initialListBackupsResponse object, andprovides an__iter__ method to iterate through itsbackups field.
If there are more pages, the__iter__ method will make additionalListBackups requests and continue to iteratethrough thebackups field on thecorresponding responses.
All the usualListBackupsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListInstancesPager
A pager for iterating throughlist_instances requests.
This class thinly wraps an initialListInstancesResponse object, andprovides an__iter__ method to iterate through itsinstances field.
If there are more pages, the__iter__ method will make additionalListInstances requests and continue to iteratethrough theinstances field on thecorresponding responses.
All the usualListInstancesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
AutomatedBackupConfig
The automated backup config for an instance.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
AutomatedBackupMode
The automated backup mode.
FixedFrequencySchedule
This schedule allows the backup to be triggered at a fixedfrequency (currently only daily is supported).
Backup
Backup of an instance.
BackupType
Type of the backup.
State
State of the backup.
BackupCollection
BackupCollection of an instance.
BackupFile
Backup is consisted of multiple backup files.
BackupInstanceRequest
Request for [BackupInstance].
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
CertificateAuthority
A certificate authority for an instance.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ManagedCertificateAuthority
A managed certificate authority.
CertChain
A certificate chain.
ConnectionType
Type of a PSC connection
CreateInstanceRequest
Request message for [CreateInstance][].
CrossInstanceReplicationConfig
Cross instance replication config.
InstanceRole
The role of the instance in cross instance replication.
Membership
An output only view of all the member instances participatingin the cross instance replication.
RemoteInstance
Details of the remote instance associated with this instancein a cross instance replication setup.
DeleteBackupRequest
Request for [DeleteBackup].
DeleteInstanceRequest
Request message for [DeleteInstance][].
DiscoveryEndpoint
Represents an endpoint for clients to connect to theinstance.
ExportBackupRequest
Request for [ExportBackup].
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
GetBackupCollectionRequest
Request for [GetBackupCollection].
GetBackupRequest
Request for [GetBackup].
GetCertificateAuthorityRequest
Request message for [GetCertificateAuthority][].
GetInstanceRequest
Request message for [GetInstance][].
Instance
A Memorystore instance.
This message hasoneof_ 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 othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
AuthorizationMode
Possible authorization modes of the instance.
ConnectionDetail
Information of each PSC connection.
This message hasoneof_ 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 othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
EngineConfigsEntry
The abstract base class for a message.
GcsBackupSource
Backups that stored in Cloud Storage buckets.The Cloud Storage buckets need to be the same region as theinstances.
InstanceEndpoint
InstanceEndpoint consists of PSC connections that are createdas a group in each VPC network for accessing the instance. Ineach group, there shall be one connection for each serviceattachment in the cluster.
LabelsEntry
The abstract base class for a message.
ManagedBackupSource
Backups that generated and managed by memorystore.
Mode
The mode config, which is used to enable/disable clustermode.
NodeType
Possible node types of the instance. Seehttps://cloud.google.com/memorystore/docs/valkey/instance-node-specificationfor more information.
State
Possible states of the instance.
StateInfo
Additional information about the state of the instance.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
UpdateInfo
Represents information about instance with state UPDATING.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
TransitEncryptionMode
Possible in-transit encryption modes of the instance.
ListBackupCollectionsRequest
Request for [ListBackupCollections]
ListBackupCollectionsResponse
Response for [ListBackupCollections].
ListBackupsRequest
Request for [ListBackups].
ListBackupsResponse
Response for [ListBackups].
ListInstancesRequest
Request message for [ListInstances][].
ListInstancesResponse
Response message for [ListInstances][].
MaintenancePolicy
Maintenance policy per instance.
MaintenanceSchedule
Upcoming maintenance schedule.
NodeConfig
Represents configuration for nodes of the instance.
OperationMetadata
Represents the metadata of a long-running operation.
PersistenceConfig
Represents persistence configuration for a instance.
AOFConfig
Configuration for AOF based persistence.
AppendFsync
Possible fsync modes.
PersistenceMode
Possible persistence modes.
RDBConfig
Configuration for RDB based persistence.
SnapshotPeriod
Possible snapshot periods.
PscAttachmentDetail
Configuration of a service attachment of the cluster, forcreating PSC connections.
PscAutoConnection
Details of consumer resources in a PSC connection.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
PscConnection
User created Psc connection configuration.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
PscConnectionStatus
Status of the PSC connection.
RescheduleMaintenanceRequest
Request for rescheduling instance maintenance.
RescheduleType
Reschedule options.
UpdateInstanceRequest
Request message for [UpdateInstance][].
WeeklyMaintenanceWindow
Time window specified for weekly operations.
ZoneDistributionConfig
Zone distribution configuration for allocation of instanceresources.
ZoneDistributionMode
Possible zone distribution modes.
MemorystoreClient
Service describing handlers for resources
ListInstancesPager
A pager for iterating throughlist_instances requests.
This class thinly wraps an initialListInstancesResponse object, andprovides an__iter__ method to iterate through itsinstances field.
If there are more pages, the__iter__ method will make additionalListInstances requests and continue to iteratethrough theinstances field on thecorresponding responses.
All the usualListInstancesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
CertificateAuthority
A certificate authority for an instance.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ManagedCertificateAuthority
A managed certificate authority.
CertChain
A certificate chain.
ConnectionType
Type of a PSC connection
CreateInstanceRequest
Request message for [CreateInstance][].
DeleteInstanceRequest
Request message for [DeleteInstance][].
DiscoveryEndpoint
Represents an endpoint for clients to connect to theinstance.
GetCertificateAuthorityRequest
Request message for [GetCertificateAuthority][].
GetInstanceRequest
Request message for [GetInstance][].
Instance
A Memorystore instance.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
AuthorizationMode
Possible authorization modes of the instance.
ConnectionDetail
Information of each PSC connection.
This message hasoneof_ 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 othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
EngineConfigsEntry
The abstract base class for a message.
InstanceEndpoint
InstanceEndpoint consists of PSC connections that are createdas a group in each VPC network for accessing the instance. Ineach group, there shall be one connection for each serviceattachment in the cluster.
LabelsEntry
The abstract base class for a message.
Mode
The mode config, which is used to enable/disable clustermode.
NodeType
Possible node types of the instance. Seehttps://cloud.google.com/memorystore/docs/valkey/instance-node-specificationfor more information.
State
Possible states of the instance.
StateInfo
Additional information about the state of the instance.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
UpdateInfo
Represents information about instance with state UPDATING.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
TransitEncryptionMode
Possible in-transit encryption modes of the instance.
ListInstancesRequest
Request message for [ListInstances][].
ListInstancesResponse
Response message for [ListInstances][].
NodeConfig
Represents configuration for nodes of the instance.
OperationMetadata
Represents the metadata of a long-running operation.
PersistenceConfig
Represents persistence configuration for a instance.
AOFConfig
Configuration for AOF based persistence.
AppendFsync
Possible fsync modes.
PersistenceMode
Possible persistence modes.
RDBConfig
Configuration for RDB based persistence.
SnapshotPeriod
Possible snapshot periods.
PscAutoConnection
Details of consumer resources in a PSC connection.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
PscConnection
User created Psc connection configuration.
PscConnectionStatus
Status of the PSC connection.
UpdateInstanceRequest
Request message for [UpdateInstance][].
ZoneDistributionConfig
Zone distribution configuration for allocation of instanceresources.
ZoneDistributionMode
Possible zone distribution modes.
Modules
pagers
API documentation formemorystore_v1.services.memorystore.pagers module.
pagers
API documentation formemorystore_v1beta.services.memorystore.pagers module.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.