Struct Schema 

#[non_exhaustive]
pub struct Schema {
    pub name: String,
    pub schema: Option<Schema>,
    /* private fields */
}

Available on crate features data-store-service or schema-service only.

Defines the structure and layout of a type of document data.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

Immutable. The full resource name of the schema, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

schema: Option<Schema>

Schema representation. One of struct_schema or json_schema should be provided otherwise an INVALID_ARGUMENT error is thrown.

Implementations

impl Schema

pub fn new() -> Self

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

Example

let x = Schema::new().set_name("example");

pub fn set_schema<T: Into<Option<Schema>>>(self, v: T) -> Self

Sets the value of schema.

Note that all the setters affecting schema are mutually exclusive.

Example

use google_cloud_discoveryengine_v1::model::schema::Schema as SchemaOneOf;
let x = Schema::new().set_schema(Some(SchemaOneOf::JsonSchema("example".to_string())));

pub fn struct_schema(&self) -> Option<&Box<Struct>>

The value of schema if it holds a StructSchema, None if the field is not set or holds a different branch.

pub fn set_struct_schema<T: Into<Box<Struct>>>(self, v: T) -> Self

Sets the value of schema to hold a StructSchema.

Note that all the setters affecting schema are mutually exclusive.

Example

use wkt::Struct;
let x = Schema::new().set_struct_schema(Struct::default()/* use setters */);
assert!(x.struct_schema().is_some());
assert!(x.json_schema().is_none());

pub fn json_schema(&self) -> Option<&String>

The value of schema if it holds a JsonSchema, None if the field is not set or holds a different branch.

pub fn set_json_schema<T: Into<String>>(self, v: T) -> Self

Sets the value of schema to hold a JsonSchema.

Note that all the setters affecting schema are mutually exclusive.

Example

let x = Schema::new().set_json_schema("example");
assert!(x.json_schema().is_some());
assert!(x.struct_schema().is_none());

Trait Implementations

impl Clone for Schema

fn clone(&self) -> Schema

Returns a duplicate 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() -> Schema

Returns the “default value” for a type.

impl Message for Schema

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Schema

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