Google Cloud Sql Admin V1 Client - Class OnPremisesConfiguration (0.10.0)

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

On-premises instance configuration.

Generated from protobuf message google.cloud.sql.v1.OnPremisesConfiguration

Namespace

Google \ Cloud \ Sql \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ host_port string

The host and port of the on-premises instance in host:port format

↳ kind string

This is always sql#onPremisesConfiguration.

↳ username string

The username for connecting to on-premises instance.

↳ password string

The password for connecting to on-premises instance.

↳ ca_certificate string

PEM representation of the trusted CA's x509 certificate.

↳ client_certificate string

PEM representation of the replica's x509 certificate.

↳ client_key string

PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.

↳ dump_file_path string

The dump file to create the Cloud SQL replica.

↳ source_instance Google\Cloud\Sql\V1\InstanceReference

The reference to Cloud SQL instance if the source is Cloud SQL.

getHostPort

The host and port of the on-premises instance in host:port format

Returns
TypeDescription
string

setHostPort

The host and port of the on-premises instance in host:port format

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getKind

This is always sql#onPremisesConfiguration.

Returns
TypeDescription
string

setKind

This is always sql#onPremisesConfiguration.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getUsername

The username for connecting to on-premises instance.

Returns
TypeDescription
string

setUsername

The username for connecting to on-premises instance.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPassword

The password for connecting to on-premises instance.

Returns
TypeDescription
string

setPassword

The password for connecting to on-premises instance.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCaCertificate

PEM representation of the trusted CA's x509 certificate.

Returns
TypeDescription
string

setCaCertificate

PEM representation of the trusted CA's x509 certificate.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getClientCertificate

PEM representation of the replica's x509 certificate.

Returns
TypeDescription
string

setClientCertificate

PEM representation of the replica's x509 certificate.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getClientKey

PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.

Returns
TypeDescription
string

setClientKey

PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDumpFilePath

The dump file to create the Cloud SQL replica.

Returns
TypeDescription
string

setDumpFilePath

The dump file to create the Cloud SQL replica.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSourceInstance

The reference to Cloud SQL instance if the source is Cloud SQL.

Returns
TypeDescription
Google\Cloud\Sql\V1\InstanceReference|null

hasSourceInstance

clearSourceInstance

setSourceInstance

The reference to Cloud SQL instance if the source is Cloud SQL.

Parameter
NameDescription
var Google\Cloud\Sql\V1\InstanceReference
Returns
TypeDescription
$this