Class Instance (2.4.0)

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

A Google Cloud Redis instance.

Inheritance

Object > Instance

Implements

IMessage<Instance>, IEquatable<Instance>, IDeepCloneable<Instance>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Redis.V1

Assembly

Google.Cloud.Redis.V1.dll

Constructors

Instance()

public Instance()

Instance(Instance)

public Instance(Instance other)

Parameter
Name	Description
`other`	`Instance`

Properties

AlternativeLocationId

public string AlternativeLocationId { get; set; }

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.

Property Value
Type	Description
`String`

AuthorizedNetwork

public string AuthorizedNetwork { get; set; }

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.

Property Value
Type	Description
`String`

ConnectMode

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

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

Property Value
Type	Description
`Instance.Types.ConnectMode`

CreateTime

public Timestamp CreateTime { get; set; }

Output only. The time the instance was created.

Property Value
Type	Description
`Timestamp`

CurrentLocationId

public string CurrentLocationId { get; set; }

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.

Property Value
Type	Description
`String`

DisplayName

public string DisplayName { get; set; }

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

Property Value
Type	Description
`String`

Host

public string Host { get; set; }

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

Property Value
Type	Description
`String`

InstanceName

public InstanceName InstanceName { get; set; }

InstanceName-typed view over the Name resource name property.

Property Value
Type	Description
`InstanceName`

Labels

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

Resource labels to represent user provided metadata

Property Value
Type	Description
`MapField<String, String>`

LocationId

public string LocationId { get; set; }

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.

Property Value
Type	Description
`String`

MemorySizeGb

public int MemorySizeGb { get; set; }

Required. Redis memory size in GiB.

Property Value
Type	Description
`Int32`

Name

public string Name { get; set; }

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][google.cloud.redis.v1.Instance.location_id] and [alternative_location_id][google.cloud.redis.v1.Instance.alternative_location_id] fields for more details.

Property Value
Type	Description
`String`

Nodes

public RepeatedField<NodeInfo> Nodes { get; }

Output only. Info per node.

Property Value
Type	Description
`RepeatedField<NodeInfo>`

PersistenceIamIdentity

public string PersistenceIamIdentity { get; set; }

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

Property Value
Type	Description
`String`

Port

public int Port { get; set; }

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

Property Value
Type	Description
`Int32`

ReadEndpoint

public string ReadEndpoint { get; set; }

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

Property Value
Type	Description
`String`

ReadEndpointPort

public int ReadEndpointPort { get; set; }

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

Property Value
Type	Description
`Int32`

ReadReplicasMode

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

Optional. Read replica mode.

Property Value
Type	Description
`Instance.Types.ReadReplicasMode`

RedisConfigs

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

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

Property Value
Type	Description
`MapField<String, String>`

RedisVersion

public string RedisVersion { get; set; }

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

Property Value
Type	Description
`String`

ReplicaCount

public int ReplicaCount { get; set; }

Optional. The number of replica nodes. Valid range for standard tier is [1-5] and defaults to 1. Valid value for basic tier is 0 and defaults to 0.

Property Value
Type	Description
`Int32`

ReservedIpRange

public string ReservedIpRange { get; set; }

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.

Property Value
Type	Description
`String`

State

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

Output only. The current state of this instance.

Property Value
Type	Description
`Instance.Types.State`

StatusMessage

public string StatusMessage { get; set; }

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

Property Value
Type	Description
`String`

Tier

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

Required. The service tier of the instance.

Property Value
Type	Description
`Instance.Types.Tier`