final case class Instance(name: String = "", displayName: String = "", labels: Map[String, String] = _root_.scala.collection.immutable.Map.empty, locationId: String = "", alternativeLocationId: String = "", redisVersion: String = "", reservedIpRange: String = "", secondaryIpRange: String = "", host: String = "", port: Int = 0, currentLocationId: String = "", createTime: Option[Timestamp] = _root_.scala.None, state: State = com.google.cloud.redis.v1.cloud_redis.Instance.State.STATE_UNSPECIFIED, statusMessage: String = "", redisConfigs: Map[String, String] = _root_.scala.collection.immutable.Map.empty, tier: Tier = com.google.cloud.redis.v1.cloud_redis.Instance.Tier.TIER_UNSPECIFIED, memorySizeGb: Int = 0, authorizedNetwork: String = "", persistenceIamIdentity: String = "", connectMode: ConnectMode = com.google.cloud.redis.v1.cloud_redis.Instance.ConnectMode.CONNECT_MODE_UNSPECIFIED, authEnabled: Boolean = false, serverCaCerts: Seq[TlsCertificate] = _root_.scala.Seq.empty, transitEncryptionMode: TransitEncryptionMode = com.google.cloud.redis.v1.cloud_redis.Instance.TransitEncryptionMode.TRANSIT_ENCRYPTION_MODE_UNSPECIFIED, maintenancePolicy: Option[MaintenancePolicy] = _root_.scala.None, maintenanceSchedule: Option[MaintenanceSchedule] = _root_.scala.None, replicaCount: Int = 0, nodes: Seq[NodeInfo] = _root_.scala.Seq.empty, readEndpoint: String = "", readEndpointPort: Int = 0, readReplicasMode: ReadReplicasMode = com.google.cloud.redis.v1.cloud_redis.Instance.ReadReplicasMode.READ_REPLICAS_MODE_UNSPECIFIED, customerManagedKey: String = "", persistenceConfig: Option[PersistenceConfig] = _root_.scala.None, suspensionReasons: Seq[SuspensionReason] = _root_.scala.Seq.empty, maintenanceVersion: String = "", availableMaintenanceVersions: Seq[String] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Instance] with Product with Serializable

A Memorystore for Redis instance.

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

displayName

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

labels

Resource labels to represent user provided metadata

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.

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.

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

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.

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

host

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

port

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

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.

createTime

Output only. The time the instance was created.

state

Output only. The current state of this instance.

statusMessage

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

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

tier

Required. The service tier of the instance.

memorySizeGb

Required. Redis memory size in GiB.

authorizedNetwork

Optional. The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the default network will be used.

persistenceIamIdentity

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.

connectMode

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

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.

serverCaCerts

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

transitEncryptionMode

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

maintenancePolicy

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

maintenanceSchedule

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

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.

nodes

Output only. Info per node.

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

readEndpointPort

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

readReplicasMode

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

customerManagedKey

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

persistenceConfig

Optional. Persistence configuration parameters

suspensionReasons

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

maintenanceVersion

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

availableMaintenanceVersions

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

