# Memorystore V1BETA API - Class Google::Cloud::Memorystore::V1beta::Instance (v0.12.0)

0.12.0 (latest) 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.6.0 0.5.1 0.4.0 0.3.0 0.2.0 0.1.0 Reference documentation and code samples for the Memorystore V1BETA API class Google::Cloud::Memorystore::V1beta::Instance.

A Memorystore instance.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #authorization_mode

    def authorization_mode() -> ::Google::Cloud::Memorystore::V1beta::Instance::AuthorizationMode

**Returns**

- ([::Google::Cloud::Memorystore::V1beta::Instance::AuthorizationMode](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-memorystore-v1beta/latest/Google-Cloud-Memorystore-V1beta-Instance-AuthorizationMode)) --- Optional. Immutable. Authorization mode of the instance.

### #authorization_mode=

    def authorization_mode=(value) -> ::Google::Cloud::Memorystore::V1beta::Instance::AuthorizationMode

**Parameter**

- **value** ([::Google::Cloud::Memorystore::V1beta::Instance::AuthorizationMode](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-memorystore-v1beta/latest/Google-Cloud-Memorystore-V1beta-Instance-AuthorizationMode)) --- Optional. Immutable. Authorization mode of the instance.
**Returns**

- ([::Google::Cloud::Memorystore::V1beta::Instance::AuthorizationMode](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-memorystore-v1beta/latest/Google-Cloud-Memorystore-V1beta-Instance-AuthorizationMode)) --- Optional. Immutable. Authorization mode of the instance.

### #create_time

    def create_time() -> ::Google::Protobuf::Timestamp

**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-memorystore-v1beta/latest/Google-Protobuf-Timestamp)) --- Output only. Creation timestamp of the instance.

### #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::V1beta::DiscoveryEndpoint>

**Returns**

- (::Array\<[::Google::Cloud::Memorystore::V1beta::DiscoveryEndpoint](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-memorystore-v1beta/latest/Google-Cloud-Memorystore-V1beta-DiscoveryEndpoint)\>) --- Output only. Endpoints clients can connect to the instance through. Currently only one discovery endpoint is supported.

### #endpoints

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

**Returns**

- (::Array\<[::Google::Cloud::Memorystore::V1beta::Instance::InstanceEndpoint](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-memorystore-v1beta/latest/Google-Cloud-Memorystore-V1beta-Instance-InstanceEndpoint)\>) --- Optional. Endpoints for the instance.

### #endpoints=

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

**Parameter**

- **value** (::Array\<[::Google::Cloud::Memorystore::V1beta::Instance::InstanceEndpoint](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-memorystore-v1beta/latest/Google-Cloud-Memorystore-V1beta-Instance-InstanceEndpoint)\>) --- Optional. Endpoints for the instance.
**Returns**

