Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class SqlInstancesDeleteRequest.
Instance delete request.
Generated from protobuf message google.cloud.sql.v1.SqlInstancesDeleteRequest
Namespace
Google \ Cloud \ Sql \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ instance |
string
Cloud SQL instance ID. This does not include the project ID. |
↳ project |
string
Project ID of the project that contains the instance to be deleted. |
↳ enable_final_backup |
bool
Flag to opt-in for final backup. By default, it is turned off. |
↳ final_backup_ttl_days |
int|string
Optional. Retention period of the final backup. |
↳ final_backup_expiry_time |
Google\Protobuf\Timestamp
Optional. Final Backup expiration time. Timestamp in UTC of when this resource is considered expired. |
↳ final_backup_description |
string
Optional. The description of the final backup. |
getInstance
Cloud SQL instance ID. This does not include the project ID.
| Returns | |
|---|---|
| Type | Description |
string |
|
setInstance
Cloud SQL instance ID. This does not include the project ID.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProject
Project ID of the project that contains the instance to be deleted.
| Returns | |
|---|---|
| Type | Description |
string |
|
setProject
Project ID of the project that contains the instance to be deleted.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnableFinalBackup
Flag to opt-in for final backup. By default, it is turned off.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasEnableFinalBackup
clearEnableFinalBackup
setEnableFinalBackup
Flag to opt-in for final backup. By default, it is turned off.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFinalBackupTtlDays
Optional. Retention period of the final backup.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasFinalBackupTtlDays
setFinalBackupTtlDays
Optional. Retention period of the final backup.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFinalBackupExpiryTime
Optional. Final Backup expiration time.
Timestamp in UTC of when this resource is considered expired.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasFinalBackupExpiryTime
setFinalBackupExpiryTime
Optional. Final Backup expiration time.
Timestamp in UTC of when this resource is considered expired.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFinalBackupDescription
Optional. The description of the final backup.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFinalBackupDescription
Optional. The description of the final backup.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExpiration
| Returns | |
|---|---|
| Type | Description |
string |
|