Struct google_api_proto::google::cloud::aiplatform::v1::Schema

pub struct Schema {

    pub type: i32,
    pub format: String,
    pub title: String,
    pub description: String,
    pub nullable: bool,
    pub default: Option<Value>,
    pub items: Option<Box<Schema>>,
    pub min_items: i64,
    pub max_items: i64,
    pub enum: Vec<String>,
    pub properties: BTreeMap<String, Schema>,
    pub required: Vec<String>,
    pub min_properties: i64,
    pub max_properties: i64,
    pub minimum: f64,
    pub maximum: f64,
    pub min_length: i64,
    pub max_length: i64,
    pub pattern: String,
    pub example: Option<Value>,
}

Schema is used to define the format of input/output data. Represents a select subset of an OpenAPI 3.0 schema object. More fields may be added in the future as needed.

Fields

type: i32

Optional. The type of the data.

format: String

Optional. The format of the data. Supported formats: for NUMBER type: “float”, “double” for INTEGER type: “int32”, “int64” for STRING type: “email”, “byte”, etc

title: String

Optional. The title of the Schema.

description: String

Optional. The description of the data.

nullable: bool

Optional. Indicates if the value may be null.

default: Option<Value>

Optional. Default value of the data.

items: Option<Box<Schema>>

Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.

min_items: i64

Optional. Minimum number of the elements for Type.ARRAY.

max_items: i64

Optional. Maximum number of the elements for Type.ARRAY.

enum: Vec<String>

Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:[“EAST”, NORTH“, “SOUTH”, “WEST”]}

properties: BTreeMap<String, Schema>

Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.

required: Vec<String>

Optional. Required properties of Type.OBJECT.

min_properties: i64

Optional. Minimum number of the properties for Type.OBJECT.

max_properties: i64

Optional. Maximum number of the properties for Type.OBJECT.

minimum: f64

Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER

maximum: f64

Optional. Maximum value of the Type.INTEGER and Type.NUMBER

min_length: i64

Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING

max_length: i64

Optional. Maximum length of the Type.STRING

pattern: String

Optional. Pattern of the Type.STRING to restrict a string to a regular expression.

example: Option<Value>

Optional. Example of the object. Will only populated when the object is the root.

Implementations

impl Schema

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 Schema

fn clone(&self) -> Schema

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Schema

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

Formats the value using the given formatter.

impl Default for Schema

fn default() -> Self

Returns the “default value” for a type.

impl Message for Schema

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 Schema

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