Struct GroundingChunk 

#[non_exhaustive]
pub struct GroundingChunk {
    pub chunk_type: Option<ChunkType>,
    /* private fields */
}

Available on crate feature prediction-service only.

Grounding chunk.

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.

chunk_type: Option<ChunkType>

Chunk type.

Implementations

impl GroundingChunk

pub fn new() -> Self

pub fn set_chunk_type<T: Into<Option<ChunkType>>>(self, v: T) -> Self

Sets the value of chunk_type.

Note that all the setters affecting chunk_type are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::grounding_chunk::Web;
let x = GroundingChunk::new().set_chunk_type(Some(
    google_cloud_aiplatform_v1::model::grounding_chunk::ChunkType::Web(Web::default().into())));

pub fn web(&self) -> Option<&Box<Web>>

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

pub fn set_web<T: Into<Box<Web>>>(self, v: T) -> Self

Sets the value of chunk_type to hold a Web.

Note that all the setters affecting chunk_type are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::grounding_chunk::Web;
let x = GroundingChunk::new().set_web(Web::default()/* use setters */);
assert!(x.web().is_some());
assert!(x.retrieved_context().is_none());
assert!(x.maps().is_none());

pub fn retrieved_context(&self) -> Option<&Box<RetrievedContext>>

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

pub fn set_retrieved_context<T: Into<Box<RetrievedContext>>>(self, v: T) -> Self

Sets the value of chunk_type to hold a RetrievedContext.

Note that all the setters affecting chunk_type are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::grounding_chunk::RetrievedContext;
let x = GroundingChunk::new().set_retrieved_context(RetrievedContext::default()/* use setters */);
assert!(x.retrieved_context().is_some());
assert!(x.web().is_none());
assert!(x.maps().is_none());

pub fn maps(&self) -> Option<&Box<Maps>>

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

pub fn set_maps<T: Into<Box<Maps>>>(self, v: T) -> Self

Sets the value of chunk_type to hold a Maps.

Note that all the setters affecting chunk_type are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::grounding_chunk::Maps;
let x = GroundingChunk::new().set_maps(Maps::default()/* use setters */);
assert!(x.maps().is_some());
assert!(x.web().is_none());
assert!(x.retrieved_context().is_none());

Trait Implementations

impl Clone for GroundingChunk

fn clone(&self) -> GroundingChunk

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GroundingChunk

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

Formats the value using the given formatter.

impl Default for GroundingChunk

fn default() -> GroundingChunk

Returns the “default value” for a type.

impl Message for GroundingChunk

fn typename() -> &'static str

The typename of this message.

impl PartialEq for GroundingChunk

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