Class Instance (2.3.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. Only applicable to STANDARD_HA tier which protects the instance against zonal failures by provisioning it across two zones. If provided, it must be a different zone from the one provided in [location_id][google.cloud.redis.v1.Instance.location_id].

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 endpoint is placed. For Basic Tier instances, this will always be the same as the [location_id][google.cloud.redis.v1.Instance.location_id] provided by the user at creation time. For Standard Tier instances, this can be either [location_id][google.cloud.redis.v1.Instance.location_id] or [alternative_location_id][google.cloud.redis.v1.Instance.alternative_location_id] and can change after a failover event.

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 for the instance. For STANDARD_HA tier, instances will be created across two zones for protection against zonal failures. If [alternative_location_id][google.cloud.redis.v1.Instance.alternative_location_id] is also provided, it must be different from [location_id][google.cloud.redis.v1.Instance.location_id].

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`

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`

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

Property Value
Type	Description
`String`

ReservedIpRange

public string ReservedIpRange { get; set; }

Optional. The CIDR range of internal addresses that are reserved for this instance. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique and non-overlapping with existing subnets in an authorized network.

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`