Annotations
@SerialVersionUID()
Source
Instance.scala
Linear Supertypes
Updatable[Instance], GeneratedMessage, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Instance
  2. Updatable
  3. GeneratedMessage
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Instance(name: String = "", displayName: String = "", labels: Map[String, String] = _root_.scala.collection.immutable.Map.empty, locationId: String = "", alternativeLocationId: String = "", redisVersion: String = "", reservedIpRange: String = "", secondaryIpRange: String = "", host: String = "", port: Int = 0, currentLocationId: String = "", createTime: Option[Timestamp] = _root_.scala.None, state: State = com.google.cloud.redis.v1.cloud_redis.Instance.State.STATE_UNSPECIFIED, statusMessage: String = "", redisConfigs: Map[String, String] = _root_.scala.collection.immutable.Map.empty, tier: Tier = com.google.cloud.redis.v1.cloud_redis.Instance.Tier.TIER_UNSPECIFIED, memorySizeGb: Int = 0, authorizedNetwork: String = "", persistenceIamIdentity: String = "", connectMode: ConnectMode = com.google.cloud.redis.v1.cloud_redis.Instance.ConnectMode.CONNECT_MODE_UNSPECIFIED, authEnabled: Boolean = false, serverCaCerts: Seq[TlsCertificate] = _root_.scala.Seq.empty, transitEncryptionMode: TransitEncryptionMode = com.google.cloud.redis.v1.cloud_redis.Instance.TransitEncryptionMode.TRANSIT_ENCRYPTION_MODE_UNSPECIFIED, maintenancePolicy: Option[MaintenancePolicy] = _root_.scala.None, maintenanceSchedule: Option[MaintenanceSchedule] = _root_.scala.None, replicaCount: Int = 0, nodes: Seq[NodeInfo] = _root_.scala.Seq.empty, readEndpoint: String = "", readEndpointPort: Int = 0, readReplicasMode: ReadReplicasMode = com.google.cloud.redis.v1.cloud_redis.Instance.ReadReplicasMode.READ_REPLICAS_MODE_UNSPECIFIED, customerManagedKey: String = "", persistenceConfig: Option[PersistenceConfig] = _root_.scala.None, suspensionReasons: Seq[SuspensionReason] = _root_.scala.Seq.empty, maintenanceVersion: String = "", availableMaintenanceVersions: Seq[String] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

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

    displayName

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

    labels

    Resource labels to represent user provided metadata

    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.

    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.

    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

    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.

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

    host

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

    port

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

    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.

    createTime

    Output only. The time the instance was created.

    state

    Output only. The current state of this instance.

    statusMessage

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

    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

    tier

    Required. The service tier of the instance.

    memorySizeGb

    Required. Redis memory size in GiB.

    authorizedNetwork

    Optional. The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the default network will be used.

    persistenceIamIdentity

    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.

    connectMode

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

    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.

    serverCaCerts

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

    transitEncryptionMode

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

    maintenancePolicy

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

    maintenanceSchedule

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

    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.

    nodes

    Output only. Info per node.

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

    readEndpointPort

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

    readReplicasMode

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

    customerManagedKey

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

    persistenceConfig

    Optional. Persistence configuration parameters

    suspensionReasons

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

    maintenanceVersion

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

    availableMaintenanceVersions

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

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAllAvailableMaintenanceVersions(__vs: Iterable[String]): Instance
  5. def addAllLabels(__vs: Iterable[(String, String)]): Instance
  6. def addAllNodes(__vs: Iterable[NodeInfo]): Instance
  7. def addAllRedisConfigs(__vs: Iterable[(String, String)]): Instance
  8. def addAllServerCaCerts(__vs: Iterable[TlsCertificate]): Instance
  9. def addAllSuspensionReasons(__vs: Iterable[SuspensionReason]): Instance
  10. def addAvailableMaintenanceVersions(__vs: String*): Instance
  11. def addLabels(__vs: (String, String)*): Instance
  12. def addNodes(__vs: NodeInfo*): Instance
  13. def addRedisConfigs(__vs: (String, String)*): Instance
  14. def addServerCaCerts(__vs: TlsCertificate*): Instance
  15. def addSuspensionReasons(__vs: SuspensionReason*): Instance
  16. val alternativeLocationId: String
  17. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  18. val authEnabled: Boolean
  19. val authorizedNetwork: String
  20. val availableMaintenanceVersions: Seq[String]
  21. def clearAvailableMaintenanceVersions: Instance
  22. def clearCreateTime: Instance
  23. def clearLabels: Instance
  24. def clearMaintenancePolicy: Instance
  25. def clearMaintenanceSchedule: Instance
  26. def clearNodes: Instance
  27. def clearPersistenceConfig: Instance
  28. def clearRedisConfigs: Instance
  29. def clearServerCaCerts: Instance
  30. def clearSuspensionReasons: Instance
  31. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  32. def companion: Instance.type
    Definition Classes
    Instance → GeneratedMessage
  33. val connectMode: ConnectMode
  34. val createTime: Option[Timestamp]
  35. val currentLocationId: String
  36. val customerManagedKey: String
  37. def discardUnknownFields: Instance
  38. val displayName: String
  39. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  40. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  41. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  42. def getCreateTime: Timestamp
  43. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    Instance → GeneratedMessage
  44. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    Instance → GeneratedMessage
  45. def getMaintenancePolicy: MaintenancePolicy
  46. def getMaintenanceSchedule: MaintenanceSchedule
  47. def getPersistenceConfig: PersistenceConfig
  48. val host: String
  49. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  50. val labels: Map[String, String]
  51. val locationId: String
  52. val maintenancePolicy: Option[MaintenancePolicy]
  53. val maintenanceSchedule: Option[MaintenanceSchedule]
  54. val maintenanceVersion: String
  55. val memorySizeGb: Int
  56. val name: String
  57. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  58. val nodes: Seq[NodeInfo]
  59. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  60. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  61. val persistenceConfig: Option[PersistenceConfig]
  62. val persistenceIamIdentity: String
  63. val port: Int
  64. def productElementNames: Iterator[String]
    Definition Classes
    Product
  65. val readEndpoint: String
  66. val readEndpointPort: Int
  67. val readReplicasMode: ReadReplicasMode
  68. val redisConfigs: Map[String, String]
  69. val redisVersion: String
  70. val replicaCount: Int
  71. val reservedIpRange: String
  72. val secondaryIpRange: String
  73. def serializedSize: Int
    Definition Classes
    Instance → GeneratedMessage
  74. val serverCaCerts: Seq[TlsCertificate]
  75. val state: State
  76. val statusMessage: String
  77. val suspensionReasons: Seq[SuspensionReason]
  78. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  79. val tier: Tier
  80. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  81. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  82. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  83. def toProtoString: String
    Definition Classes
    Instance → GeneratedMessage
  84. val transitEncryptionMode: TransitEncryptionMode
  85. val unknownFields: UnknownFieldSet
  86. def update(ms: (Lens[Instance, Instance]) => Mutation[Instance]*): Instance
    Definition Classes
    Updatable
  87. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  88. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  89. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  90. def withAlternativeLocationId(__v: String): Instance
  91. def withAuthEnabled(__v: Boolean): Instance
  92. def withAuthorizedNetwork(__v: String): Instance
  93. def withAvailableMaintenanceVersions(__v: Seq[String]): Instance
  94. def withConnectMode(__v: ConnectMode): Instance
  95. def withCreateTime(__v: Timestamp): Instance
  96. def withCurrentLocationId(__v: String): Instance
  97. def withCustomerManagedKey(__v: String): Instance
  98. def withDisplayName(__v: String): Instance
  99. def withHost(__v: String): Instance
  100. def withLabels(__v: Map[String, String]): Instance
  101. def withLocationId(__v: String): Instance
  102. def withMaintenancePolicy(__v: MaintenancePolicy): Instance
  103. def withMaintenanceSchedule(__v: MaintenanceSchedule): Instance
  104. def withMaintenanceVersion(__v: String): Instance
  105. def withMemorySizeGb(__v: Int): Instance
  106. def withName(__v: String): Instance
  107. def withNodes(__v: Seq[NodeInfo]): Instance
  108. def withPersistenceConfig(__v: PersistenceConfig): Instance
  109. def withPersistenceIamIdentity(__v: String): Instance
  110. def withPort(__v: Int): Instance
  111. def withReadEndpoint(__v: String): Instance
  112. def withReadEndpointPort(__v: Int): Instance
  113. def withReadReplicasMode(__v: ReadReplicasMode): Instance
  114. def withRedisConfigs(__v: Map[String, String]): Instance
  115. def withRedisVersion(__v: String): Instance
  116. def withReplicaCount(__v: Int): Instance
  117. def withReservedIpRange(__v: String): Instance
  118. def withSecondaryIpRange(__v: String): Instance
  119. def withServerCaCerts(__v: Seq[TlsCertificate]): Instance
  120. def withState(__v: State): Instance
  121. def withStatusMessage(__v: String): Instance
  122. def withSuspensionReasons(__v: Seq[SuspensionReason]): Instance
  123. def withTier(__v: Tier): Instance
  124. def withTransitEncryptionMode(__v: TransitEncryptionMode): Instance
  125. def withUnknownFields(__v: UnknownFieldSet): Instance
  126. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  127. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    Instance → GeneratedMessage
  128. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Inherited from Updatable[Instance]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped