Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class WorkloadCapture.
Captured workload for an instance.
Generated from protobuf message google.cloud.sql.v1.WorkloadCapture
Namespace
Google \ Cloud \ Sql \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ workload_id |
string
Output only. The ID of the captured workload. |
↳ source_instance |
string
Output only. The name of the source instance. |
↳ workload_capture_state |
int
Output only. The state of the workload capture. |
↳ start_time |
Google\Protobuf\Timestamp
Output only. The start time of the workload capture. |
↳ end_time |
Google\Protobuf\Timestamp
Output only. The end time of the workload capture. |
↳ replay_instance |
string
Output only. The name of the replay instance, if live replay was enabled. |
↳ retention_days |
int
Output only. The retention period in days for the captured workload. |
↳ backup_id |
string
Output only. The base backup ID associated with the workload capture. |
getWorkloadId
Output only. The ID of the captured workload.
| Returns | |
|---|---|
| Type | Description |
string |
|
setWorkloadId
Output only. The ID of the captured workload.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSourceInstance
Output only. The name of the source instance.
| Returns | |
|---|---|
| Type | Description |
string |
|
setSourceInstance
Output only. The name of the source instance.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getWorkloadCaptureState
Output only. The state of the workload capture.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type State. |
setWorkloadCaptureState
Output only. The state of the workload capture.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type State. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStartTime
Output only. The start time of the workload capture.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasStartTime
clearStartTime
setStartTime
Output only. The start time of the workload capture.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEndTime
Output only. The end time of the workload capture.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasEndTime
clearEndTime
setEndTime
Output only. The end time of the workload capture.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReplayInstance
Output only. The name of the replay instance, if live replay was enabled.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasReplayInstance
clearReplayInstance
setReplayInstance
Output only. The name of the replay instance, if live replay was enabled.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRetentionDays
Output only. The retention period in days for the captured workload.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasRetentionDays
clearRetentionDays
setRetentionDays
Output only. The retention period in days for the captured workload.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBackupId
Output only. The base backup ID associated with the workload capture.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasBackupId
clearBackupId
setBackupId
Output only. The base backup ID associated with the workload capture.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|