Memorystore v1 API - Class Instance (1.0.0-beta05)

public sealed class Instance : IMessage<Instance>, IEquatable<Instance>, IDeepCloneable<Instance>, IBufferMessage, IMessage

Reference documentation and code samples for the Memorystore v1 API class Instance.

A Memorystore instance.

Inheritance

object > Instance

Implements

IMessage Instance, IEquatable Instance, IDeepCloneable Instance, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Memorystore.V1

Assembly

Google.Cloud.Memorystore.V1.dll

Constructors

Instance()

public Instance()

Instance(Instance)

public Instance(Instance other)

Parameter
Name	Description
`other`	`Instance`

Properties

AllowFewerZonesDeployment

[Obsolete]
public bool AllowFewerZonesDeployment { get; set; }

Optional. Immutable. Deprecated, do not use.

Property Value
Type	Description
`bool`

AsyncInstanceEndpointsDeletionEnabled

public bool AsyncInstanceEndpointsDeletionEnabled { get; set; }

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.

Property Value
Type	Description
`bool`

AuthorizationMode

public Instance.Types.AuthorizationMode AuthorizationMode { get; set; }

Optional. Immutable. Authorization mode of the instance.

Property Value
Type	Description
`InstanceTypesAuthorizationMode`

AutomatedBackupConfig

public AutomatedBackupConfig AutomatedBackupConfig { get; set; }

Optional. The automated backup config for the instance.

Property Value
Type	Description
`AutomatedBackupConfig`

AvailableMaintenanceVersions

public RepeatedField<string> AvailableMaintenanceVersions { get; }

Output only. This field is used to determine the available maintenance versions for the self service update.

Property Value
Type	Description
`RepeatedFieldstring`

BackupCollection

public string BackupCollection { get; set; }

Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection}

Property Value
Type	Description
`string`

BackupCollectionAsBackupCollectionName

public BackupCollectionName BackupCollectionAsBackupCollectionName { get; set; }

BackupCollectionName-typed view over the BackupCollection resource name property.

Property Value
Type	Description
`BackupCollectionName`

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Creation timestamp of the instance.

Property Value
Type	Description
`Timestamp`

CrossInstanceReplicationConfig

public CrossInstanceReplicationConfig CrossInstanceReplicationConfig { get; set; }

Optional. The config for cross instance replication.

Property Value
Type	Description
`CrossInstanceReplicationConfig`

DeletionProtectionEnabled

public bool DeletionProtectionEnabled { get; set; }

Optional. If set to true deletion of the instance will fail.

Property Value
Type	Description
`bool`

DiscoveryEndpoints

[Obsolete]
public RepeatedField<DiscoveryEndpoint> DiscoveryEndpoints { get; }

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.

Property Value
Type	Description
`RepeatedFieldDiscoveryEndpoint`

EffectiveMaintenanceVersion

public string EffectiveMaintenanceVersion { get; set; }

Output only. This field represents the actual maintenance version of the instance.

Property Value
Type	Description
`string`

EncryptionInfo

public EncryptionInfo EncryptionInfo { get; set; }

Output only. Encryption information of the data at rest of the cluster.

Property Value
Type	Description
`EncryptionInfo`

Endpoints

public RepeatedField<Instance.Types.InstanceEndpoint> Endpoints { get; }

Optional. Endpoints for the instance.

Property Value
Type	Description
`RepeatedFieldInstanceTypesInstanceEndpoint`

EngineConfigs

public MapField<string, string> EngineConfigs { get; }

Optional. User-provided engine configurations for the instance.

Property Value
Type	Description
`MapFieldstringstring`

EngineVersion

public string EngineVersion { get; set; }

Optional. Engine version of the instance.

Property Value
Type	Description
`string`

GcsSource

public Instance.Types.GcsBackupSource GcsSource { get; set; }

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.

Property Value
Type	Description
`InstanceTypesGcsBackupSource`

HasAsyncInstanceEndpointsDeletionEnabled

public bool HasAsyncInstanceEndpointsDeletionEnabled { get; }

Gets whether the "async_instance_endpoints_deletion_enabled" field is set

Property Value
Type	Description
`bool`

HasBackupCollection

public bool HasBackupCollection { get; }

Gets whether the "backup_collection" field is set

Property Value
Type	Description
`bool`

HasDeletionProtectionEnabled

public bool HasDeletionProtectionEnabled { get; }

Gets whether the "deletion_protection_enabled" field is set

Property Value
Type	Description
`bool`

HasEffectiveMaintenanceVersion

public bool HasEffectiveMaintenanceVersion { get; }

Gets whether the "effective_maintenance_version" field is set

Property Value
Type	Description
`bool`

HasKmsKey

public bool HasKmsKey { get; }

Gets whether the "kms_key" field is set

