Google Cloud Memorystore for Redis V1BETA1 API - Class Google::Cloud::Redis::Cluster::V1beta1::Cluster (v0.3.0)

Reference documentation and code samples for the Google Cloud Memorystore for Redis V1BETA1 API class Google::Cloud::Redis::Cluster::V1beta1::Cluster.

A cluster instance.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#authorization_mode

def authorization_mode() -> ::Google::Cloud::Redis::Cluster::V1beta1::AuthorizationMode

Returns

(::Google::Cloud::Redis::Cluster::V1beta1::AuthorizationMode) — Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.

#authorization_mode=

def authorization_mode=(value) -> ::Google::Cloud::Redis::Cluster::V1beta1::AuthorizationMode

Parameter

value (::Google::Cloud::Redis::Cluster::V1beta1::AuthorizationMode) — Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.

Returns

(::Google::Cloud::Redis::Cluster::V1beta1::AuthorizationMode) — Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.

#automated_backup_config

def automated_backup_config() -> ::Google::Cloud::Redis::Cluster::V1beta1::AutomatedBackupConfig

Returns

(::Google::Cloud::Redis::Cluster::V1beta1::AutomatedBackupConfig) — Optional. The automated backup config for the cluster.

#automated_backup_config=

def automated_backup_config=(value) -> ::Google::Cloud::Redis::Cluster::V1beta1::AutomatedBackupConfig

Parameter

value (::Google::Cloud::Redis::Cluster::V1beta1::AutomatedBackupConfig) — Optional. The automated backup config for the cluster.

Returns

(::Google::Cloud::Redis::Cluster::V1beta1::AutomatedBackupConfig) — Optional. The automated backup config for the cluster.

#backup_collection

def backup_collection() -> ::String

Returns

(::String) — Optional. Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection}

#cluster_endpoints

def cluster_endpoints() -> ::Array<::Google::Cloud::Redis::Cluster::V1beta1::ClusterEndpoint>

Returns

(::Array<::Google::Cloud::Redis::Cluster::V1beta1::ClusterEndpoint>) — Optional. A list of cluster enpoints.

#cluster_endpoints=

def cluster_endpoints=(value) -> ::Array<::Google::Cloud::Redis::Cluster::V1beta1::ClusterEndpoint>

Parameter

value (::Array<::Google::Cloud::Redis::Cluster::V1beta1::ClusterEndpoint>) — Optional. A list of cluster enpoints.

Returns

(::Array<::Google::Cloud::Redis::Cluster::V1beta1::ClusterEndpoint>) — Optional. A list of cluster enpoints.

#create_time

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

Returns

(::Google::Protobuf::Timestamp) — Output only. The timestamp associated with the cluster creation request.

#cross_cluster_replication_config

def cross_cluster_replication_config() -> ::Google::Cloud::Redis::Cluster::V1beta1::CrossClusterReplicationConfig

Returns

(::Google::Cloud::Redis::Cluster::V1beta1::CrossClusterReplicationConfig) — Optional. Cross cluster replication config.

#cross_cluster_replication_config=

def cross_cluster_replication_config=(value) -> ::Google::Cloud::Redis::Cluster::V1beta1::CrossClusterReplicationConfig

Parameter

value (::Google::Cloud::Redis::Cluster::V1beta1::CrossClusterReplicationConfig) — Optional. Cross cluster replication config.

Returns

(::Google::Cloud::Redis::Cluster::V1beta1::CrossClusterReplicationConfig) — Optional. Cross cluster replication config.

#deletion_protection_enabled

def deletion_protection_enabled() -> ::Boolean

Returns

(::Boolean) — Optional. The delete operation will fail when the value is set to true.

#deletion_protection_enabled=

def deletion_protection_enabled=(value) -> ::Boolean

Parameter

value (::Boolean) — Optional. The delete operation will fail when the value is set to true.

Returns

(::Boolean) — Optional. The delete operation will fail when the value is set to true.

#discovery_endpoints

def discovery_endpoints() -> ::Array<::Google::Cloud::Redis::Cluster::V1beta1::DiscoveryEndpoint>

Returns

(::Array<::Google::Cloud::Redis::Cluster::V1beta1::DiscoveryEndpoint>) — Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported.

#encryption_info

def encryption_info() -> ::Google::Cloud::Redis::Cluster::V1beta1::EncryptionInfo

Returns

(::Google::Cloud::Redis::Cluster::V1beta1::EncryptionInfo) — Output only. Encryption information of the data at rest of the cluster.

