Struct ConfigVariableTemplate 

#[non_exhaustive]
pub struct ConfigVariableTemplate {
    pub key: String,
    pub value_type: ValueType,
    pub display_name: String,
    pub description: String,
    pub validation_regex: String,
    pub required: bool,
    pub role_grant: Option<RoleGrant>,
    pub enum_options: Vec<EnumOption>,
    pub authorization_code_link: Option<AuthorizationCodeLink>,
    pub state: State,
    pub is_advanced: bool,
    /* private fields */
}

ConfigVariableTemplate provides metadata about a ConfigVariable that is used in a Connection.

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.

key: String

Key of the config variable.

value_type: ValueType

Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation.

display_name: String

Display name of the parameter.

description: String

Description.

validation_regex: String

Regular expression in RE2 syntax used for validating the value of a ConfigVariable.

required: bool

Flag represents that this ConfigVariable must be provided for a connection.

role_grant: Option<RoleGrant>

Role grant configuration for the config variable.

enum_options: Vec<EnumOption>

Enum options. To be populated if ValueType is ENUM

authorization_code_link: Option<AuthorizationCodeLink>

Authorization code link options. To be populated if ValueType is AUTHORIZATION_CODE

state: State

State of the config variable.

is_advanced: bool

Indicates if current template is part of advanced settings

Implementations

impl ConfigVariableTemplate

pub fn new() -> Self

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

Sets the value of key.

Example

let x = ConfigVariableTemplate::new().set_key("example");

pub fn set_value_type<T: Into<ValueType>>(self, v: T) -> Self

Sets the value of value_type.

Example

use google_cloud_connectors_v1::model::config_variable_template::ValueType;
let x0 = ConfigVariableTemplate::new().set_value_type(ValueType::String);
let x1 = ConfigVariableTemplate::new().set_value_type(ValueType::Int);
let x2 = ConfigVariableTemplate::new().set_value_type(ValueType::Bool);

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

Sets the value of display_name.

Example

let x = ConfigVariableTemplate::new().set_display_name("example");

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

Sets the value of description.

Example

let x = ConfigVariableTemplate::new().set_description("example");

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

Sets the value of validation_regex.

Example

let x = ConfigVariableTemplate::new().set_validation_regex("example");

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

Sets the value of required.

Example

let x = ConfigVariableTemplate::new().set_required(true);

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

where T: Into<RoleGrant>,

Sets the value of role_grant.

Example

use google_cloud_connectors_v1::model::RoleGrant;
let x = ConfigVariableTemplate::new().set_role_grant(RoleGrant::default()/* use setters */);

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

where T: Into<RoleGrant>,

Sets or clears the value of role_grant.

Example

use google_cloud_connectors_v1::model::RoleGrant;
let x = ConfigVariableTemplate::new().set_or_clear_role_grant(Some(RoleGrant::default()/* use setters */));
let x = ConfigVariableTemplate::new().set_or_clear_role_grant(None::<RoleGrant>);

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

where T: IntoIterator<Item = V>, V: Into<EnumOption>,

Sets the value of enum_options.

Example

use google_cloud_connectors_v1::model::EnumOption;
let x = ConfigVariableTemplate::new()
    .set_enum_options([
        EnumOption::default()/* use setters */,
        EnumOption::default()/* use (different) setters */,
    ]);

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

where T: Into<AuthorizationCodeLink>,

Sets the value of authorization_code_link.

Example

use google_cloud_connectors_v1::model::AuthorizationCodeLink;
let x = ConfigVariableTemplate::new().set_authorization_code_link(AuthorizationCodeLink::default()/* use setters */);

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

where T: Into<AuthorizationCodeLink>,

Sets or clears the value of authorization_code_link.

Example

use google_cloud_connectors_v1::model::AuthorizationCodeLink;
let x = ConfigVariableTemplate::new().set_or_clear_authorization_code_link(Some(AuthorizationCodeLink::default()/* use setters */));
let x = ConfigVariableTemplate::new().set_or_clear_authorization_code_link(None::<AuthorizationCodeLink>);

pub fn set_state<T: Into<State>>(self, v: T) -> Self

Sets the value of state.

Example

use google_cloud_connectors_v1::model::config_variable_template::State;
let x0 = ConfigVariableTemplate::new().set_state(State::Active);
let x1 = ConfigVariableTemplate::new().set_state(State::Deprecated);

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

Sets the value of is_advanced.

Example

let x = ConfigVariableTemplate::new().set_is_advanced(true);

Trait Implementations

impl Clone for ConfigVariableTemplate

fn clone(&self) -> ConfigVariableTemplate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigVariableTemplate

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

Formats the value using the given formatter.

impl Default for ConfigVariableTemplate

fn default() -> ConfigVariableTemplate

Returns the “default value” for a type.

impl Message for ConfigVariableTemplate

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ConfigVariableTemplate

fn eq(&self, other: &ConfigVariableTemplate) -> 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 ConfigVariableTemplate