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

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

The context for the StartWorkloadReplay operation, which contains details about starting the execution of a captured workload (recorded read and write SQL queries) on a replay instance (the Cloud SQL instance where the recorded SQL queries are executed).

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

Namespace

Google \ Cloud \ Sql \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ replay_instance string

Required. 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.
↳ workload_id string

Output only. The ID of the workload to start executing on the replay instance. Each workload capture generates a unique ID in the format workload-<epoch_timestamp> (for example, workload-1786046400). Use this ID to start executing the recorded SQL queries.

getReplayInstance

Required. 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

setReplayInstance

Required. 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

getWorkloadId

Output only. The ID of the workload to start executing on the replay instance. Each workload capture generates a unique ID in the format workload-<epoch_timestamp> (for example, workload-1786046400). Use this ID to start executing the recorded SQL queries.

Returns
Type Description
string

setWorkloadId

Output only. The ID of the workload to start executing on the replay instance. Each workload capture generates a unique ID in the format workload-<epoch_timestamp> (for example, workload-1786046400). Use this ID to start executing the recorded SQL queries.

Parameter
Name Description
var string
Returns
Type Description
$this