Struct google_api_proto::google::cloud::dataplex::v1::aspect_type::MetadataTemplate

pub struct MetadataTemplate {
    pub index: i32,
    pub name: String,
    pub type: String,
    pub record_fields: Vec<MetadataTemplate>,
    pub enum_values: Vec<EnumValue>,
    pub map_items: Option<Box<MetadataTemplate>>,
    pub array_items: Option<Box<MetadataTemplate>>,
    pub type_id: String,
    pub type_ref: String,
    pub constraints: Option<Constraints>,
    pub annotations: Option<Annotations>,
}

MetadataTemplate definition for AspectType

Fields

index: i32

Optional. Index is used to encode Template messages. The value of index can range between 1 and 2,147,483,647. Index must be unique within all fields in a Template. (Nested Templates can reuse indexes). Once a Template is defined, the index cannot be changed, because it identifies the field in the actual storage format. Index is a mandatory field, but it is optional for top level fields, and map/array “values” definitions.

name: String

Required. The name of the field.

type: String

Required. The datatype of this field. The following values are supported: Primitive types (string, integer, boolean, double, datetime); datetime must be of the format RFC3339 UTC “Zulu” (Examples: “2014-10-02T15:01:23Z” and “2014-10-02T15:01:23.045123456Z”). Complex types (enum, array, map, record).

record_fields: Vec<MetadataTemplate>

Optional. Field definition, needs to be specified if the type is record. Defines the nested fields.

enum_values: Vec<EnumValue>

Optional. The list of values for an enum type. Needs to be defined if the type is enum.

map_items: Option<Box<MetadataTemplate>>

Optional. map_items needs to be set if the type is map. map_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, just name and type needs to be set in the nested MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload.

array_items: Option<Box<MetadataTemplate>>

Optional. array_items needs to be set if the type is array. array_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, just name and type needs to be set in the nested MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload.

type_id: String

Optional. Id can be used if this definition of the field needs to be reused later. Id needs to be unique across the entire template. Id can only be specified if the field type is record.

type_ref: String

Optional. A reference to another field definition (instead of an inline definition). The value must be equal to the value of an id field defined elsewhere in the MetadataTemplate. Only fields with type as record can refer to other fields.

constraints: Option<Constraints>

Optional. Specifies the constraints on this field.

annotations: Option<Annotations>

Optional. Specifies annotations on this field.

Trait Implementations

impl Clone for MetadataTemplate

fn clone(&self) -> MetadataTemplate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetadataTemplate

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

Formats the value using the given formatter.

impl Default for MetadataTemplate

fn default() -> Self

Returns the “default value” for a type.

impl Message for MetadataTemplate

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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

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

where B: Buf, Self: Default,

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

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

where B: Buf, Self: Sized,

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

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

where B: Buf, Self: Sized,

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

impl PartialEq for MetadataTemplate

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