final case class Instance(name: String = "", displayName: String = "", uid: String = "", createTime: Option[Timestamp] = _root_.scala.None, updateTime: Option[Timestamp] = _root_.scala.None, deleteTime: Option[Timestamp] = _root_.scala.None, labels: Map[String, String] = _root_.scala.collection.immutable.Map.empty, state: State = com.google.cloud.alloydb.v1.resources.Instance.State.STATE_UNSPECIFIED, instanceType: InstanceType = com.google.cloud.alloydb.v1.resources.Instance.InstanceType.INSTANCE_TYPE_UNSPECIFIED, machineConfig: Option[MachineConfig] = _root_.scala.None, availabilityType: AvailabilityType = com.google.cloud.alloydb.v1.resources.Instance.AvailabilityType.AVAILABILITY_TYPE_UNSPECIFIED, gceZone: String = "", databaseFlags: Map[String, String] = _root_.scala.collection.immutable.Map.empty, writableNode: Option[Node] = _root_.scala.None, nodes: Seq[Node] = _root_.scala.Seq.empty, queryInsightsConfig: Option[QueryInsightsInstanceConfig] = _root_.scala.None, readPoolConfig: Option[ReadPoolConfig] = _root_.scala.None, ipAddress: String = "", reconciling: Boolean = false, etag: String = "", annotations: Map[String, String] = _root_.scala.collection.immutable.Map.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Instance] with Product with Serializable
An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB.
- name
Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression
[a-z]([a-z0-9-]{0,61}[a-z0-9])?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id}- displayName
User-settable and human-readable display name for the Instance.
- uid
Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
- createTime
Output only. Create time stamp
- updateTime
Output only. Update time stamp
- deleteTime
Output only. Delete time stamp
- labels
Labels as key value pairs
- state
Output only. The current serving state of the instance.
- instanceType
Required. The type of the instance. Specified at creation time.
- machineConfig
Configurations for the machines that host the underlying database engine.
- availabilityType
Availability type of an Instance. If empty, defaults to REGIONAL for primary instances. For read pools, availability_type is always UNSPECIFIED. Instances in the read pools are evenly distributed across available zones within the region (i.e. read pools with more than one node will have a node in at least two zones).
- gceZone
The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.
- databaseFlags
Database flags. Set at instance level. * They are copied from primary instance on read instance creation. * Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary. This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value.
- writableNode
Output only. This is set for the read-write VM of the PRIMARY instance only.
- nodes
Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
- queryInsightsConfig
Configuration for query insights.
- readPoolConfig
Read pool specific config.
- ipAddress
Output only. The IP address for the Instance. This is the connection endpoint for an end-user application.
- reconciling
Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
- etag
For Resource freshness validation (https://google.aip.dev/154)
- annotations
Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
- Annotations
- @SerialVersionUID()
- Source
- Instance.scala
- Alphabetic
- By Inheritance
- Instance
- Updatable
- GeneratedMessage
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Instance(name: String = "", displayName: String = "", uid: String = "", createTime: Option[Timestamp] = _root_.scala.None, updateTime: Option[Timestamp] = _root_.scala.None, deleteTime: Option[Timestamp] = _root_.scala.None, labels: Map[String, String] = _root_.scala.collection.immutable.Map.empty, state: State = com.google.cloud.alloydb.v1.resources.Instance.State.STATE_UNSPECIFIED, instanceType: InstanceType = com.google.cloud.alloydb.v1.resources.Instance.InstanceType.INSTANCE_TYPE_UNSPECIFIED, machineConfig: Option[MachineConfig] = _root_.scala.None, availabilityType: AvailabilityType = com.google.cloud.alloydb.v1.resources.Instance.AvailabilityType.AVAILABILITY_TYPE_UNSPECIFIED, gceZone: String = "", databaseFlags: Map[String, String] = _root_.scala.collection.immutable.Map.empty, writableNode: Option[Node] = _root_.scala.None, nodes: Seq[Node] = _root_.scala.Seq.empty, queryInsightsConfig: Option[QueryInsightsInstanceConfig] = _root_.scala.None, readPoolConfig: Option[ReadPoolConfig] = _root_.scala.None, ipAddress: String = "", reconciling: Boolean = false, etag: String = "", annotations: Map[String, String] = _root_.scala.collection.immutable.Map.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)
- name
Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression
[a-z]([a-z0-9-]{0,61}[a-z0-9])?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id}- displayName
User-settable and human-readable display name for the Instance.
- uid
Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
- createTime
Output only. Create time stamp
- updateTime
Output only. Update time stamp
- deleteTime
Output only. Delete time stamp
- labels
Labels as key value pairs
- state
Output only. The current serving state of the instance.
- instanceType
Required. The type of the instance. Specified at creation time.
- machineConfig
Configurations for the machines that host the underlying database engine.
- availabilityType
Availability type of an Instance. If empty, defaults to REGIONAL for primary instances. For read pools, availability_type is always UNSPECIFIED. Instances in the read pools are evenly distributed across available zones within the region (i.e. read pools with more than one node will have a node in at least two zones).
- gceZone
The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.
- databaseFlags
Database flags. Set at instance level. * They are copied from primary instance on read instance creation. * Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary. This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value.
- writableNode
Output only. This is set for the read-write VM of the PRIMARY instance only.
- nodes
Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
- queryInsightsConfig
Configuration for query insights.
- readPoolConfig
Read pool specific config.
- ipAddress
Output only. The IP address for the Instance. This is the connection endpoint for an end-user application.
- reconciling
Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
- etag
For Resource freshness validation (https://google.aip.dev/154)
- annotations
Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def addAllAnnotations(__vs: Iterable[(String, String)]): Instance
- def addAllDatabaseFlags(__vs: Iterable[(String, String)]): Instance
- def addAllLabels(__vs: Iterable[(String, String)]): Instance
- def addAllNodes(__vs: Iterable[Node]): Instance
- def addAnnotations(__vs: (String, String)*): Instance
- def addDatabaseFlags(__vs: (String, String)*): Instance
- def addLabels(__vs: (String, String)*): Instance
- def addNodes(__vs: Node*): Instance
- val annotations: Map[String, String]
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val availabilityType: AvailabilityType
- def clearAnnotations: Instance
- def clearCreateTime: Instance
- def clearDatabaseFlags: Instance
- def clearDeleteTime: Instance
- def clearLabels: Instance
- def clearMachineConfig: Instance
- def clearNodes: Instance
- def clearQueryInsightsConfig: Instance
- def clearReadPoolConfig: Instance
- def clearUpdateTime: Instance
- def clearWritableNode: Instance
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def companion: Instance.type
- Definition Classes
- Instance → GeneratedMessage
- val createTime: Option[Timestamp]
- val databaseFlags: Map[String, String]
- val deleteTime: Option[Timestamp]
- def discardUnknownFields: Instance
- val displayName: String
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val etag: String
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- val gceZone: String
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getCreateTime: Timestamp
- def getDeleteTime: Timestamp
- def getField(__field: FieldDescriptor): PValue
- Definition Classes
- Instance → GeneratedMessage
- def getFieldByNumber(__fieldNumber: Int): Any
- Definition Classes
- Instance → GeneratedMessage
- def getMachineConfig: MachineConfig
- def getQueryInsightsConfig: QueryInsightsInstanceConfig
- def getReadPoolConfig: ReadPoolConfig
- def getUpdateTime: Timestamp
- def getWritableNode: Node
- val instanceType: InstanceType
- val ipAddress: String
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val labels: Map[String, String]
- val machineConfig: Option[MachineConfig]
- val name: String
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val nodes: Seq[Node]
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val queryInsightsConfig: Option[QueryInsightsInstanceConfig]
- val readPoolConfig: Option[ReadPoolConfig]
- val reconciling: Boolean
- def serializedSize: Int
- Definition Classes
- Instance → GeneratedMessage
- val state: State
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def toByteArray: Array[Byte]
- Definition Classes
- GeneratedMessage
- final def toByteString: ByteString
- Definition Classes
- GeneratedMessage
- final def toPMessage: PMessage
- Definition Classes
- GeneratedMessage
- def toProtoString: String
- Definition Classes
- Instance → GeneratedMessage
- val uid: String
- val unknownFields: UnknownFieldSet
- def update(ms: (Lens[Instance, Instance]) => Mutation[Instance]*): Instance
- Definition Classes
- Updatable
- val updateTime: Option[Timestamp]
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def withAnnotations(__v: Map[String, String]): Instance
- def withAvailabilityType(__v: AvailabilityType): Instance
- def withCreateTime(__v: Timestamp): Instance
- def withDatabaseFlags(__v: Map[String, String]): Instance
- def withDeleteTime(__v: Timestamp): Instance
- def withDisplayName(__v: String): Instance
- def withEtag(__v: String): Instance
- def withGceZone(__v: String): Instance
- def withInstanceType(__v: InstanceType): Instance
- def withIpAddress(__v: String): Instance
- def withLabels(__v: Map[String, String]): Instance
- def withMachineConfig(__v: MachineConfig): Instance
- def withName(__v: String): Instance
- def withNodes(__v: Seq[Node]): Instance
- def withQueryInsightsConfig(__v: QueryInsightsInstanceConfig): Instance
- def withReadPoolConfig(__v: ReadPoolConfig): Instance
- def withReconciling(__v: Boolean): Instance
- def withState(__v: State): Instance
- def withUid(__v: String): Instance
- def withUnknownFields(__v: UnknownFieldSet): Instance
- def withUpdateTime(__v: Timestamp): Instance
- def withWritableNode(__v: Node): Instance
- val writableNode: Option[Node]
- final def writeDelimitedTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
- def writeTo(_output__: CodedOutputStream): Unit
- Definition Classes
- Instance → GeneratedMessage
- final def writeTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage