Struct Attribute

pub struct Attribute {
    pub name: String,
    pub display_name: String,
    pub description: String,
    pub definition_type: i32,
    pub scope: i32,
    pub data_type: i32,
    pub allowed_values: Vec<AllowedValue>,
    pub cardinality: i32,
    pub mandatory: bool,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
}

An attribute in the API Hub. An attribute is a name value pair which can be attached to different resources in the API hub based on the scope of the attribute. Attributes can either be pre-defined by the API Hub or created by users.

Fields

name: String

Identifier. The name of the attribute in the API Hub.

Format: projects/{project}/locations/{location}/attributes/{attribute}

display_name: String

Required. The display name of the attribute.

description: String

Optional. The description of the attribute.

definition_type: i32

Output only. The definition type of the attribute.

scope: i32

Required. The scope of the attribute. It represents the resource in the API Hub to which the attribute can be linked.

data_type: i32

Required. The type of the data of the attribute.

allowed_values: Vec<AllowedValue>

Optional. The list of allowed values when the attribute value is of type enum. This is required when the data_type of the attribute is ENUM. The maximum number of allowed values of an attribute will be 1000.

cardinality: i32

Optional. The maximum number of values that the attribute can have when associated with an API Hub resource. Cardinality 1 would represent a single-valued attribute. It must not be less than 1 or greater than 20. If not specified, the cardinality would be set to 1 by default and represent a single-valued attribute.

mandatory: bool

Output only. When mandatory is true, the attribute is mandatory for the resource specified in the scope. Only System defined attributes can be mandatory.

create_time: Option<Timestamp>

Output only. The time at which the attribute was created.

update_time: Option<Timestamp>

Output only. The time at which the attribute was last updated.

Implementations

impl Attribute

pub fn definition_type(&self) -> DefinitionType

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

pub fn set_definition_type(&mut self, value: DefinitionType)

Sets definition_type to the provided enum value.

pub fn scope(&self) -> Scope

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

pub fn set_scope(&mut self, value: Scope)

Sets scope to the provided enum value.

pub fn data_type(&self) -> DataType

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

pub fn set_data_type(&mut self, value: DataType)

Sets data_type to the provided enum value.

Trait Implementations

impl Clone for Attribute

fn clone(&self) -> Attribute

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Attribute

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

Formats the value using the given formatter.

impl Default for Attribute

fn default() -> Self

Returns the “default value” for a type.

impl Message for Attribute

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 Attribute

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