Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class CloneContext.
Database instance clone context.
Generated from protobuf message google.cloud.sql.v1.CloneContext
Namespace
Google \ Cloud \ Sql \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ kind |
string
This is always |
↳ pitr_timestamp_ms |
int|string
Reserved for future use. |
↳ destination_instance_name |
string
Name of the Cloud SQL instance to be created as a clone. |
↳ bin_log_coordinates |
Google\Cloud\Sql\V1\BinLogCoordinates
Binary log coordinates, if specified, identify the position up to which the source instance is cloned. If not specified, the source instance is cloned up to the most recent binary log coordinates. |
↳ point_in_time |
Google\Protobuf\Timestamp
Timestamp, if specified, identifies the time to which the source instance is cloned. |
↳ allocated_ip_range |
string
The name of the allocated ip range for the private ip Cloud SQL instance. For example: "google-managed-services-default". If set, the cloned instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?. Reserved for future use. |
↳ database_names |
array
(SQL Server only) Clone only the specified databases from the source instance. Clone all databases if empty. |
↳ preferred_zone |
string
Optional. Copy clone and point-in-time recovery clone of an instance to the specified zone. If no zone is specified, clone to the same primary zone as the source instance. This field applies to all DB types. |
getKind
This is always sql#cloneContext.
| Returns | |
|---|---|
| Type | Description |
string |
|
setKind
This is always sql#cloneContext.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPitrTimestampMs
Reserved for future use.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setPitrTimestampMs
Reserved for future use.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDestinationInstanceName
Name of the Cloud SQL instance to be created as a clone.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDestinationInstanceName
Name of the Cloud SQL instance to be created as a clone.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBinLogCoordinates
Binary log coordinates, if specified, identify the position up to which the source instance is cloned. If not specified, the source instance is cloned up to the most recent binary log coordinates.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Sql\V1\BinLogCoordinates|null |
|
hasBinLogCoordinates
clearBinLogCoordinates
setBinLogCoordinates
Binary log coordinates, if specified, identify the position up to which the source instance is cloned. If not specified, the source instance is cloned up to the most recent binary log coordinates.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Sql\V1\BinLogCoordinates
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPointInTime
Timestamp, if specified, identifies the time to which the source instance is cloned.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasPointInTime
clearPointInTime
setPointInTime
Timestamp, if specified, identifies the time to which the source instance is cloned.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAllocatedIpRange
The name of the allocated ip range for the private ip Cloud SQL instance.
For example: "google-managed-services-default". If set, the cloned instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?. Reserved for future use.
| Returns | |
|---|---|
| Type | Description |
string |
|
setAllocatedIpRange
The name of the allocated ip range for the private ip Cloud SQL instance.
For example: "google-managed-services-default". If set, the cloned instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?. Reserved for future use.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDatabaseNames
(SQL Server only) Clone only the specified databases from the source instance. Clone all databases if empty.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setDatabaseNames
(SQL Server only) Clone only the specified databases from the source instance. Clone all databases if empty.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPreferredZone
Optional. Copy clone and point-in-time recovery clone of an instance to the specified zone. If no zone is specified, clone to the same primary zone as the source instance. This field applies to all DB types.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasPreferredZone
clearPreferredZone
setPreferredZone
Optional. Copy clone and point-in-time recovery clone of an instance to the specified zone. If no zone is specified, clone to the same primary zone as the source instance. This field applies to all DB types.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|