Struct google_api_proto::google::cloud::visionai::v1alpha1::FacetGroup

pub struct FacetGroup {
    pub facet_id: String,
    pub display_name: String,
    pub buckets: Vec<FacetBucket>,
    pub bucket_type: i32,
    pub fetch_matched_annotations: bool,
}

A group of facet buckets to be passed back and forth between backend & frontend.

Fields

facet_id: String

Unique id of the facet group.

display_name: String

Display name of the facet. To be used by UI for facet rendering.

buckets: Vec<FacetBucket>

Buckets associated with the facet. E.g. for “Team” facet, the bucket can be 49ers, patriots, etc.

bucket_type: i32

Facet bucket type.

fetch_matched_annotations: bool

If true, return query matched annotations for this facet group’s selection. This option is only applicable for facets based on partition level annotations. It supports the following facet values:

• INTEGER
• STRING (DataSchema.SearchStrategy.EXACT_SEARCH only)

Implementations

impl FacetGroup

pub fn bucket_type(&self) -> FacetBucketType

Returns the enum value of bucket_type, or the default if the field is set to an invalid enum value.

pub fn set_bucket_type(&mut self, value: FacetBucketType)

Sets bucket_type to the provided enum value.

Trait Implementations

impl Clone for FacetGroup

fn clone(&self) -> FacetGroup

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FacetGroup

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

Formats the value using the given formatter.

impl Default for FacetGroup

fn default() -> Self

Returns the “default value” for a type.

impl Message for FacetGroup

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 FacetGroup

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