Instance class

A Google Cloud Redis instance.


Instance.fromJson(Map _json)


alternativeLocationId String
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.
read / write
authorizedNetwork String
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.
read / write
connectMode String
Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING. Possible string values are: [...]
read / write
createTime String
Output only. The time the instance was created.
read / write
currentLocationId String
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 provided by the user at creation time. For Standard Tier instances, this can be either location_id or alternative_location_id and can change after a failover event.
read / write
displayName String
An arbitrary and optional user-provided name for the instance.
read / write
hashCode int
The hash code for this object. [...]
read-only, inherited
host String
Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
read / write
labels Map<String, String>
Resource labels to represent user provided metadata
read / write
locationId String
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 is also provided, it must be different from location_id.
read / write
memorySizeGb int
Required. Redis memory size in GiB.
read / write
name String
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.
read / write
persistenceIamIdentity String
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.
read / write
port int
Output only. The port number of the exposed Redis endpoint.
read / write
redisConfigs Map<String, String>
Optional. Redis configuration parameters, according to 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
read / write
redisVersion String
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
read / write
reservedIpRange String
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, or Ranges must be unique and non-overlapping with existing subnets in an authorized network.
read / write
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
state String
Output only. The current state of this instance. Possible string values are: [...]
read / write
statusMessage String
Output only. Additional information about the current status of this instance, if available.
read / write
tier String
Required. The service tier of the instance. Possible string values are: [...]
read / write


noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
toJson() Map<String, Object>
toString() String
Returns a string representation of this object.


operator ==(Object other) bool
The equality operator. [...]