Class protos.google.cloud.sql.v1beta4.DatabaseInstance.PoolNodeConfig (0.25.0)

Represents a PoolNodeConfig.

Implements

Package

@google-cloud/sql

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.sql.v1beta4.DatabaseInstance.IPoolNodeConfig);

Constructs a new PoolNodeConfig.

Parameter
Name Description
properties IPoolNodeConfig

Properties to set

Properties

dnsName

public dnsName?: (string|null);

PoolNodeConfig dnsName.

dnsNames

public dnsNames: google.cloud.sql.v1beta4.IDnsNameMapping[];

PoolNodeConfig dnsNames.

gceZone

public gceZone?: (string|null);

PoolNodeConfig gceZone.

ipAddresses

public ipAddresses: google.cloud.sql.v1beta4.IIpMapping[];

PoolNodeConfig ipAddresses.

name

public name?: (string|null);

PoolNodeConfig name.

pscAutoConnections

public pscAutoConnections: google.cloud.sql.v1beta4.IPscAutoConnectionConfig[];

PoolNodeConfig pscAutoConnections.

public pscServiceAttachmentLink?: (string|null);

PoolNodeConfig pscServiceAttachmentLink.

state

public state?: (google.cloud.sql.v1beta4.DatabaseInstance.SqlInstanceState|keyof typeof google.cloud.sql.v1beta4.DatabaseInstance.SqlInstanceState|null);

PoolNodeConfig state.

Methods

create(properties)

public static create(properties?: google.cloud.sql.v1beta4.DatabaseInstance.IPoolNodeConfig): google.cloud.sql.v1beta4.DatabaseInstance.PoolNodeConfig;

Creates a new PoolNodeConfig instance using the specified properties.

Parameter
Name Description
properties IPoolNodeConfig

Properties to set

Returns
Type Description
PoolNodeConfig

PoolNodeConfig instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.sql.v1beta4.DatabaseInstance.PoolNodeConfig;

Decodes a PoolNodeConfig 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
PoolNodeConfig

PoolNodeConfig

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.sql.v1beta4.DatabaseInstance.PoolNodeConfig;

Decodes a PoolNodeConfig message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
PoolNodeConfig

PoolNodeConfig

encode(message, writer)

public static encode(message: google.cloud.sql.v1beta4.DatabaseInstance.IPoolNodeConfig, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified PoolNodeConfig message. Does not implicitly messages.

Parameters
Name Description
message IPoolNodeConfig

PoolNodeConfig 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.sql.v1beta4.DatabaseInstance.IPoolNodeConfig, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified PoolNodeConfig message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IPoolNodeConfig

PoolNodeConfig 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.sql.v1beta4.DatabaseInstance.PoolNodeConfig;

Creates a PoolNodeConfig 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
PoolNodeConfig

PoolNodeConfig

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for PoolNodeConfig

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 PoolNodeConfig to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.sql.v1beta4.DatabaseInstance.PoolNodeConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a PoolNodeConfig message. Also converts values to other types if specified.

Parameters
Name Description
message PoolNodeConfig

PoolNodeConfig

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 a PoolNodeConfig message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not