Struct google_api_proto::google::cloud::discoveryengine::v1alpha::search_request::content_search_spec::SnippetSpec

pub struct SnippetSpec {
    pub max_snippet_count: i32,
    pub reference_only: bool,
    pub return_snippet: bool,
}

A specification for configuring snippets in a search response.

Fields

max_snippet_count: i32

👎Deprecated

[DEPRECATED] This field is deprecated. To control snippet return, use return_snippet field. For backwards compatibility, we will return snippet if max_snippet_count > 0.

reference_only: bool

👎Deprecated

[DEPRECATED] This field is deprecated and will have no affect on the snippet.

return_snippet: bool

If true, then return snippet. If no snippet can be generated, we return “No snippet is available for this page.” A snippet_status with SUCCESS or NO_SNIPPET_AVAILABLE will also be returned.

Trait Implementations

impl Clone for SnippetSpec

fn clone(&self) -> SnippetSpec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SnippetSpec

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

Formats the value using the given formatter.

impl Default for SnippetSpec

fn default() -> Self

Returns the “default value” for a type.

impl Message for SnippetSpec

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 SnippetSpec

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

impl StructuralPartialEq for SnippetSpec