Struct gcp_client::google::cloud::vision::v1p3beta1::ProductSearchParams

pub struct ProductSearchParams {
    pub catalog_name: String,
    pub category: i32,
    pub product_category: String,
    pub normalized_bounding_poly: Option<NormalizedBoundingPoly>,
    pub bounding_poly: Option<BoundingPoly>,
    pub view: i32,
    pub product_set: String,
    pub product_categories: Vec<String>,
    pub filter: String,
}

Parameters for a product search request.

Fields

catalog_name: String

The resource name of the catalog to search.

Format is: productSearch/catalogs/CATALOG_NAME.

category: i32

The category to search in. Optional. It is inferred by the system if it is not specified. [Deprecated] Use product_category.

product_category: String

The product category to search in. Optional. It is inferred by the system if it is not specified. Supported values are bag, shoe, sunglasses, dress, outerwear, skirt, top, shorts, and pants.

normalized_bounding_poly: Option<NormalizedBoundingPoly>

The bounding polygon around the area of interest in the image. Optional. If it is not specified, system discretion will be applied. [Deprecated] Use bounding_poly.

bounding_poly: Option<BoundingPoly>

The bounding polygon around the area of interest in the image. Optional. If it is not specified, system discretion will be applied.

view: i32

Specifies the verbosity of the product search results. Optional. Defaults to BASIC.

product_set: String

The resource name of a [ProductSet][google.cloud.vision.v1p3beta1.ProductSet] to be searched for similar images.

Format is: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID.

product_categories: Vec<String>

The list of product categories to search in. Currently, we only consider the first category, and either "homegoods" or "apparel" should be specified.

filter: String

The filtering expression. This can be used to restrict search results based on Product labels. We currently support an AND of OR of key-value expressions, where each expression within an OR must have the same key.

For example, "(color = red OR color = blue) AND brand = Google" is acceptable, but not "(color = red OR brand = Google)" or "color: red".

Implementations

impl ProductSearchParams

pub fn category(&self) -> ProductSearchCategory

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

pub fn set_category(&mut self, value: ProductSearchCategory)

Sets category to the provided enum value.

pub fn view(&self) -> ProductSearchResultsView

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

pub fn set_view(&mut self, value: ProductSearchResultsView)

Sets view to the provided enum value.

Trait Implementations

impl Clone for ProductSearchParams

fn clone(&self) -> ProductSearchParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProductSearchParams

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

Formats the value using the given formatter.

impl Default for ProductSearchParams

fn default() -> ProductSearchParams

Returns the "default value" for a type.

impl Message for ProductSearchParams

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<ProductSearchParams> for ProductSearchParams

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for ProductSearchParams