Google Cloud Sql Admin V1 Client - Class StartWorkloadCaptureContext (1.13.0)

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

The context for the StartWorkloadCapture operation, which contains details to start recording the workload (SQL queries) on a Cloud SQL instance.

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

Namespace

Google \ Cloud \ Sql \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ enable_live_replay bool

Optional. If true, the captured workload is simultaneously executed on a separate, ephemeral Cloud SQL instance. This "live replay" instance is automatically provisioned and is cloned from the source instance. If false (the default), the workload is only stored and no live replay occurs. It can be replayed later using a separate StartWorkloadReplayRequest. Note: The workload capture runs continuously until an explicit StopWorkloadCaptureRequest is issued.
↳ replay_instance string

Optional. Required if enable_live_replay is true. The name of the Cloud SQL instance where the captured workload (SQL queries) is being executed, excluding the project ID (for example, my-replay-instance). The instance name must start with a lowercase letter and contain only lowercase letters, numbers, and hyphens. The combined length of project-ID:instance-name must be 98 characters or less.

getEnableLiveReplay

Optional. If true, the captured workload is simultaneously executed on a separate, ephemeral Cloud SQL instance. This "live replay" instance is automatically provisioned and is cloned from the source instance. If false (the default), the workload is only stored and no live replay occurs.

It can be replayed later using a separate StartWorkloadReplayRequest. Note: The workload capture runs continuously until an explicit StopWorkloadCaptureRequest is issued.

Returns
Type Description
bool

setEnableLiveReplay

Optional. If true, the captured workload is simultaneously executed on a separate, ephemeral Cloud SQL instance. This "live replay" instance is automatically provisioned and is cloned from the source instance. If false (the default), the workload is only stored and no live replay occurs.

It can be replayed later using a separate StartWorkloadReplayRequest. Note: The workload capture runs continuously until an explicit StopWorkloadCaptureRequest is issued.

Parameter
Name Description
var bool
Returns
Type Description
$this

getReplayInstance

Optional. Required if enable_live_replay is true.

The name of the Cloud SQL instance where the captured workload (SQL queries) is being executed, excluding the project ID (for example, my-replay-instance). The instance name must start with a lowercase letter and contain only lowercase letters, numbers, and hyphens. The combined length of project-ID:instance-name must be 98 characters or less.

Returns
Type Description
string

hasReplayInstance

clearReplayInstance

setReplayInstance

Optional. Required if enable_live_replay is true.

The name of the Cloud SQL instance where the captured workload (SQL queries) is being executed, excluding the project ID (for example, my-replay-instance). The instance name must start with a lowercase letter and contain only lowercase letters, numbers, and hyphens. The combined length of project-ID:instance-name must be 98 characters or less.

Parameter
Name Description
var string
Returns
Type Description
$this