Google Cloud Sql Admin V1 Client - Class PoolNodeConfig (1.6.0)

Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class PoolNodeConfig.

Details of a single read pool node of a read pool.

Generated from protobuf message google.cloud.sql.v1.DatabaseInstance.PoolNodeConfig

Namespace

Google \ Cloud \ Sql \ V1 \ DatabaseInstance

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Output only. The name of the read pool node, to be used for retrieving metrics and logs.

↳ gce_zone string

Output only. The zone of the read pool node.

↳ ip_addresses array<Google\Cloud\Sql\V1\IpMapping>

Output only. Mappings containing IP addresses that can be used to connect to the read pool node.

↳ dns_name string

Output only. The DNS name of the read pool node.

↳ state int

Output only. The current state of the read pool node.

↳ dns_names array<Google\Cloud\Sql\V1\DnsNameMapping>

Output only. The list of DNS names used by this read pool node.

↳ psc_service_attachment_link string

Output only. The Private Service Connect (PSC) service attachment of the read pool node.

↳ psc_auto_connections array<Google\Cloud\Sql\V1\PscAutoConnectionConfig>

Output only. The list of settings for requested automatically-setup Private Service Connect (PSC) consumer endpoints that can be used to connect to this read pool node.

getName

Output only. The name of the read pool node, to be used for retrieving metrics and logs.

Returns
Type Description
string

hasName

clearName

setName

Output only. The name of the read pool node, to be used for retrieving metrics and logs.

Parameter
Name Description
var string
Returns
Type Description
$this

getGceZone

Output only. The zone of the read pool node.

Returns
Type Description
string

hasGceZone

clearGceZone

setGceZone

Output only. The zone of the read pool node.

Parameter
Name Description
var string
Returns
Type Description
$this

getIpAddresses

Output only. Mappings containing IP addresses that can be used to connect to the read pool node.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setIpAddresses

Output only. Mappings containing IP addresses that can be used to connect to the read pool node.

Parameter
Name Description
var array<Google\Cloud\Sql\V1\IpMapping>
Returns
Type Description
$this

getDnsName

Output only. The DNS name of the read pool node.

Returns
Type Description
string

hasDnsName

clearDnsName

setDnsName

Output only. The DNS name of the read pool node.

Parameter
Name Description
var string
Returns
Type Description
$this

getState

Output only. The current state of the read pool node.

Returns
Type Description
int

hasState

clearState

setState

Output only. The current state of the read pool node.

Parameter
Name Description
var int
Returns
Type Description
$this

getDnsNames

Output only. The list of DNS names used by this read pool node.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setDnsNames

Output only. The list of DNS names used by this read pool node.

Parameter
Name Description
var array<Google\Cloud\Sql\V1\DnsNameMapping>
Returns
Type Description
$this

Output only. The Private Service Connect (PSC) service attachment of the read pool node.

Returns
Type Description
string

Output only. The Private Service Connect (PSC) service attachment of the read pool node.

Parameter
Name Description
var string
Returns
Type Description
$this

getPscAutoConnections

Output only. The list of settings for requested automatically-setup Private Service Connect (PSC) consumer endpoints that can be used to connect to this read pool node.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setPscAutoConnections

Output only. The list of settings for requested automatically-setup Private Service Connect (PSC) consumer endpoints that can be used to connect to this read pool node.

Parameter
Name Description
var array<Google\Cloud\Sql\V1\PscAutoConnectionConfig>
Returns
Type Description
$this