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 \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 |
↳ 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 corresponding public key is encoded in the client's certificate. |
↳ dump_file_path |
string
The dump file to create the Cloud SQL replica. |
↳ source_instance |
InstanceReference
The reference to Cloud SQL instance if the source is Cloud SQL. |
↳ selected_objects |
array<SelectedObjects>
Optional. A list of objects that the user selects for replication from an external source instance. |
↳ ssl_option |
int
Optional. SSL option for replica connection to the on-premises source. |
getHostPort
The host and port of the on-premises instance in host:port format
| Returns | |
|---|---|
| Type | Description |
string |
|
setHostPort
The host and port of the on-premises instance in host:port format
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKind
This is always sql#onPremisesConfiguration.
| Returns | |
|---|---|
| Type | Description |
string |
|
setKind
This is always sql#onPremisesConfiguration.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUsername
The username for connecting to on-premises instance.
| Returns | |
|---|---|
| Type | Description |
string |
|
setUsername
The username for connecting to on-premises instance.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPassword
The password for connecting to on-premises instance.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPassword
The password for connecting to on-premises instance.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCaCertificate
PEM representation of the trusted CA's x509 certificate.
| Returns | |
|---|---|
| Type | Description |
string |
|
setCaCertificate
PEM representation of the trusted CA's x509 certificate.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getClientCertificate
PEM representation of the replica's x509 certificate.
| Returns | |
|---|---|
| Type | Description |
string |
|
setClientCertificate
PEM representation of the replica's x509 certificate.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getClientKey
PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate.
| Returns | |
|---|---|
| Type | Description |
string |
|
setClientKey
PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDumpFilePath
The dump file to create the Cloud SQL replica.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDumpFilePath
The dump file to create the Cloud SQL replica.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSourceInstance
The reference to Cloud SQL instance if the source is Cloud SQL.
| Returns | |
|---|---|
| Type | Description |
InstanceReference|null |
|
hasSourceInstance
clearSourceInstance
setSourceInstance
The reference to Cloud SQL instance if the source is Cloud SQL.
| Parameter | |
|---|---|
| Name | Description |
var |
InstanceReference
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSelectedObjects
Optional. A list of objects that the user selects for replication from an external source instance.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setSelectedObjects
Optional. A list of objects that the user selects for replication from an external source instance.
| Parameter | |
|---|---|
| Name | Description |
var |
array<SelectedObjects>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSslOption
Optional. SSL option for replica connection to the on-premises source.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type SslOption. |
setSslOption
Optional. SSL option for replica connection to the on-premises source.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type SslOption. |
| Returns | |
|---|---|
| Type | Description |
$this |
|