Memorystore V1 API - Class Google::Cloud::Memorystore::V1::Instance (v1.2.0)

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

#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

#authorization_mode=

def authorization_mode=(value) -> ::Google::Cloud::Memorystore::V1::Instance::AuthorizationMode
Parameter
Returns

#automated_backup_config

def automated_backup_config() -> ::Google::Cloud::Memorystore::V1::AutomatedBackupConfig
Returns

#automated_backup_config=

def automated_backup_config=(value) -> ::Google::Cloud::Memorystore::V1::AutomatedBackupConfig
Parameter
Returns

#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

#cross_instance_replication_config

def cross_instance_replication_config() -> ::Google::Cloud::Memorystore::V1::CrossInstanceReplicationConfig
Returns

#cross_instance_replication_config=

def cross_instance_replication_config=(value) -> ::Google::Cloud::Memorystore::V1::CrossInstanceReplicationConfig
Parameter
Returns

#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

#endpoints

def endpoints() -> ::Array<::Google::Cloud::Memorystore::V1::Instance::InstanceEndpoint>
Returns

#endpoints=

def endpoints=(value) -> ::Array<::Google::Cloud::Memorystore::V1::Instance::InstanceEndpoint>
Parameter
Returns

#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.

#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

#maintenance_policy=

def maintenance_policy=(value) -> ::Google::Cloud::Memorystore::V1::MaintenancePolicy
Parameter
Returns

#maintenance_schedule

def maintenance_schedule() -> ::Google::Cloud::Memorystore::V1::MaintenanceSchedule
Returns

#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

#mode=

def mode=(value) -> ::Google::Cloud::Memorystore::V1::Instance::Mode
Parameter
Returns

#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

#node_type

def node_type() -> ::Google::Cloud::Memorystore::V1::Instance::NodeType
Returns

#node_type=

def node_type=(value) -> ::Google::Cloud::Memorystore::V1::Instance::NodeType
Parameter
Returns

#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

#persistence_config=

def persistence_config=(value) -> ::Google::Cloud::Memorystore::V1::PersistenceConfig
Parameter
Returns

#psc_attachment_details

def psc_attachment_details() -> ::Array<::Google::Cloud::Memorystore::V1::PscAttachmentDetail>
Returns

#psc_auto_connections

def psc_auto_connections() -> ::Array<::Google::Cloud::Memorystore::V1::PscAutoConnection>
Returns

#psc_auto_connections=

def psc_auto_connections=(value) -> ::Array<::Google::Cloud::Memorystore::V1::PscAutoConnection>
Parameter
Returns

#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.

#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.

#state

def state() -> ::Google::Cloud::Memorystore::V1::Instance::State
Returns

#state_info

def state_info() -> ::Google::Cloud::Memorystore::V1::Instance::StateInfo
Returns

#transit_encryption_mode

def transit_encryption_mode() -> ::Google::Cloud::Memorystore::V1::Instance::TransitEncryptionMode
Returns

#transit_encryption_mode=

def transit_encryption_mode=(value) -> ::Google::Cloud::Memorystore::V1::Instance::TransitEncryptionMode
Parameter
Returns

#uid

def uid() -> ::String
Returns
  • (::String) — Output only. System assigned, unique identifier for the instance.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns

#zone_distribution_config

def zone_distribution_config() -> ::Google::Cloud::Memorystore::V1::ZoneDistributionConfig
Returns

#zone_distribution_config=

def zone_distribution_config=(value) -> ::Google::Cloud::Memorystore::V1::ZoneDistributionConfig
Parameter
Returns