Property Value
Type	Description
`bool`

HasMaintenanceVersion

public bool HasMaintenanceVersion { get; }

Gets whether the "maintenance_version" field is set

Property Value
Type	Description
`bool`

HasOndemandMaintenance

[Obsolete]
public bool HasOndemandMaintenance { get; }

Gets whether the "ondemand_maintenance" field is set

Property Value
Type	Description
`bool`

HasReplicaCount

public bool HasReplicaCount { get; }

Gets whether the "replica_count" field is set

Property Value
Type	Description
`bool`

HasSatisfiesPzi

public bool HasSatisfiesPzi { get; }

Gets whether the "satisfies_pzi" field is set

Property Value
Type	Description
`bool`

HasSatisfiesPzs

public bool HasSatisfiesPzs { get; }

Gets whether the "satisfies_pzs" field is set

Property Value
Type	Description
`bool`

HasSimulateMaintenanceEvent

public bool HasSimulateMaintenanceEvent { get; }

Gets whether the "simulate_maintenance_event" field is set

Property Value
Type	Description
`bool`

ImportSourcesCase

public Instance.ImportSourcesOneofCase ImportSourcesCase { get; }

Property Value
Type	Description
`InstanceImportSourcesOneofCase`

InstanceName

public InstanceName InstanceName { get; set; }

InstanceName-typed view over the Name resource name property.

Property Value
Type	Description
`InstanceName`

KmsKey

public string KmsKey { get; set; }

Optional. The KMS key used to encrypt the at-rest data of the cluster.

Property Value
Type	Description
`string`

KmsKeyAsCryptoKeyName

public CryptoKeyName KmsKeyAsCryptoKeyName { get; set; }

CryptoKeyName-typed view over the KmsKey resource name property.

Property Value
Type	Description
`CryptoKeyName`

Labels

public MapField<string, string> Labels { get; }

Optional. Labels to represent user-provided metadata.

Property Value
Type	Description
`MapFieldstringstring`

MaintenancePolicy

public MaintenancePolicy MaintenancePolicy { get; set; }

Optional. The maintenance policy for the instance. If not provided, the maintenance event will be performed based on Memorystore internal rollout schedule.

Property Value
Type	Description
`MaintenancePolicy`

MaintenanceSchedule

public MaintenanceSchedule MaintenanceSchedule { get; set; }

Output only. Published maintenance schedule.

Property Value
Type	Description
`MaintenanceSchedule`

MaintenanceVersion

public string MaintenanceVersion { get; set; }

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.

Property Value
Type	Description
`string`

ManagedBackupSource

public Instance.Types.ManagedBackupSource ManagedBackupSource { get; set; }

Optional. Immutable. Backups that generated and managed by memorystore service.

Property Value
Type	Description
`InstanceTypesManagedBackupSource`

Mode

public Instance.Types.Mode Mode { get; set; }

Optional. The mode config for the instance.

Property Value
Type	Description
`InstanceTypesMode`

Name

public string Name { get; set; }

Identifier. Unique name of the instance. Format: projects/{project}/locations/{location}/instances/{instance}

Property Value
Type	Description
`string`

NodeConfig

public NodeConfig NodeConfig { get; set; }

Output only. Configuration of individual nodes of the instance.

Property Value
Type	Description
`NodeConfig`

NodeType

public Instance.Types.NodeType NodeType { get; set; }

Optional. Machine type for individual nodes of the instance.

Property Value
Type	Description
`InstanceTypesNodeType`

OndemandMaintenance

[Obsolete]
public bool OndemandMaintenance { get; set; }

Optional. Input only. Ondemand maintenance for the instance.

Property Value
Type	Description
`bool`

PersistenceConfig

public PersistenceConfig PersistenceConfig { get; set; }

Optional. Persistence configuration of the instance.

Property Value
Type	Description
`PersistenceConfig`

PscAttachmentDetails

public RepeatedField<PscAttachmentDetail> PscAttachmentDetails { get; }

Output only. Service attachment details to configure PSC connections.

Property Value
Type	Description
`RepeatedFieldPscAttachmentDetail`

PscAutoConnections

[Obsolete]
public RepeatedField<PscAutoConnection> PscAutoConnections { get; }

Optional. Immutable. Deprecated: Use the endpoints.connections.psc_auto_connection value instead.

Property Value
Type	Description
`RepeatedFieldPscAutoConnection`

ReplicaCount

public int ReplicaCount { get; set; }

Optional. Number of replica nodes per shard. If omitted the default is 0 replicas.

Property Value
Type	Description
`int`

SatisfiesPzi

public bool SatisfiesPzi { get; set; }

Optional. Output only. Reserved for future use.

Property Value
Type	Description
`bool`

SatisfiesPzs

public bool SatisfiesPzs { get; set; }