Class Instance

A Memorystore for Redis instance.

Inheritance
object
Instance
Implements
Inherited Members
Namespace: Google.Apis.CloudRedis.v1.Data
Assembly: Google.Apis.CloudRedis.v1.dll
Syntax
public class Instance : IDirectResponseSchema

Properties

AlternativeLocationId

Optional. If specified, at least one node will be provisioned in this zone in addition to the zone specified in location_id. Only applicable to standard tier. If provided, it must be a different zone from the one provided in [location_id]. Additional nodes beyond the first 2 will be placed in zones selected by the service.

Declaration
[JsonProperty("alternativeLocationId")]
public virtual string AlternativeLocationId { get; set; }
Property Value
Type Description
string

AuthEnabled

Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If set to "true" AUTH is enabled on the instance. Default value is "false" meaning AUTH is disabled.

Declaration
[JsonProperty("authEnabled")]
public virtual bool? AuthEnabled { get; set; }
Property Value
Type Description
bool?

AuthorizedNetwork

Optional. The full name of the Google Compute Engine network to which the instance is connected. If left unspecified, the default network will be used.

Declaration
[JsonProperty("authorizedNetwork")]
public virtual string AuthorizedNetwork { get; set; }
Property Value
Type Description
string

AvailableMaintenanceVersions

Optional. The available maintenance versions that an instance could update to.

Declaration
[JsonProperty("availableMaintenanceVersions")]
public virtual IList<string> AvailableMaintenanceVersions { get; set; }
Property Value
Type Description
IList<string>

ConnectMode

Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.

Declaration
[JsonProperty("connectMode")]
public virtual string ConnectMode { get; set; }
Property Value
Type Description
string

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

Output only. The time the instance was created.

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

CurrentLocationId

Output only. The current zone where the Redis primary node is located. In basic tier, this will always be the same as [location_id]. In standard tier, this can be the zone of any node in the instance.

Declaration
[JsonProperty("currentLocationId")]
public virtual string CurrentLocationId { get; set; }
Property Value
Type Description
string

CustomerManagedKey

Optional. The KMS key reference that the customer provides when trying to create the instance.

Declaration
[JsonProperty("customerManagedKey")]
public virtual string CustomerManagedKey { get; set; }
Property Value
Type Description
string

DisplayName

An arbitrary and optional user-provided name for the instance.

Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Host

Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.

Declaration
[JsonProperty("host")]
public virtual string Host { get; set; }
Property Value
Type Description
string

Labels

Resource labels to represent user provided metadata

Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
IDictionary<string, string>

LocationId

Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone from the specified region for the instance. For standard tier, additional nodes will be added across multiple zones for protection against zonal failures. If specified, at least one node will be provisioned in this zone.

Declaration
[JsonProperty("locationId")]
public virtual string LocationId { get; set; }
Property Value
Type Description
string

MaintenancePolicy

Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time.

Declaration
[JsonProperty("maintenancePolicy")]
public virtual MaintenancePolicy MaintenancePolicy { get; set; }
Property Value
Type Description
MaintenancePolicy

MaintenanceSchedule

Output only. Date and time of upcoming maintenance events which have been scheduled.

Declaration
[JsonProperty("maintenanceSchedule")]
public virtual MaintenanceSchedule MaintenanceSchedule { get; set; }
Property Value
Type Description
MaintenanceSchedule

MaintenanceVersion

Optional. The self service update maintenance version. The version is date based such as "20210712_00_00".

Declaration
[JsonProperty("maintenanceVersion")]
public virtual string MaintenanceVersion { get; set; }
Property Value
Type Description
string

MemorySizeGb

Required. Redis memory size in GiB.

Declaration
[JsonProperty("memorySizeGb")]
public virtual int? MemorySizeGb { get; set; }
Property Value
Type Description
int?

Name

Required. Unique name of the resource in this scope including project and location using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to location_id and alternative_location_id fields for more details.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

Nodes

Output only. Info per node.

Declaration
[JsonProperty("nodes")]
public virtual IList<NodeInfo> Nodes { get; set; }
Property Value
Type Description
IList<NodeInfo>

PersistenceConfig

Optional. Persistence configuration parameters

Declaration
[JsonProperty("persistenceConfig")]
public virtual PersistenceConfig PersistenceConfig { get; set; }
Property Value
Type Description
PersistenceConfig

PersistenceIamIdentity

Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:". The value may change over time for a given instance so should be checked before each import/export operation.

Declaration
[JsonProperty("persistenceIamIdentity")]
public virtual string PersistenceIamIdentity { get; set; }
Property Value
Type Description
string

