Struct Examples 

#[non_exhaustive]
pub struct Examples {
    pub neighbor_count: i32,
    pub source: Option<Source>,
    pub config: Option<Config>,
    /* private fields */
}

Available on crate features dataset-service or deployment-resource-pool-service or endpoint-service or job-service or model-service or pipeline-service or prediction-service only.

Example-based explainability that returns the nearest neighbors from the provided dataset.

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.

neighbor_count: i32

The number of neighbors to return when querying for examples.

source: Option<Source>

config: Option<Config>

Implementations

impl Examples

pub fn new() -> Self

Creates a new default instance.

pub fn set_neighbor_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of neighbor_count.

Example

let x = Examples::new().set_neighbor_count(42);

pub fn set_source<T: Into<Option<Source>>>(self, v: T) -> Self

Sets the value of source.

Note that all the setters affecting source are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::examples::ExampleGcsSource;
let x = Examples::new().set_source(Some(
    google_cloud_aiplatform_v1::model::examples::Source::ExampleGcsSource(ExampleGcsSource::default().into())));

pub fn example_gcs_source(&self) -> Option<&Box<ExampleGcsSource>>

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

pub fn set_example_gcs_source<T: Into<Box<ExampleGcsSource>>>( self, v: T, ) -> Self

Sets the value of source to hold a ExampleGcsSource.

Note that all the setters affecting source are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::examples::ExampleGcsSource;
let x = Examples::new().set_example_gcs_source(ExampleGcsSource::default()/* use setters */);
assert!(x.example_gcs_source().is_some());

pub fn set_config<T: Into<Option<Config>>>(self, v: T) -> Self

Sets the value of config.

Note that all the setters affecting config are mutually exclusive.

Example

use wkt::Value;
let x = Examples::new().set_config(Some(
    google_cloud_aiplatform_v1::model::examples::Config::NearestNeighborSearchConfig(Value::default().into())));

pub fn nearest_neighbor_search_config(&self) -> Option<&Box<Value>>

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

pub fn set_nearest_neighbor_search_config<T: Into<Box<Value>>>( self, v: T, ) -> Self

Sets the value of config to hold a NearestNeighborSearchConfig.

Note that all the setters affecting config are mutually exclusive.

Example

use wkt::Value;
let x = Examples::new().set_nearest_neighbor_search_config(Value::default()/* use setters */);
assert!(x.nearest_neighbor_search_config().is_some());
assert!(x.presets().is_none());

pub fn presets(&self) -> Option<&Box<Presets>>

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

pub fn set_presets<T: Into<Box<Presets>>>(self, v: T) -> Self

Sets the value of config to hold a Presets.

Note that all the setters affecting config are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::Presets;
let x = Examples::new().set_presets(Presets::default()/* use setters */);
assert!(x.presets().is_some());
assert!(x.nearest_neighbor_search_config().is_none());

Trait Implementations

impl Clone for Examples

fn clone(&self) -> Examples

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Examples

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

Formats the value using the given formatter.

impl Default for Examples

fn default() -> Examples

Returns the “default value” for a type.

impl Message for Examples

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Examples

fn eq(&self, other: &Examples) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Examples