Struct google_api_proto::google::dataflow::v1beta3::ParameterMetadata

pub struct ParameterMetadata {
    pub name: String,
    pub label: String,
    pub help_text: String,
    pub is_optional: bool,
    pub regexes: Vec<String>,
    pub param_type: i32,
    pub custom_metadata: BTreeMap<String, String>,
}

Metadata for a specific parameter.

Fields

name: String

Required. The name of the parameter.

label: String

Required. The label to display for the parameter.

help_text: String

Required. The help text to display for the parameter.

is_optional: bool

Optional. Whether the parameter is optional. Defaults to false.

regexes: Vec<String>

Optional. Regexes that the parameter must match.

param_type: i32

Optional. The type of the parameter. Used for selecting input picker.

custom_metadata: BTreeMap<String, String>

Optional. Additional metadata for describing this parameter.

Implementations

impl ParameterMetadata

pub fn param_type(&self) -> ParameterType

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

pub fn set_param_type(&mut self, value: ParameterType)

Sets param_type to the provided enum value.

Trait Implementations

impl Clone for ParameterMetadata

fn clone(&self) -> ParameterMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ParameterMetadata

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

Formats the value using the given formatter.

impl Default for ParameterMetadata

fn default() -> Self

Returns the “default value” for a type.

impl Message for ParameterMetadata

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.

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

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

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

where Self: Sized,

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

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

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

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

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

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

where Self: Sized,

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

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

where Self: Sized,

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

impl PartialEq for ParameterMetadata

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

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

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

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

impl StructuralPartialEq for ParameterMetadata