Represents an Instance.
Package
@google-cloud/alloydbConstructors
(constructor)(properties)
constructor(properties?: google.cloud.alloydb.v1.IInstance);Constructs a new Instance.
| Parameter | |
|---|---|
| Name | Description |
properties |
IInstance
Properties to set |
Properties
annotations
public annotations: { [k: string]: string };Instance annotations.
availabilityType
public availabilityType: (google.cloud.alloydb.v1.Instance.AvailabilityType|keyof typeof google.cloud.alloydb.v1.Instance.AvailabilityType);Instance availabilityType.
clientConnectionConfig
public clientConnectionConfig?: (google.cloud.alloydb.v1.Instance.IClientConnectionConfig|null);Instance clientConnectionConfig.
createTime
public createTime?: (google.protobuf.ITimestamp|null);Instance createTime.
databaseFlags
public databaseFlags: { [k: string]: string };Instance databaseFlags.
deleteTime
public deleteTime?: (google.protobuf.ITimestamp|null);Instance deleteTime.
displayName
public displayName: string;Instance displayName.
etag
public etag: string;Instance etag.
gceZone
public gceZone: string;Instance gceZone.
instanceType
public instanceType: (google.cloud.alloydb.v1.Instance.InstanceType|keyof typeof google.cloud.alloydb.v1.Instance.InstanceType);Instance instanceType.
ipAddress
public ipAddress: string;Instance ipAddress.
labels
public labels: { [k: string]: string };Instance labels.
machineConfig
public machineConfig?: (google.cloud.alloydb.v1.Instance.IMachineConfig|null);Instance machineConfig.
name
public name: string;Instance name.
networkConfig
public networkConfig?: (google.cloud.alloydb.v1.Instance.IInstanceNetworkConfig|null);Instance networkConfig.
nodes
public nodes: google.cloud.alloydb.v1.Instance.INode[];Instance nodes.
outboundPublicIpAddresses
public outboundPublicIpAddresses: string[];Instance outboundPublicIpAddresses.
pscInstanceConfig
public pscInstanceConfig?: (google.cloud.alloydb.v1.Instance.IPscInstanceConfig|null);Instance pscInstanceConfig.
publicIpAddress
public publicIpAddress: string;Instance publicIpAddress.
queryInsightsConfig
public queryInsightsConfig?: (google.cloud.alloydb.v1.Instance.IQueryInsightsInstanceConfig|null);Instance queryInsightsConfig.
readPoolConfig
public readPoolConfig?: (google.cloud.alloydb.v1.Instance.IReadPoolConfig|null);Instance readPoolConfig.
reconciling
public reconciling: boolean;Instance reconciling.
satisfiesPzs
public satisfiesPzs: boolean;Instance satisfiesPzs.
state
public state: (google.cloud.alloydb.v1.Instance.State|keyof typeof google.cloud.alloydb.v1.Instance.State);Instance state.
uid
public uid: string;Instance uid.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);Instance updateTime.
writableNode
public writableNode?: (google.cloud.alloydb.v1.Instance.INode|null);Instance writableNode.
Methods
create(properties)
public static create(properties?: google.cloud.alloydb.v1.IInstance): google.cloud.alloydb.v1.Instance;Creates a new Instance instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IInstance
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Instance |
Instance instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.alloydb.v1.Instance;Decodes an Instance message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Instance |
Instance |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.alloydb.v1.Instance;Decodes an Instance message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Instance |
Instance |
encode(message, writer)
public static encode(message: google.cloud.alloydb.v1.IInstance, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Instance message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IInstance
Instance message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.alloydb.v1.IInstance, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Instance message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IInstance
Instance message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.alloydb.v1.Instance;Creates an Instance message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
Instance |
Instance |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Instance
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this Instance to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.alloydb.v1.Instance, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an Instance message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Instance
Instance |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies an Instance message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|