Reference documentation and code samples for the Memorystore V1 API class Google::Cloud::Memorystore::V1::Instance.
A Memorystore instance.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#allow_fewer_zones_deployment
def allow_fewer_zones_deployment() -> ::Boolean
Returns
- (::Boolean) — Optional. Immutable. Deprecated, do not use.
#allow_fewer_zones_deployment=
def allow_fewer_zones_deployment=(value) -> ::Boolean
Parameter
- value (::Boolean) — Optional. Immutable. Deprecated, do not use.
Returns
- (::Boolean) — Optional. Immutable. Deprecated, do not use.
#async_instance_endpoints_deletion_enabled
def async_instance_endpoints_deletion_enabled() -> ::Boolean
Returns
- (::Boolean) — 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.
#async_instance_endpoints_deletion_enabled=
def async_instance_endpoints_deletion_enabled=(value) -> ::Boolean
Parameter
- value (::Boolean) — 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.
Returns
- (::Boolean) — 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.
#authorization_mode
def authorization_mode() -> ::Google::Cloud::Memorystore::V1::Instance::AuthorizationMode
Returns
- (::Google::Cloud::Memorystore::V1::Instance::AuthorizationMode) — Optional. Immutable. Authorization mode of the instance.
#authorization_mode=
def authorization_mode=(value) -> ::Google::Cloud::Memorystore::V1::Instance::AuthorizationMode
Parameter
- value (::Google::Cloud::Memorystore::V1::Instance::AuthorizationMode) — Optional. Immutable. Authorization mode of the instance.
Returns
- (::Google::Cloud::Memorystore::V1::Instance::AuthorizationMode) — Optional. Immutable. Authorization mode of the instance.
#automated_backup_config
def automated_backup_config() -> ::Google::Cloud::Memorystore::V1::AutomatedBackupConfig
Returns
- (::Google::Cloud::Memorystore::V1::AutomatedBackupConfig) — Optional. The automated backup config for the instance.
#automated_backup_config=
def automated_backup_config=(value) -> ::Google::Cloud::Memorystore::V1::AutomatedBackupConfig
Parameter
- value (::Google::Cloud::Memorystore::V1::AutomatedBackupConfig) — Optional. The automated backup config for the instance.
Returns
- (::Google::Cloud::Memorystore::V1::AutomatedBackupConfig) — Optional. The automated backup config for the instance.
#available_maintenance_versions
def available_maintenance_versions() -> ::Array<::String>
Returns
- (::Array<::String>) — Output only. This field is used to determine the available maintenance versions for the self service update.
#backup_collection
def backup_collection() -> ::String
Returns
- (::String) — Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection}
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Creation timestamp of the instance.
#cross_instance_replication_config
def cross_instance_replication_config() -> ::Google::Cloud::Memorystore::V1::CrossInstanceReplicationConfig
Returns
- (::Google::Cloud::Memorystore::V1::CrossInstanceReplicationConfig) — Optional. The config for cross instance replication.
#cross_instance_replication_config=
def cross_instance_replication_config=(value) -> ::Google::Cloud::Memorystore::V1::CrossInstanceReplicationConfig
Parameter
- value (::Google::Cloud::Memorystore::V1::CrossInstanceReplicationConfig) — Optional. The config for cross instance replication.
Returns
- (::Google::Cloud::Memorystore::V1::CrossInstanceReplicationConfig) — Optional. The config for cross instance replication.
#deletion_protection_enabled
def deletion_protection_enabled() -> ::Boolean
Returns
- (::Boolean) — Optional. If set to true deletion of the instance will fail.
#deletion_protection_enabled=
def deletion_protection_enabled=(value) -> ::Boolean
Parameter
- value (::Boolean) — Optional. If set to true deletion of the instance will fail.
Returns
- (::Boolean) — Optional. If set to true deletion of the instance will fail.
#discovery_endpoints
def discovery_endpoints() -> ::Array<::Google::Cloud::Memorystore::V1::DiscoveryEndpoint>
Returns
- (::Array<::Google::Cloud::Memorystore::V1::DiscoveryEndpoint>) — Output only. Deprecated: The discovery_endpoints parameter is deprecated. As a result, it will not be populated if the connections are created using endpoints parameter. Instead of this parameter, for discovery, use endpoints.connections.pscConnection and endpoints.connections.pscAutoConnection with connectionType CONNECTION_TYPE_DISCOVERY.
#effective_maintenance_version
def effective_maintenance_version() -> ::String
Returns
- (::String) — Output only. This field represents the actual maintenance version of the instance.
#encryption_info
def encryption_info() -> ::Google::Cloud::Memorystore::V1::EncryptionInfo
Returns
- (::Google::Cloud::Memorystore::V1::EncryptionInfo) — Output only. Encryption information of the data at rest of the cluster.
#endpoints
def endpoints() -> ::Array<::Google::Cloud::Memorystore::V1::Instance::InstanceEndpoint>
Returns
- (::Array<::Google::Cloud::Memorystore::V1::Instance::InstanceEndpoint>) — Optional. Endpoints for the instance.
#endpoints=
def endpoints=(value) -> ::Array<::Google::Cloud::Memorystore::V1::Instance::InstanceEndpoint>
Parameter
- value (::Array<::Google::Cloud::Memorystore::V1::Instance::InstanceEndpoint>) — Optional. Endpoints for the instance.
Returns
- (::Array<::Google::Cloud::Memorystore::V1::Instance::InstanceEndpoint>) — Optional. Endpoints for the instance.
#engine_configs
def engine_configs() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. User-provided engine configurations for the instance.
#engine_configs=
def engine_configs=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — Optional. User-provided engine configurations for the instance.
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. User-provided engine configurations for the instance.
#engine_version
def engine_version() -> ::String
Returns
- (::String) — Optional. Engine version of the instance.
#engine_version=
def engine_version=(value) -> ::String
Parameter
- value (::String) — Optional. Engine version of the instance.
Returns
- (::String) — Optional. Engine version of the instance.
#gcs_source
def gcs_source() -> ::Google::Cloud::Memorystore::V1::Instance::GcsBackupSource
Returns
-
(::Google::Cloud::Memorystore::V1::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.
Note: The following fields are mutually exclusive:
gcs_source,managed_backup_source. If a field in that set is populated, all other fields in the set will automatically be cleared.
#gcs_source=
def gcs_source=(value) -> ::Google::Cloud::Memorystore::V1::Instance::GcsBackupSource
Parameter
-
value (::Google::Cloud::Memorystore::V1::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.
Note: The following fields are mutually exclusive:
gcs_source,managed_backup_source. If a field in that set is populated, all other fields in the set will automatically be cleared.
Returns
-
(::Google::Cloud::Memorystore::V1::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.
Note: The following fields are mutually exclusive:
gcs_source,managed_backup_source. If a field in that set is populated, all other fields in the set will automatically be cleared.
#kms_key
def kms_key() -> ::String
Returns
- (::String) — Optional. The KMS key used to encrypt the at-rest data of the cluster.
#kms_key=
def kms_key=(value) -> ::String
Parameter
- value (::String) — Optional. The KMS key used to encrypt the at-rest data of the cluster.
Returns
- (::String) — Optional. The KMS key used to encrypt the at-rest data of the cluster.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels to represent user-provided metadata.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels to represent user-provided metadata.
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels to represent user-provided metadata.
#maintenance_policy
def maintenance_policy() -> ::Google::Cloud::Memorystore::V1::MaintenancePolicy
Returns
- (::Google::Cloud::Memorystore::V1::MaintenancePolicy) — Optional. The maintenance policy for the instance. If not provided, the maintenance event will be performed based on Memorystore internal rollout schedule.
#maintenance_policy=
def maintenance_policy=(value) -> ::Google::Cloud::Memorystore::V1::MaintenancePolicy
Parameter
- value (::Google::Cloud::Memorystore::V1::MaintenancePolicy) — Optional. The maintenance policy for the instance. If not provided, the maintenance event will be performed based on Memorystore internal rollout schedule.
Returns
- (::Google::Cloud::Memorystore::V1::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
def maintenance_schedule() -> ::Google::Cloud::Memorystore::V1::MaintenanceSchedule
Returns
- (::Google::Cloud::Memorystore::V1::MaintenanceSchedule) — Output only. Published maintenance schedule.
#maintenance_version
def maintenance_version() -> ::String
Returns
- (::String) — Optional. This field can be used to trigger self service update to indicate the desired maintenance version. The input to this field can be determined by the available_maintenance_versions field.
#maintenance_version=
def maintenance_version=(value) -> ::String
Parameter
- value (::String) — Optional. This field can be used to trigger self service update to indicate the desired maintenance version. The input to this field can be determined by the available_maintenance_versions field.
Returns
- (::String) — Optional. This field can be used to trigger self service update to indicate the desired maintenance version. The input to this field can be determined by the available_maintenance_versions field.
#managed_backup_source
def managed_backup_source() -> ::Google::Cloud::Memorystore::V1::Instance::ManagedBackupSource
Returns
-
(::Google::Cloud::Memorystore::V1::Instance::ManagedBackupSource) — Optional. Immutable. Backups that generated and managed by memorystore
service.
Note: The following fields are mutually exclusive:
managed_backup_source,gcs_source. If a field in that set is populated, all other fields in the set will automatically be cleared.
#managed_backup_source=
def managed_backup_source=(value) -> ::Google::Cloud::Memorystore::V1::Instance::ManagedBackupSource
Parameter
-
value (::Google::Cloud::Memorystore::V1::Instance::ManagedBackupSource) — Optional. Immutable. Backups that generated and managed by memorystore
service.
Note: The following fields are mutually exclusive:
managed_backup_source,gcs_source. If a field in that set is populated, all other fields in the set will automatically be cleared.
Returns
-
(::Google::Cloud::Memorystore::V1::Instance::ManagedBackupSource) — Optional. Immutable. Backups that generated and managed by memorystore
service.
Note: The following fields are mutually exclusive:
managed_backup_source,gcs_source. If a field in that set is populated, all other fields in the set will automatically be cleared.
#mode
def mode() -> ::Google::Cloud::Memorystore::V1::Instance::Mode
Returns
- (::Google::Cloud::Memorystore::V1::Instance::Mode) — Optional. The mode config for the instance.
#mode=
def mode=(value) -> ::Google::Cloud::Memorystore::V1::Instance::Mode
Parameter
- value (::Google::Cloud::Memorystore::V1::Instance::Mode) — Optional. The mode config for the instance.
Returns
- (::Google::Cloud::Memorystore::V1::Instance::Mode) — Optional. The mode config for the instance.
#name
def name() -> ::String
Returns
- (::String) — Identifier. Unique name of the instance. Format: projects/{project}/locations/{location}/instances/{instance}
#name=
def name=(value) -> ::String
Parameter
- value (::String) — Identifier. Unique name of the instance. Format: projects/{project}/locations/{location}/instances/{instance}
Returns
- (::String) — Identifier. Unique name of the instance. Format: projects/{project}/locations/{location}/instances/{instance}
#node_config
def node_config() -> ::Google::Cloud::Memorystore::V1::NodeConfig
Returns
- (::Google::Cloud::Memorystore::V1::NodeConfig) — Output only. Configuration of individual nodes of the instance.
#node_type
def node_type() -> ::Google::Cloud::Memorystore::V1::Instance::NodeType
Returns
- (::Google::Cloud::Memorystore::V1::Instance::NodeType) — Optional. Machine type for individual nodes of the instance.
#node_type=
def node_type=(value) -> ::Google::Cloud::Memorystore::V1::Instance::NodeType
Parameter
- value (::Google::Cloud::Memorystore::V1::Instance::NodeType) — Optional. Machine type for individual nodes of the instance.
Returns
- (::Google::Cloud::Memorystore::V1::Instance::NodeType) — Optional. Machine type for individual nodes of the instance.
#ondemand_maintenance
def ondemand_maintenance() -> ::Boolean
Returns
- (::Boolean) — Optional. Input only. Ondemand maintenance for the instance.
#ondemand_maintenance=
def ondemand_maintenance=(value) -> ::Boolean
Parameter
- value (::Boolean) — Optional. Input only. Ondemand maintenance for the instance.
Returns
- (::Boolean) — Optional. Input only. Ondemand maintenance for the instance.
#persistence_config
def persistence_config() -> ::Google::Cloud::Memorystore::V1::PersistenceConfig
Returns
- (::Google::Cloud::Memorystore::V1::PersistenceConfig) — Optional. Persistence configuration of the instance.
#persistence_config=
def persistence_config=(value) -> ::Google::Cloud::Memorystore::V1::PersistenceConfig
Parameter
- value (::Google::Cloud::Memorystore::V1::PersistenceConfig) — Optional. Persistence configuration of the instance.
Returns
- (::Google::Cloud::Memorystore::V1::PersistenceConfig) — Optional. Persistence configuration of the instance.
#psc_attachment_details
def psc_attachment_details() -> ::Array<::Google::Cloud::Memorystore::V1::PscAttachmentDetail>
Returns
- (::Array<::Google::Cloud::Memorystore::V1::PscAttachmentDetail>) — Output only. Service attachment details to configure PSC connections.
#psc_auto_connections
def psc_auto_connections() -> ::Array<::Google::Cloud::Memorystore::V1::PscAutoConnection>
Returns
- (::Array<::Google::Cloud::Memorystore::V1::PscAutoConnection>) — Optional. Immutable. Deprecated: Use the endpoints.connections.psc_auto_connection value instead.
#psc_auto_connections=
def psc_auto_connections=(value) -> ::Array<::Google::Cloud::Memorystore::V1::PscAutoConnection>
Parameter
- value (::Array<::Google::Cloud::Memorystore::V1::PscAutoConnection>) — Optional. Immutable. Deprecated: Use the endpoints.connections.psc_auto_connection value instead.
Returns
- (::Array<::Google::Cloud::Memorystore::V1::PscAutoConnection>) — Optional. Immutable. Deprecated: Use the endpoints.connections.psc_auto_connection value instead.
#replica_count
def replica_count() -> ::Integer
Returns
- (::Integer) — Optional. Number of replica nodes per shard. If omitted the default is 0 replicas.
#replica_count=
def replica_count=(value) -> ::Integer
Parameter
- value (::Integer) — Optional. Number of replica nodes per shard. If omitted the default is 0 replicas.
Returns
- (::Integer) — Optional. Number of replica nodes per shard. If omitted the default is 0 replicas.
#satisfies_pzi
def satisfies_pzi() -> ::Boolean
Returns
- (::Boolean) — Optional. Output only. Reserved for future use.
#satisfies_pzs
def satisfies_pzs() -> ::Boolean
Returns
- (::Boolean) — Optional. Output only. Reserved for future use.
#shard_count
def shard_count() -> ::Integer
Returns
- (::Integer) — Optional. Number of shards for the instance.
#shard_count=
def shard_count=(value) -> ::Integer
Parameter
- value (::Integer) — Optional. Number of shards for the instance.
Returns
- (::Integer) — Optional. Number of shards for the instance.
#simulate_maintenance_event
def simulate_maintenance_event() -> ::Boolean
Returns
- (::Boolean) — Optional. Input only. Simulate a maintenance event.
#simulate_maintenance_event=
def simulate_maintenance_event=(value) -> ::Boolean
Parameter
- value (::Boolean) — Optional. Input only. Simulate a maintenance event.
Returns
- (::Boolean) — Optional. Input only. Simulate a maintenance event.
#state
def state() -> ::Google::Cloud::Memorystore::V1::Instance::State
Returns
- (::Google::Cloud::Memorystore::V1::Instance::State) — Output only. Current state of the instance.
#state_info
def state_info() -> ::Google::Cloud::Memorystore::V1::Instance::StateInfo
Returns
- (::Google::Cloud::Memorystore::V1::Instance::StateInfo) — Output only. Additional information about the state of the instance.
#transit_encryption_mode
def transit_encryption_mode() -> ::Google::Cloud::Memorystore::V1::Instance::TransitEncryptionMode
Returns
- (::Google::Cloud::Memorystore::V1::Instance::TransitEncryptionMode) — Optional. Immutable. In-transit encryption mode of the instance.
#transit_encryption_mode=
def transit_encryption_mode=(value) -> ::Google::Cloud::Memorystore::V1::Instance::TransitEncryptionMode
Parameter
- value (::Google::Cloud::Memorystore::V1::Instance::TransitEncryptionMode) — Optional. Immutable. In-transit encryption mode of the instance.
Returns
- (::Google::Cloud::Memorystore::V1::Instance::TransitEncryptionMode) — Optional. Immutable. In-transit encryption mode of the instance.
#uid
def uid() -> ::String
Returns
- (::String) — Output only. System assigned, unique identifier for the instance.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Latest update timestamp of the instance.
#zone_distribution_config
def zone_distribution_config() -> ::Google::Cloud::Memorystore::V1::ZoneDistributionConfig
Returns
- (::Google::Cloud::Memorystore::V1::ZoneDistributionConfig) — Optional. Immutable. Zone distribution configuration of the instance for node allocation.
#zone_distribution_config=
def zone_distribution_config=(value) -> ::Google::Cloud::Memorystore::V1::ZoneDistributionConfig
Parameter
- value (::Google::Cloud::Memorystore::V1::ZoneDistributionConfig) — Optional. Immutable. Zone distribution configuration of the instance for node allocation.
Returns
- (::Google::Cloud::Memorystore::V1::ZoneDistributionConfig) — Optional. Immutable. Zone distribution configuration of the instance for node allocation.