Struct Argument 

#[non_exhaustive]
pub struct Argument {
    pub name: String,
    pub argument_kind: ArgumentKind,
    pub mode: Mode,
    pub data_type: Option<StandardSqlDataType>,
    pub table_type: Option<StandardSqlTableType>,
    pub is_aggregate: Option<BoolValue>,
    /* private fields */
}

Input/output argument of a function or a stored procedure.

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.

name: String

Optional. The name of this argument. Can be absent for function return argument.

argument_kind: ArgumentKind

Optional. Defaults to FIXED_TYPE.

mode: Mode

Optional. Specifies whether the argument is input or output. Can be set for procedures only.

data_type: Option<StandardSqlDataType>

Set if argument_kind == FIXED_TYPE.

table_type: Option<StandardSqlTableType>

Optional. Set if argument_kind == FIXED_TABLE.

is_aggregate: Option<BoolValue>

Optional. Whether the argument is an aggregate function parameter. Must be Unset for routine types other than AGGREGATE_FUNCTION. For AGGREGATE_FUNCTION, if set to false, it is equivalent to adding “NOT AGGREGATE” clause in DDL; Otherwise, it is equivalent to omitting “NOT AGGREGATE” clause in DDL.

Implementations

impl Argument

pub fn new() -> Self

Creates a new default instance.

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

Sets the value of name.

Example

let x = Argument::new().set_name("example");

pub fn set_argument_kind<T: Into<ArgumentKind>>(self, v: T) -> Self

Sets the value of argument_kind.

Example

use google_cloud_bigquery_v2::model::routine::argument::ArgumentKind;
let x0 = Argument::new().set_argument_kind(ArgumentKind::FixedType);
let x1 = Argument::new().set_argument_kind(ArgumentKind::AnyType);
let x2 = Argument::new().set_argument_kind(ArgumentKind::FixedTable);

pub fn set_mode<T: Into<Mode>>(self, v: T) -> Self

Sets the value of mode.

Example

use google_cloud_bigquery_v2::model::routine::argument::Mode;
let x0 = Argument::new().set_mode(Mode::In);
let x1 = Argument::new().set_mode(Mode::Out);
let x2 = Argument::new().set_mode(Mode::Inout);

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

where T: Into<StandardSqlDataType>,

Sets the value of data_type.

Example

use google_cloud_bigquery_v2::model::StandardSqlDataType;
let x = Argument::new().set_data_type(StandardSqlDataType::default()/* use setters */);

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

where T: Into<StandardSqlDataType>,

Sets or clears the value of data_type.

Example

use google_cloud_bigquery_v2::model::StandardSqlDataType;
let x = Argument::new().set_or_clear_data_type(Some(StandardSqlDataType::default()/* use setters */));
let x = Argument::new().set_or_clear_data_type(None::<StandardSqlDataType>);

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

where T: Into<StandardSqlTableType>,

Sets the value of table_type.

Example

use google_cloud_bigquery_v2::model::StandardSqlTableType;
let x = Argument::new().set_table_type(StandardSqlTableType::default()/* use setters */);

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

where T: Into<StandardSqlTableType>,

Sets or clears the value of table_type.

Example

use google_cloud_bigquery_v2::model::StandardSqlTableType;
let x = Argument::new().set_or_clear_table_type(Some(StandardSqlTableType::default()/* use setters */));
let x = Argument::new().set_or_clear_table_type(None::<StandardSqlTableType>);

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

where T: Into<BoolValue>,

Sets the value of is_aggregate.

Example

use wkt::BoolValue;
let x = Argument::new().set_is_aggregate(BoolValue::default()/* use setters */);

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

where T: Into<BoolValue>,

Sets or clears the value of is_aggregate.

Example

use wkt::BoolValue;
let x = Argument::new().set_or_clear_is_aggregate(Some(BoolValue::default()/* use setters */));
let x = Argument::new().set_or_clear_is_aggregate(None::<BoolValue>);

Trait Implementations

impl Clone for Argument

fn clone(&self) -> Argument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Argument

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

Formats the value using the given formatter.

impl Default for Argument

fn default() -> Argument

Returns the “default value” for a type.

impl Message for Argument

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Argument

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Argument