Google Cloud Dms V1 Client - Class PrimaryInstanceSettings (1.1.0)

Reference documentation and code samples for the Google Cloud Dms V1 Client class PrimaryInstanceSettings.

Settings for the cluster's primary instance

Generated from protobuf message google.cloud.clouddms.v1.AlloyDbSettings.PrimaryInstanceSettings

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ id string

Required. The ID of the AlloyDB primary instance. The ID must satisfy the regex expression "[a-z0-9-]+".

↳ machine_config Google\Cloud\CloudDms\V1\AlloyDbSettings\PrimaryInstanceSettings\MachineConfig

Configuration for the machines that host the underlying database engine.

↳ database_flags array|Google\Protobuf\Internal\MapField

Database flags to pass to AlloyDB when DMS is creating the AlloyDB cluster and instances. See the AlloyDB documentation for how these can be used.

↳ labels array|Google\Protobuf\Internal\MapField

Labels for the AlloyDB primary instance created by DMS. An object containing a list of 'key', 'value' pairs.

↳ private_ip string

Output only. The private IP address for the Instance. This is the connection endpoint for an end-user application.

getId

Required. The ID of the AlloyDB primary instance. The ID must satisfy the regex expression "[a-z0-9-]+".

Returns
TypeDescription
string

setId

Required. The ID of the AlloyDB primary instance. The ID must satisfy the regex expression "[a-z0-9-]+".

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getMachineConfig

Configuration for the machines that host the underlying database engine.

Returns
TypeDescription
Google\Cloud\CloudDms\V1\AlloyDbSettings\PrimaryInstanceSettings\MachineConfig|null

hasMachineConfig

clearMachineConfig

setMachineConfig

Configuration for the machines that host the underlying database engine.

Parameter
NameDescription
var Google\Cloud\CloudDms\V1\AlloyDbSettings\PrimaryInstanceSettings\MachineConfig
Returns
TypeDescription
$this

getDatabaseFlags

Database flags to pass to AlloyDB when DMS is creating the AlloyDB cluster and instances. See the AlloyDB documentation for how these can be used.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setDatabaseFlags

Database flags to pass to AlloyDB when DMS is creating the AlloyDB cluster and instances. See the AlloyDB documentation for how these can be used.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getLabels

Labels for the AlloyDB primary instance created by DMS. An object containing a list of 'key', 'value' pairs.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

Labels for the AlloyDB primary instance created by DMS. An object containing a list of 'key', 'value' pairs.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getPrivateIp

Output only. The private IP address for the Instance.

This is the connection endpoint for an end-user application.

Returns
TypeDescription
string

setPrivateIp

Output only. The private IP address for the Instance.

This is the connection endpoint for an end-user application.

Parameter
NameDescription
var string
Returns
TypeDescription
$this