#gcs_source

def gcs_source() -> ::Google::Cloud::Redis::Cluster::V1beta1::Cluster::GcsBackupSource

Returns

(::Google::Cloud::Redis::Cluster::V1beta1::Cluster::GcsBackupSource) — Optional. Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. 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::Redis::Cluster::V1beta1::Cluster::GcsBackupSource

Parameter

value (::Google::Cloud::Redis::Cluster::V1beta1::Cluster::GcsBackupSource) — Optional. Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. 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::Redis::Cluster::V1beta1::Cluster::GcsBackupSource) — Optional. Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. 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.

#maintenance_policy

def maintenance_policy() -> ::Google::Cloud::Redis::Cluster::V1beta1::ClusterMaintenancePolicy

Returns

(::Google::Cloud::Redis::Cluster::V1beta1::ClusterMaintenancePolicy) — Optional. ClusterMaintenancePolicy determines when to allow or deny updates.

#maintenance_policy=

def maintenance_policy=(value) -> ::Google::Cloud::Redis::Cluster::V1beta1::ClusterMaintenancePolicy

Parameter

value (::Google::Cloud::Redis::Cluster::V1beta1::ClusterMaintenancePolicy) — Optional. ClusterMaintenancePolicy determines when to allow or deny updates.

Returns

(::Google::Cloud::Redis::Cluster::V1beta1::ClusterMaintenancePolicy) — Optional. ClusterMaintenancePolicy determines when to allow or deny updates.

#maintenance_schedule

def maintenance_schedule() -> ::Google::Cloud::Redis::Cluster::V1beta1::ClusterMaintenanceSchedule

Returns

(::Google::Cloud::Redis::Cluster::V1beta1::ClusterMaintenanceSchedule) — Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule.

#managed_backup_source

def managed_backup_source() -> ::Google::Cloud::Redis::Cluster::V1beta1::Cluster::ManagedBackupSource

Returns

(::Google::Cloud::Redis::Cluster::V1beta1::Cluster::ManagedBackupSource) — Optional. Backups 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::Redis::Cluster::V1beta1::Cluster::ManagedBackupSource

Parameter

value (::Google::Cloud::Redis::Cluster::V1beta1::Cluster::ManagedBackupSource) — Optional. Backups 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::Redis::Cluster::V1beta1::Cluster::ManagedBackupSource) — Optional. Backups 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.

#name

def name() -> ::String

Returns

(::String) — Required. Identifier. Unique name of the resource in this scope including project and location using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id}

#name=

def name=(value) -> ::String

Parameter

value (::String) — Required. Identifier. Unique name of the resource in this scope including project and location using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id}

Returns

(::String) — Required. Identifier. Unique name of the resource in this scope including project and location using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id}

#node_type

def node_type() -> ::Google::Cloud::Redis::Cluster::V1beta1::NodeType

Returns

(::Google::Cloud::Redis::Cluster::V1beta1::NodeType) — Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node.

#node_type=

def node_type=(value) -> ::Google::Cloud::Redis::Cluster::V1beta1::NodeType

Parameter

value (::Google::Cloud::Redis::Cluster::V1beta1::NodeType) — Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node.

Returns

(::Google::Cloud::Redis::Cluster::V1beta1::NodeType) — Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node.

#persistence_config

def persistence_config() -> ::Google::Cloud::Redis::Cluster::V1beta1::ClusterPersistenceConfig

Returns

(::Google::Cloud::Redis::Cluster::V1beta1::ClusterPersistenceConfig) — Optional. Persistence config (RDB, AOF) for the cluster.

#persistence_config=

def persistence_config=(value) -> ::Google::Cloud::Redis::Cluster::V1beta1::ClusterPersistenceConfig

Parameter

value (::Google::Cloud::Redis::Cluster::V1beta1::ClusterPersistenceConfig) — Optional. Persistence config (RDB, AOF) for the cluster.

Returns

(::Google::Cloud::Redis::Cluster::V1beta1::ClusterPersistenceConfig) — Optional. Persistence config (RDB, AOF) for the cluster.

#precise_size_gb

def precise_size_gb() -> ::Float

Returns

(::Float) — Output only. Precise value of redis memory size in GB for the entire cluster.

#psc_configs

def psc_configs() -> ::Array<::Google::Cloud::Redis::Cluster::V1beta1::PscConfig>

Returns