- (::Array\<[::Google::Cloud::Memorystore::V1beta::Instance::InstanceEndpoint](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-memorystore-v1beta/latest/Google-Cloud-Memorystore-V1beta-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. Immutable. Engine version of the instance.

### #engine_version=

    def engine_version=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. Immutable. Engine version of the instance.
**Returns**

- (::String) --- Optional. Immutable. Engine version of the instance.

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

### #mode

    def mode() -> ::Google::Cloud::Memorystore::V1beta::Instance::Mode

**Returns**

- ([::Google::Cloud::Memorystore::V1beta::Instance::Mode](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-memorystore-v1beta/latest/Google-Cloud-Memorystore-V1beta-Instance-Mode)) --- Optional. The mode config for the instance.

### #mode=

    def mode=(value) -> ::Google::Cloud::Memorystore::V1beta::Instance::Mode

**Parameter**

- **value** ([::Google::Cloud::Memorystore::V1beta::Instance::Mode](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-memorystore-v1beta/latest/Google-Cloud-Memorystore-V1beta-Instance-Mode)) --- Optional. The mode config for the instance.
**Returns**

- ([::Google::Cloud::Memorystore::V1beta::Instance::Mode](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-memorystore-v1beta/latest/Google-Cloud-Memorystore-V1beta-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::V1beta::NodeConfig

**Returns**

- ([::Google::Cloud::Memorystore::V1beta::NodeConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-memorystore-v1beta/latest/Google-Cloud-Memorystore-V1beta-NodeConfig)) --- Output only. Configuration of individual nodes of the instance.

### #node_type

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

**Returns**

- ([::Google::Cloud::Memorystore::V1beta::Instance::NodeType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-memorystore-v1beta/latest/Google-Cloud-Memorystore-V1beta-Instance-NodeType)) --- Optional. Immutable. Machine type for individual nodes of the instance.

### #node_type=

    def node_type=(value) -> ::Google::Cloud::Memorystore::V1beta::Instance::NodeType

**Parameter**

- **value** ([::Google::Cloud::Memorystore::V1beta::Instance::NodeType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-memorystore-v1beta/latest/Google-Cloud-Memorystore-V1beta-Instance-NodeType)) --- Optional. Immutable. Machine type for individual nodes of the instance.
**Returns**

- ([::Google::Cloud::Memorystore::V1beta::Instance::NodeType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-memorystore-v1beta/latest/Google-Cloud-Memorystore-V1beta-Instance-NodeType)) --- Optional. Immutable. Machine type for individual nodes of the instance.

### #persistence_config

    def persistence_config() -> ::Google::Cloud::Memorystore::V1beta::PersistenceConfig

**Returns**

- ([::Google::Cloud::Memorystore::V1beta::PersistenceConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-memorystore-v1beta/latest/Google-Cloud-Memorystore-V1beta-PersistenceConfig)) --- Optional. Persistence configuration of the instance.

### #persistence_config=

    def persistence_config=(value) -> ::Google::Cloud::Memorystore::V1beta::PersistenceConfig

**Parameter**

- **value** ([::Google::Cloud::Memorystore::V1beta::PersistenceConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-memorystore-v1beta/latest/Google-Cloud-Memorystore-V1beta-PersistenceConfig)) --- Optional. Persistence configuration of the instance.
**Returns**

- ([::Google::Cloud::Memorystore::V1beta::PersistenceConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-memorystore-v1beta/latest/Google-Cloud-Memorystore-V1beta-PersistenceConfig)) --- Optional. Persistence configuration of the instance.

### #psc_auto_connections

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

**Returns**

- (::Array\<[::Google::Cloud::Memorystore::V1beta::PscAutoConnection](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-memorystore-v1beta/latest/Google-Cloud-Memorystore-V1beta-PscAutoConnection)\>) --- Required. Immutable. User inputs and resource details of the auto-created PSC connections.

### #psc_auto_connections=

    def psc_auto_connections=(value) -> ::Array<::Google::Cloud::Memorystore::V1beta::PscAutoConnection>

**Parameter**

- **value** (::Array\<[::Google::Cloud::Memorystore::V1beta::PscAutoConnection](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-memorystore-v1beta/latest/Google-Cloud-Memorystore-V1beta-PscAutoConnection)\>) --- Required. Immutable. User inputs and resource details of the auto-created PSC connections.
**Returns**

- (::Array\<[::Google::Cloud::Memorystore::V1beta::PscAutoConnection](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-memorystore-v1beta/latest/Google-Cloud-Memorystore-V1beta-PscAutoConnection)\>) --- Required. Immutable. User inputs and resource details of the auto-created PSC connections.

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

### #rotate_server_certificate

    def rotate_server_certificate() -> ::Boolean

**Returns**

- (::Boolean) --- Optional. Input only. Rotate the server certificates.

### #rotate_server_certificate=

    def rotate_server_certificate=(value) -> ::Boolean

**Parameter**

- **value** (::Boolean) --- Optional. Input only. Rotate the server certificates.
**Returns**

- (::Boolean) --- Optional. Input only. Rotate the server certificates.

### #server_ca_mode

    def server_ca_mode() -> ::Google::Cloud::Memorystore::V1beta::Instance::ServerCaMode

**Returns**

- ([::Google::Cloud::Memorystore::V1beta::Instance::ServerCaMode](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-memorystore-v1beta/latest/Google-Cloud-Memorystore-V1beta-Instance-ServerCaMode)) --- Optional. Immutable. The Server CA mode for the instance.

### #server_ca_mode=

    def server_ca_mode=(value) -> ::Google::Cloud::Memorystore::V1beta::Instance::ServerCaMode

**Parameter**

- **value** ([::Google::Cloud::Memorystore::V1beta::Instance::ServerCaMode](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-memorystore-v1beta/latest/Google-Cloud-Memorystore-V1beta-Instance-ServerCaMode)) --- Optional. Immutable. The Server CA mode for the instance.
**Returns**

- ([::Google::Cloud::Memorystore::V1beta::Instance::ServerCaMode](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-memorystore-v1beta/latest/Google-Cloud-Memorystore-V1beta-Instance-ServerCaMode)) --- Optional. Immutable. The Server CA mode for the instance.

### #server_ca_pool

    def server_ca_pool() -> ::String

**Returns**

- (::String) --- Optional. Immutable. The customer-managed CA pool for the instance. Only applicable if the Server CA mode is CUSTOMER_MANAGED_CAS_CA. Format: "projects/{project}/locations/{region}/caPools/{ca_pool}".

### #server_ca_pool=

    def server_ca_pool=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. Immutable. The customer-managed CA pool for the instance. Only applicable if the Server CA mode is CUSTOMER_MANAGED_CAS_CA. Format: "projects/{project}/locations/{region}/caPools/{ca_pool}".
**Returns**

- (::String) --- Optional. Immutable. The customer-managed CA pool for the instance. Only applicable if the Server CA mode is CUSTOMER_MANAGED_CAS_CA. Format: "projects/{project}/locations/{region}/caPools/{ca_pool}".

### #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::V1beta::Instance::State

**Returns**

- ([::Google::Cloud::Memorystore::V1beta::Instance::State](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-memorystore-v1beta/latest/Google-Cloud-Memorystore-V1beta-Instance-State)) --- Output only. Current state of the instance.

### #state_info

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

**Returns**

- ([::Google::Cloud::Memorystore::V1beta::Instance::StateInfo](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-memorystore-v1beta/latest/Google-Cloud-Memorystore-V1beta-Instance-StateInfo)) --- Output only. Additional information about the state of the instance.

### #transit_encryption_mode

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

**Returns**

- ([::Google::Cloud::Memorystore::V1beta::Instance::TransitEncryptionMode](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-memorystore-v1beta/latest/Google-Cloud-Memorystore-V1beta-Instance-TransitEncryptionMode)) --- Optional. Immutable. In-transit encryption mode of the instance.

### #transit_encryption_mode=

    def transit_encryption_mode=(value) -> ::Google::Cloud::Memorystore::V1beta::Instance::TransitEncryptionMode

**Parameter**

- **value** ([::Google::Cloud::Memorystore::V1beta::Instance::TransitEncryptionMode](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-memorystore-v1beta/latest/Google-Cloud-Memorystore-V1beta-Instance-TransitEncryptionMode)) --- Optional. Immutable. In-transit encryption mode of the instance.
**Returns**

- ([::Google::Cloud::Memorystore::V1beta::Instance::TransitEncryptionMode](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-memorystore-v1beta/latest/Google-Cloud-Memorystore-V1beta-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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-memorystore-v1beta/latest/Google-Protobuf-Timestamp)) --- Output only. Latest update timestamp of the instance.

### #zone_distribution_config

    def zone_distribution_config() -> ::Google::Cloud::Memorystore::V1beta::ZoneDistributionConfig

**Returns**

- ([::Google::Cloud::Memorystore::V1beta::ZoneDistributionConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-memorystore-v1beta/latest/Google-Cloud-Memorystore-V1beta-ZoneDistributionConfig)) --- Optional. Immutable. Zone distribution configuration of the instance for node allocation.

### #zone_distribution_config=

    def zone_distribution_config=(value) -> ::Google::Cloud::Memorystore::V1beta::ZoneDistributionConfig

**Parameter**

- **value** ([::Google::Cloud::Memorystore::V1beta::ZoneDistributionConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-memorystore-v1beta/latest/Google-Cloud-Memorystore-V1beta-ZoneDistributionConfig)) --- Optional. Immutable. Zone distribution configuration of the instance for node allocation.
**Returns**

- ([::Google::Cloud::Memorystore::V1beta::ZoneDistributionConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-memorystore-v1beta/latest/Google-Cloud-Memorystore-V1beta-ZoneDistributionConfig)) --- Optional. Immutable. Zone distribution configuration of the instance for node allocation.