Memorystore V1 API - Class Google::Cloud::Memorystore::V1::Instance (v0.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

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

#create_time

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

Returns

(::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::V1::DiscoveryEndpoint>

Returns

(::Array<::Google::Cloud::Memorystore::V1::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::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. 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::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. Immutable. 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. Immutable. Machine type for individual nodes of the instance.

Returns

(::Google::Cloud::Memorystore::V1::Instance::NodeType) — Optional. Immutable. Machine type for individual nodes of 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_auto_connections

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

Returns

(::Array<::Google::Cloud::Memorystore::V1::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::V1::PscAutoConnection>

Parameter

value (::Array<::Google::Cloud::Memorystore::V1::PscAutoConnection>) — Required. Immutable. User inputs and resource details of the auto-created PSC connections.

Returns

(::Array<::Google::Cloud::Memorystore::V1::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.

#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

(::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.