Cloud SQL Admin V1 API - Class Google::Cloud::Sql::V1::StartWorkloadCaptureContext (v0.5.0)

Reference documentation and code samples for the Cloud SQL Admin V1 API class Google::Cloud::Sql::V1::StartWorkloadCaptureContext.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#enable_live_replay

def enable_live_replay() -> ::Boolean
Returns
  • (::Boolean) — 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.

#enable_live_replay=

def enable_live_replay=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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
  • (::Boolean) — 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

def replay_instance() -> ::String
Returns
  • (::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.

#replay_instance=

def replay_instance=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.