Struct gapi_grpc::google::cloud::bigquery::datatransfer::v1::DataSourceParameter

pub struct DataSourceParameter {
    pub param_id: String,
    pub display_name: String,
    pub description: String,
    pub type: i32,
    pub required: bool,
    pub repeated: bool,
    pub validation_regex: String,
    pub allowed_values: Vec<String>,
    pub min_value: Option<f64>,
    pub max_value: Option<f64>,
    pub fields: Vec<DataSourceParameter>,
    pub validation_description: String,
    pub validation_help_url: String,
    pub immutable: bool,
    pub recurse: bool,
    pub deprecated: bool,
}

Represents a data source parameter with validation rules, so that parameters can be rendered in the UI. These parameters are given to us by supported data sources, and include all needed information for rendering and validation. Thus, whoever uses this api can decide to generate either generic ui, or custom data source specific forms.

Fields

param_id: String

Parameter identifier.

display_name: String

Parameter display name in the user interface.

description: String

Parameter description.

type: i32

Parameter type.

required: bool

Is parameter required.

repeated: bool

Deprecated. This field has no effect.

validation_regex: String

Regular expression which can be used for parameter validation.

allowed_values: Vec<String>

All possible values for the parameter.

min_value: Option<f64>

For integer and double values specifies minimum allowed value.

max_value: Option<f64>

For integer and double values specifies maxminum allowed value.

fields: Vec<DataSourceParameter>

Deprecated. This field has no effect.

validation_description: String

Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.

validation_help_url: String

URL to a help document to further explain the naming requirements.

immutable: bool

Cannot be changed after initial creation.

recurse: bool

Deprecated. This field has no effect.

deprecated: bool

If true, it should not be used in new transfers, and it should not be visible to users.

Implementations

impl DataSourceParameter

pub fn type(&self) -> Type

Returns the enum value of type, or the default if the field is set to an invalid enum value.

pub fn set_type(&mut self, value: Type)

Sets type to the provided enum value.

Trait Implementations

impl Clone for DataSourceParameter

fn clone(&self) -> DataSourceParameter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DataSourceParameter

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

Formats the value using the given formatter.

impl Default for DataSourceParameter

fn default() -> DataSourceParameter

Returns the “default value” for a type.

impl Message for DataSourceParameter

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

pub fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes a length-delimited instance of the message from the buffer.

pub fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

pub fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<DataSourceParameter> for DataSourceParameter

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for DataSourceParameter