(::Array<::Google::Cloud::Redis::Cluster::V1beta1::PscConfig>) — Optional. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported.

#psc_configs=

def psc_configs=(value) -> ::Array<::Google::Cloud::Redis::Cluster::V1beta1::PscConfig>

Parameter

value (::Array<::Google::Cloud::Redis::Cluster::V1beta1::PscConfig>) — Optional. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported.

Returns

(::Array<::Google::Cloud::Redis::Cluster::V1beta1::PscConfig>) — Optional. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported.

#psc_connections

def psc_connections() -> ::Array<::Google::Cloud::Redis::Cluster::V1beta1::PscConnection>

Returns

(::Array<::Google::Cloud::Redis::Cluster::V1beta1::PscConnection>) — Output only. The list of PSC connections that are auto-created through service connectivity automation.

#psc_service_attachments

def psc_service_attachments() -> ::Array<::Google::Cloud::Redis::Cluster::V1beta1::PscServiceAttachment>

Returns

(::Array<::Google::Cloud::Redis::Cluster::V1beta1::PscServiceAttachment>) — Output only. Service attachment details to configure Psc connections

#redis_configs

def redis_configs() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — Optional. Key/Value pairs of customer overrides for mutable Redis Configs

#redis_configs=

def redis_configs=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — Optional. Key/Value pairs of customer overrides for mutable Redis Configs

Returns

(::Google::Protobuf::Map{::String => ::String}) — Optional. Key/Value pairs of customer overrides for mutable Redis Configs

#replica_count

def replica_count() -> ::Integer

Returns

(::Integer) — Optional. The number of replica nodes per shard.

#replica_count=

def replica_count=(value) -> ::Integer

Parameter

value (::Integer) — Optional. The number of replica nodes per shard.

Returns

(::Integer) — Optional. The number of replica nodes per shard.

#shard_count

def shard_count() -> ::Integer

Returns

(::Integer) — Optional. Number of shards for the Redis cluster.

#shard_count=

def shard_count=(value) -> ::Integer

Parameter

value (::Integer) — Optional. Number of shards for the Redis cluster.

Returns

(::Integer) — Optional. Number of shards for the Redis cluster.

#size_gb

def size_gb() -> ::Integer

Returns

(::Integer) — Output only. Redis memory size in GB for the entire cluster rounded up to the next integer.

#state

def state() -> ::Google::Cloud::Redis::Cluster::V1beta1::Cluster::State

Returns

(::Google::Cloud::Redis::Cluster::V1beta1::Cluster::State) — Output only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED

#state_info

def state_info() -> ::Google::Cloud::Redis::Cluster::V1beta1::Cluster::StateInfo

Returns

(::Google::Cloud::Redis::Cluster::V1beta1::Cluster::StateInfo) — Output only. Additional information about the current state of the cluster.

#transit_encryption_mode

def transit_encryption_mode() -> ::Google::Cloud::Redis::Cluster::V1beta1::TransitEncryptionMode

Returns

(::Google::Cloud::Redis::Cluster::V1beta1::TransitEncryptionMode) — Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster.

#transit_encryption_mode=

def transit_encryption_mode=(value) -> ::Google::Cloud::Redis::Cluster::V1beta1::TransitEncryptionMode

Parameter

value (::Google::Cloud::Redis::Cluster::V1beta1::TransitEncryptionMode) — Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster.

Returns

(::Google::Cloud::Redis::Cluster::V1beta1::TransitEncryptionMode) — Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster.

#uid

def uid() -> ::String

Returns

(::String) — Output only. System assigned, unique identifier for the cluster.

#zone_distribution_config

def zone_distribution_config() -> ::Google::Cloud::Redis::Cluster::V1beta1::ZoneDistributionConfig

Returns

(::Google::Cloud::Redis::Cluster::V1beta1::ZoneDistributionConfig) — Optional. This config will be used to determine how the customer wants us to distribute cluster resources within the region.

#zone_distribution_config=

def zone_distribution_config=(value) -> ::Google::Cloud::Redis::Cluster::V1beta1::ZoneDistributionConfig

Parameter

value (::Google::Cloud::Redis::Cluster::V1beta1::ZoneDistributionConfig) — Optional. This config will be used to determine how the customer wants us to distribute cluster resources within the region.

Returns

(::Google::Cloud::Redis::Cluster::V1beta1::ZoneDistributionConfig) — Optional. This config will be used to determine how the customer wants us to distribute cluster resources within the region.