Summary of entries of Classes for google-cloud-memorystore.
Classes
MemorystoreAsyncClient
Service describing handlers for resources
MemorystoreClient
Service describing handlers for resources
ListBackupCollectionsAsyncPager
A pager for iterating through list_backup_collections requests.
This class thinly wraps an initial
ListBackupCollectionsResponse object, and
provides an __aiter__ method to iterate through its
backup_collections field.
If there are more pages, the __aiter__ method will make additional
ListBackupCollections requests and continue to iterate
through the backup_collections field on the
corresponding responses.
All the usual ListBackupCollectionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListBackupCollectionsPager
A pager for iterating through list_backup_collections requests.
This class thinly wraps an initial
ListBackupCollectionsResponse object, and
provides an __iter__ method to iterate through its
backup_collections field.
If there are more pages, the __iter__ method will make additional
ListBackupCollections requests and continue to iterate
through the backup_collections field on the
corresponding responses.
All the usual ListBackupCollectionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListBackupsAsyncPager
A pager for iterating through list_backups requests.
This class thinly wraps an initial
ListBackupsResponse object, and
provides an __aiter__ method to iterate through its
backups field.
If there are more pages, the __aiter__ method will make additional
ListBackups requests and continue to iterate
through the backups field on the
corresponding responses.
All the usual ListBackupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListBackupsPager
A pager for iterating through list_backups requests.
This class thinly wraps an initial
ListBackupsResponse object, and
provides an __iter__ method to iterate through its
backups field.
If there are more pages, the __iter__ method will make additional
ListBackups requests and continue to iterate
through the backups field on the
corresponding responses.
All the usual ListBackupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListInstancesAsyncPager
A pager for iterating through list_instances requests.
This class thinly wraps an initial
ListInstancesResponse object, and
provides an __aiter__ method to iterate through its
instances field.
If there are more pages, the __aiter__ method will make additional
ListInstances requests and continue to iterate
through the instances field on the
corresponding responses.
All the usual ListInstancesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListInstancesPager
A pager for iterating through list_instances requests.
This class thinly wraps an initial
ListInstancesResponse object, and
provides an __iter__ method to iterate through its
instances field.
If there are more pages, the __iter__ method will make additional
ListInstances requests and continue to iterate
through the instances field on the
corresponding responses.
All the usual ListInstancesResponse attributes are available on the pager. If multiple requests are made, only the 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 fixed frequency (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 participating in the cross instance replication.
RemoteInstance
Details of the remote instance associated with this instance in a cross instance replication setup.
DeleteBackupRequest
Request for DeleteBackup.
DeleteInstanceRequest
Request message for [DeleteInstance][].
DiscoveryEndpoint
Represents an endpoint for clients to connect to the instance.
EncryptionInfo
EncryptionInfo describes the encryption information of a cluster.
KmsKeyState
The state of the KMS key perceived by the system. Refer to the public documentation for the impact of each state.
Type
Possible encryption types.
ExportBackupRequest
Request for ExportBackup.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
FinishMigrationRequest
Request for FinishMigration.
GetBackupCollectionRequest
Request for GetBackupCollection.
GetBackupRequest
Request for GetBackup.
GetCertificateAuthorityRequest
Request message for GetCertificateAuthority.
GetInstanceRequest
Request message for [GetInstance][].
GetSharedRegionalCertificateAuthorityRequest
Request for GetSharedRegionalCertificateAuthority.
Instance
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
AuthorizationMode
Possible authorization modes of the instance.
ConnectionDetail
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
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 the instances.
InstanceEndpoint
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
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 cluster mode.
NodeType
Possible node types of the instance. See https://cloud.google.com/memorystore/docs/valkey/instance-node-specification for more information.
ServerCaMode
The Server CA mode for the instance.
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.
MigrationConfig
Configuration for the migration of an instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
State
Migration state of the instance. New values may be added in the future.
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, for creating 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.
SelfManagedSource
Details of the self-managed source instance.
SharedRegionalCertificateAuthority
Shared regional certificate authority for an instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
RegionalManagedCertificateAuthority
CA certificate chains for memorystore managed server authentication.
RegionalCertChain
The certificates that form the CA chain, from leaf to root order.
StartMigrationRequest
Request for StartMigration.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
UpdateInstanceRequest
Request message for [UpdateInstance][].
WeeklyMaintenanceWindow
Time window specified for weekly operations.
ZoneDistributionConfig
Zone distribution configuration for allocation of instance resources.
ZoneDistributionMode
Possible zone distribution modes.
MemorystoreAsyncClient
Service describing handlers for resources
MemorystoreClient
Service describing handlers for resources
ListAuthTokensAsyncPager
A pager for iterating through list_auth_tokens requests.
This class thinly wraps an initial
ListAuthTokensResponse object, and
provides an __aiter__ method to iterate through its
auth_tokens field.
If there are more pages, the __aiter__ method will make additional
ListAuthTokens requests and continue to iterate
through the auth_tokens field on the
corresponding responses.
All the usual ListAuthTokensResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListAuthTokensPager
A pager for iterating through list_auth_tokens requests.
This class thinly wraps an initial
ListAuthTokensResponse object, and
provides an __iter__ method to iterate through its
auth_tokens field.
If there are more pages, the __iter__ method will make additional
ListAuthTokens requests and continue to iterate
through the auth_tokens field on the
corresponding responses.
All the usual ListAuthTokensResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListBackupCollectionsAsyncPager
A pager for iterating through list_backup_collections requests.
This class thinly wraps an initial
ListBackupCollectionsResponse object, and
provides an __aiter__ method to iterate through its
backup_collections field.
If there are more pages, the __aiter__ method will make additional
ListBackupCollections requests and continue to iterate
through the backup_collections field on the
corresponding responses.
All the usual ListBackupCollectionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListBackupCollectionsPager
A pager for iterating through list_backup_collections requests.
This class thinly wraps an initial
ListBackupCollectionsResponse object, and
provides an __iter__ method to iterate through its
backup_collections field.
If there are more pages, the __iter__ method will make additional
ListBackupCollections requests and continue to iterate
through the backup_collections field on the
corresponding responses.
All the usual ListBackupCollectionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListBackupsAsyncPager
A pager for iterating through list_backups requests.
This class thinly wraps an initial
ListBackupsResponse object, and
provides an __aiter__ method to iterate through its
backups field.
If there are more pages, the __aiter__ method will make additional
ListBackups requests and continue to iterate
through the backups field on the
corresponding responses.
All the usual ListBackupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListBackupsPager
A pager for iterating through list_backups requests.
This class thinly wraps an initial
ListBackupsResponse object, and
provides an __iter__ method to iterate through its
backups field.
If there are more pages, the __iter__ method will make additional
ListBackups requests and continue to iterate
through the backups field on the
corresponding responses.
All the usual ListBackupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListInstancesAsyncPager
A pager for iterating through list_instances requests.
This class thinly wraps an initial
ListInstancesResponse object, and
provides an __aiter__ method to iterate through its
instances field.
If there are more pages, the __aiter__ method will make additional
ListInstances requests and continue to iterate
through the instances field on the
corresponding responses.
All the usual ListInstancesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListInstancesPager
A pager for iterating through list_instances requests.
This class thinly wraps an initial
ListInstancesResponse object, and
provides an __iter__ method to iterate through its
instances field.
If there are more pages, the __iter__ method will make additional
ListInstances requests and continue to iterate
through the instances field on the
corresponding responses.
All the usual ListInstancesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListTokenAuthUsersAsyncPager
A pager for iterating through list_token_auth_users requests.
This class thinly wraps an initial
ListTokenAuthUsersResponse object, and
provides an __aiter__ method to iterate through its
token_auth_users field.
If there are more pages, the __aiter__ method will make additional
ListTokenAuthUsers requests and continue to iterate
through the token_auth_users field on the
corresponding responses.
All the usual ListTokenAuthUsersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListTokenAuthUsersPager
A pager for iterating through list_token_auth_users requests.
This class thinly wraps an initial
ListTokenAuthUsersResponse object, and
provides an __iter__ method to iterate through its
token_auth_users field.
If there are more pages, the __iter__ method will make additional
ListTokenAuthUsers requests and continue to iterate
through the token_auth_users field on the
corresponding responses.
All the usual ListTokenAuthUsersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
AddAuthTokenRequest
Request message for AddAuthToken.
AddTokenAuthUserRequest
Request message for AddTokenAuthUser.
AuthToken
Auth token for the instance.
State
Represents the different states of an auth token. New values may be added in the future.
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 fixed frequency (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 participating in the cross instance replication.
RemoteInstance
Details of the remote instance associated with this instance in a cross instance replication setup.
DeleteAuthTokenRequest
Request message for DeleteAuthToken.
DeleteBackupRequest
Request for DeleteBackup.
DeleteInstanceRequest
Request message for [DeleteInstance][].
DeleteTokenAuthUserRequest
Request message for DeleteTokenAuthUser.
DiscoveryEndpoint
Represents an endpoint for clients to connect to the instance.
EncryptionInfo
EncryptionInfo describes the encryption information of a cluster.
KmsKeyState
The state of the KMS key perceived by the system. Refer to the public documentation for the impact of each state.
Type
Possible encryption types.
ExportBackupRequest
Request for ExportBackup.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
FinishMigrationRequest
Request for FinishMigration.
GetAuthTokenRequest
Request message for GetAuthToken.
GetBackupCollectionRequest
Request for GetBackupCollection.
GetBackupRequest
Request for GetBackup.
GetCertificateAuthorityRequest
Request message for GetCertificateAuthority.
GetInstanceRequest
Request message for GetInstance.
GetSharedRegionalCertificateAuthorityRequest
Request for GetSharedRegionalCertificateAuthority.
GetTokenAuthUserRequest
Request message for GetTokenAuthUser.
Instance
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
AuthorizationMode
Possible authorization modes of the instance.
ConnectionDetail
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
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 the instances.
InstanceEndpoint
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
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 cluster mode.
NodeType
Possible node types of the instance. See https://cloud.google.com/memorystore/docs/valkey/instance-node-specification for more information.
ServerCaMode
The Server CA mode for the instance.
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.
ListAuthTokensRequest
Request message for ListAuthTokens.
ListAuthTokensResponse
Response message for ListAuthTokens.
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.
ListTokenAuthUsersRequest
Request message for ListTokenAuthUsers.
ListTokenAuthUsersResponse
Response message for ListTokenAuthUsers.
MaintenancePolicy
Maintenance policy per instance.
MaintenanceSchedule
Upcoming maintenance schedule.
MigrationConfig
Configuration for the migration of an instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
State
Migration state of the instance. New values may be added in the future.
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, for creating 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.
SelfManagedSource
Details of the self-managed source instance.
SharedRegionalCertificateAuthority
Shared regional certificate authority for an instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
RegionalManagedCertificateAuthority
CA certificate chains for memorystore managed server authentication.
RegionalCertChain
The certificates that form the CA chain, from leaf to root order.
StartMigrationRequest
Request for StartMigration.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
TokenAuthUser
Token based auth user for the instance.
State
Represents the different states of a token based auth user. New values may be added in the future.
UpdateInstanceRequest
Request message for [UpdateInstance][].
WeeklyMaintenanceWindow
Time window specified for weekly operations.
ZoneDistributionConfig
Zone distribution configuration for allocation of instance resources.
ZoneDistributionMode
Possible zone distribution modes.
Modules
pagers
API documentation for memorystore_v1.services.memorystore.pagers module.
pagers
API documentation for memorystore_v1beta.services.memorystore.pagers module.