Port

Output only. The port number of the exposed Redis endpoint.

Declaration
[JsonProperty("port")]
public virtual int? Port { get; set; }
Property Value
Type Description
int?

ReadEndpoint

Output only. Hostname or IP address of the exposed readonly Redis endpoint. Standard tier only. Targets all healthy replica nodes in instance. Replication is asynchronous and replica nodes will exhibit some lag behind the primary. Write requests must target 'host'.

Declaration
[JsonProperty("readEndpoint")]
public virtual string ReadEndpoint { get; set; }
Property Value
Type Description
string

ReadEndpointPort

Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'.

Declaration
[JsonProperty("readEndpointPort")]
public virtual int? ReadEndpointPort { get; set; }
Property Value
Type Description
int?

ReadReplicasMode

Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED.

Declaration
[JsonProperty("readReplicasMode")]
public virtual string ReadReplicasMode { get; set; }
Property Value
Type Description
string

RedisConfigs

Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries

Declaration
[JsonProperty("redisConfigs")]
public virtual IDictionary<string, string> RedisConfigs { get; set; }
Property Value
Type Description
IDictionary<string, string>

RedisVersion

Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: * REDIS_3_2 for Redis 3.2 compatibility * REDIS_4_0 for Redis 4.0 compatibility (default) * REDIS_5_0 for Redis 5.0 compatibility * REDIS_6_X for Redis 6.x compatibility

  • REDIS_7_0 for Redis 7.0 compatibility
Declaration
[JsonProperty("redisVersion")]
public virtual string RedisVersion { get; set; }
Property Value
Type Description
string

ReplicaCount

Optional. The number of replica nodes. The valid range for the Standard Tier with read replicas enabled is [1-5] and defaults to 2. If read replicas are not enabled for a Standard Tier instance, the only valid value is 1 and the default is 1. The valid value for basic tier is 0 and the default is also 0.

Declaration
[JsonProperty("replicaCount")]
public virtual int? ReplicaCount { get; set; }
Property Value
Type Description
int?

ReservedIpRange

Optional. For DIRECT_PEERING mode, the CIDR range of internal addresses that are reserved for this instance. Range must be unique and non-overlapping with existing subnets in an authorized network. For PRIVATE_SERVICE_ACCESS mode, the name of one allocated IP address ranges associated with this private service access connection. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. For READ_REPLICAS_ENABLED the default block size is /28.

Declaration
[JsonProperty("reservedIpRange")]
public virtual string ReservedIpRange { get; set; }
Property Value
Type Description
string

SatisfiesPzi

Optional. Output only. Reserved for future use.

Declaration
[JsonProperty("satisfiesPzi")]
public virtual bool? SatisfiesPzi { get; set; }
Property Value
Type Description
bool?

SatisfiesPzs

Optional. Output only. Reserved for future use.

Declaration
[JsonProperty("satisfiesPzs")]
public virtual bool? SatisfiesPzs { get; set; }
Property Value
Type Description
bool?

SecondaryIpRange

Optional. Additional IP range for node placement. Required when enabling read replicas on an existing instance. For DIRECT_PEERING mode value must be a CIDR range of size /28, or "auto". For PRIVATE_SERVICE_ACCESS mode value must be the name of an allocated address range associated with the private service access connection, or "auto".

Declaration
[JsonProperty("secondaryIpRange")]
public virtual string SecondaryIpRange { get; set; }
Property Value
Type Description
string

ServerCaCerts

Output only. List of server CA certificates for the instance.

Declaration
[JsonProperty("serverCaCerts")]
public virtual IList<TlsCertificate> ServerCaCerts { get; set; }
Property Value
Type Description
IList<TlsCertificate>

State

Output only. The current state of this instance.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

StatusMessage

Output only. Additional information about the current status of this instance, if available.

Declaration
[JsonProperty("statusMessage")]
public virtual string StatusMessage { get; set; }
Property Value
Type Description
string

SuspensionReasons

Optional. reasons that causes instance in "SUSPENDED" state.

Declaration
[JsonProperty("suspensionReasons")]
public virtual IList<string> SuspensionReasons { get; set; }
Property Value
Type Description
IList<string>

Tier

Required. The service tier of the instance.

Declaration
[JsonProperty("tier")]
public virtual string Tier { get; set; }
Property Value
Type Description
string

TransitEncryptionMode

Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.

Declaration
[JsonProperty("transitEncryptionMode")]
public virtual string TransitEncryptionMode { get; set; }
Property Value
Type Description
string

Implements