Struct StartWorkloadCaptureContext 

#[non_exhaustive]
pub struct StartWorkloadCaptureContext {
    pub enable_live_replay: bool,
    pub replay_instance: Option<String>,
    /* private fields */
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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: Option<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.

Implementations

impl StartWorkloadCaptureContext

pub fn new() -> Self

Creates a new default instance.

pub fn set_enable_live_replay<T: Into<bool>>(self, v: T) -> Self

Sets the value of enable_live_replay.

Example

let x = StartWorkloadCaptureContext::new().set_enable_live_replay(true);

pub fn set_replay_instance<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of replay_instance.

Example

let x = StartWorkloadCaptureContext::new().set_replay_instance("example");

pub fn set_or_clear_replay_instance<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of replay_instance.

Example

let x = StartWorkloadCaptureContext::new().set_or_clear_replay_instance(Some("example"));
let x = StartWorkloadCaptureContext::new().set_or_clear_replay_instance(None::<String>);

Trait Implementations

impl Clone for StartWorkloadCaptureContext

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StartWorkloadCaptureContext

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for StartWorkloadCaptureContext

fn default() -> Self

Returns the “default value” for a type.

impl Message for StartWorkloadCaptureContext

fn typename() -> &'static str

The typename of this message.

impl PartialEq for StartWorkloadCaptureContext

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for StartWorkloadCaptureContext