Struct ExecuteSqlPayload 

#[non_exhaustive]
pub struct ExecuteSqlPayload {
    pub user: String,
    pub sql_statement: String,
    pub database: String,
    pub row_limit: i64,
    pub partial_result_mode: PartialResultMode,
    pub application: String,
    pub user_password: Option<UserPassword>,
    /* private fields */
}

The request payload used to execute SQL statements.

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.

user: String

Optional. The name of an existing database user to connect to the database. When auto_iam_authn is set to true, this field is ignored and the API caller’s IAM user is used.

sql_statement: String

Required. SQL statements to run on the database. It can be a single statement or a sequence of statements separated by semicolons.

database: String

Optional. Name of the database on which the statement will be executed.

row_limit: i64

Optional. The maximum number of rows returned per SQL statement.

partial_result_mode: PartialResultMode

Optional. Controls how the API should respond when the SQL execution result is incomplete due to the size limit or another error. The default mode is to throw an error.

application: String

Optional. Specifies the name of the application that is making the request. This field is used for telemetry. Only alphanumeric characters, dashes, and underscores are allowed. The maximum length is 32 characters.

user_password: Option<UserPassword>

Credentials for the database connection.

Implementations

impl ExecuteSqlPayload

pub fn new() -> Self

pub fn set_user<T: Into<String>>(self, v: T) -> Self

Sets the value of user.

Example

let x = ExecuteSqlPayload::new().set_user("example");

pub fn set_sql_statement<T: Into<String>>(self, v: T) -> Self

Sets the value of sql_statement.

Example

let x = ExecuteSqlPayload::new().set_sql_statement("example");

pub fn set_database<T: Into<String>>(self, v: T) -> Self

Sets the value of database.

Example

let x = ExecuteSqlPayload::new().set_database("example");

pub fn set_row_limit<T: Into<i64>>(self, v: T) -> Self

Sets the value of row_limit.

Example

let x = ExecuteSqlPayload::new().set_row_limit(42);

pub fn set_partial_result_mode<T: Into<PartialResultMode>>(self, v: T) -> Self

Sets the value of partial_result_mode.

Example

use google_cloud_sql_v1::model::execute_sql_payload::PartialResultMode;
let x0 = ExecuteSqlPayload::new().set_partial_result_mode(PartialResultMode::FailPartialResult);
let x1 = ExecuteSqlPayload::new().set_partial_result_mode(PartialResultMode::AllowPartialResult);

pub fn set_application<T: Into<String>>(self, v: T) -> Self

Sets the value of application.

Example

let x = ExecuteSqlPayload::new().set_application("example");

pub fn set_user_password<T: Into<Option<UserPassword>>>(self, v: T) -> Self

Sets the value of user_password.

Note that all the setters affecting user_password are mutually exclusive.

Example

use google_cloud_sql_v1::model::execute_sql_payload::UserPassword;
let x = ExecuteSqlPayload::new().set_user_password(Some(UserPassword::AutoIamAuthn(true)));

pub fn auto_iam_authn(&self) -> Option<&bool>

The value of user_password if it holds a AutoIamAuthn, None if the field is not set or holds a different branch.

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

Sets the value of user_password to hold a AutoIamAuthn.

Note that all the setters affecting user_password are mutually exclusive.

Example

let x = ExecuteSqlPayload::new().set_auto_iam_authn(true);
assert!(x.auto_iam_authn().is_some());

Trait Implementations

impl Clone for ExecuteSqlPayload

fn clone(&self) -> ExecuteSqlPayload

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExecuteSqlPayload

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

Formats the value using the given formatter.

impl Default for ExecuteSqlPayload

fn default() -> ExecuteSqlPayload

Returns the “default value” for a type.

impl Message for ExecuteSqlPayload

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ExecuteSqlPayload

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ExecuteSqlPayload