com.google.cloud.retail.v2alpha.CustomAttributeOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-retail-v2alpha Show documentation
Show all versions of proto-google-cloud-retail-v2alpha Show documentation
Proto library for google-cloud-retail
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/retail/v2alpha/common.proto
// Protobuf Java Version: 3.25.5
package com.google.cloud.retail.v2alpha;
public interface CustomAttributeOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.retail.v2alpha.CustomAttribute)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* The textual values of this custom attribute. For example, `["yellow",
* "green"]` when the key is "color".
*
* Empty string is not allowed. Otherwise, an INVALID_ARGUMENT error is
* returned.
*
* Exactly one of [text][google.cloud.retail.v2alpha.CustomAttribute.text] or
* [numbers][google.cloud.retail.v2alpha.CustomAttribute.numbers] should be
* set. Otherwise, an INVALID_ARGUMENT error is returned.
*
*
* repeated string text = 1;
*
* @return A list containing the text.
*/
java.util.List getTextList();
/**
*
*
*
* The textual values of this custom attribute. For example, `["yellow",
* "green"]` when the key is "color".
*
* Empty string is not allowed. Otherwise, an INVALID_ARGUMENT error is
* returned.
*
* Exactly one of [text][google.cloud.retail.v2alpha.CustomAttribute.text] or
* [numbers][google.cloud.retail.v2alpha.CustomAttribute.numbers] should be
* set. Otherwise, an INVALID_ARGUMENT error is returned.
*
*
* repeated string text = 1;
*
* @return The count of text.
*/
int getTextCount();
/**
*
*
*
* The textual values of this custom attribute. For example, `["yellow",
* "green"]` when the key is "color".
*
* Empty string is not allowed. Otherwise, an INVALID_ARGUMENT error is
* returned.
*
* Exactly one of [text][google.cloud.retail.v2alpha.CustomAttribute.text] or
* [numbers][google.cloud.retail.v2alpha.CustomAttribute.numbers] should be
* set. Otherwise, an INVALID_ARGUMENT error is returned.
*
*
* repeated string text = 1;
*
* @param index The index of the element to return.
* @return The text at the given index.
*/
java.lang.String getText(int index);
/**
*
*
*
* The textual values of this custom attribute. For example, `["yellow",
* "green"]` when the key is "color".
*
* Empty string is not allowed. Otherwise, an INVALID_ARGUMENT error is
* returned.
*
* Exactly one of [text][google.cloud.retail.v2alpha.CustomAttribute.text] or
* [numbers][google.cloud.retail.v2alpha.CustomAttribute.numbers] should be
* set. Otherwise, an INVALID_ARGUMENT error is returned.
*
*
* repeated string text = 1;
*
* @param index The index of the value to return.
* @return The bytes of the text at the given index.
*/
com.google.protobuf.ByteString getTextBytes(int index);
/**
*
*
*
* The numerical values of this custom attribute. For example, `[2.3, 15.4]`
* when the key is "lengths_cm".
*
* Exactly one of [text][google.cloud.retail.v2alpha.CustomAttribute.text] or
* [numbers][google.cloud.retail.v2alpha.CustomAttribute.numbers] should be
* set. Otherwise, an INVALID_ARGUMENT error is returned.
*
*
* repeated double numbers = 2;
*
* @return A list containing the numbers.
*/
java.util.List getNumbersList();
/**
*
*
*
* The numerical values of this custom attribute. For example, `[2.3, 15.4]`
* when the key is "lengths_cm".
*
* Exactly one of [text][google.cloud.retail.v2alpha.CustomAttribute.text] or
* [numbers][google.cloud.retail.v2alpha.CustomAttribute.numbers] should be
* set. Otherwise, an INVALID_ARGUMENT error is returned.
*
*
* repeated double numbers = 2;
*
* @return The count of numbers.
*/
int getNumbersCount();
/**
*
*
*
* The numerical values of this custom attribute. For example, `[2.3, 15.4]`
* when the key is "lengths_cm".
*
* Exactly one of [text][google.cloud.retail.v2alpha.CustomAttribute.text] or
* [numbers][google.cloud.retail.v2alpha.CustomAttribute.numbers] should be
* set. Otherwise, an INVALID_ARGUMENT error is returned.
*
*
* repeated double numbers = 2;
*
* @param index The index of the element to return.
* @return The numbers at the given index.
*/
double getNumbers(int index);
/**
*
*
*
* This field is normally ignored unless
* [AttributesConfig.attribute_config_level][google.cloud.retail.v2alpha.AttributesConfig.attribute_config_level]
* of the [Catalog][google.cloud.retail.v2alpha.Catalog] is set to the
* deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about
* product-level attribute configuration, see [Configuration
* modes](https://cloud.google.com/retail/docs/attribute-config#config-modes).
* If true, custom attribute values are searchable by text queries in
* [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search].
*
* This field is ignored in a
* [UserEvent][google.cloud.retail.v2alpha.UserEvent].
*
* Only set if type [text][google.cloud.retail.v2alpha.CustomAttribute.text]
* is set. Otherwise, a INVALID_ARGUMENT error is returned.
*
*
* optional bool searchable = 3 [deprecated = true];
*
* @deprecated google.cloud.retail.v2alpha.CustomAttribute.searchable is deprecated. See
* google/cloud/retail/v2alpha/common.proto;l=511
* @return Whether the searchable field is set.
*/
@java.lang.Deprecated
boolean hasSearchable();
/**
*
*
*
* This field is normally ignored unless
* [AttributesConfig.attribute_config_level][google.cloud.retail.v2alpha.AttributesConfig.attribute_config_level]
* of the [Catalog][google.cloud.retail.v2alpha.Catalog] is set to the
* deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about
* product-level attribute configuration, see [Configuration
* modes](https://cloud.google.com/retail/docs/attribute-config#config-modes).
* If true, custom attribute values are searchable by text queries in
* [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search].
*
* This field is ignored in a
* [UserEvent][google.cloud.retail.v2alpha.UserEvent].
*
* Only set if type [text][google.cloud.retail.v2alpha.CustomAttribute.text]
* is set. Otherwise, a INVALID_ARGUMENT error is returned.
*
*
* optional bool searchable = 3 [deprecated = true];
*
* @deprecated google.cloud.retail.v2alpha.CustomAttribute.searchable is deprecated. See
* google/cloud/retail/v2alpha/common.proto;l=511
* @return The searchable.
*/
@java.lang.Deprecated
boolean getSearchable();
/**
*
*
*
* This field is normally ignored unless
* [AttributesConfig.attribute_config_level][google.cloud.retail.v2alpha.AttributesConfig.attribute_config_level]
* of the [Catalog][google.cloud.retail.v2alpha.Catalog] is set to the
* deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about
* product-level attribute configuration, see [Configuration
* modes](https://cloud.google.com/retail/docs/attribute-config#config-modes).
* If true, custom attribute values are indexed, so that they can be filtered,
* faceted or boosted in
* [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search].
*
* This field is ignored in a
* [UserEvent][google.cloud.retail.v2alpha.UserEvent].
*
* See
* [SearchRequest.filter][google.cloud.retail.v2alpha.SearchRequest.filter],
* [SearchRequest.facet_specs][google.cloud.retail.v2alpha.SearchRequest.facet_specs]
* and
* [SearchRequest.boost_spec][google.cloud.retail.v2alpha.SearchRequest.boost_spec]
* for more details.
*
*
* optional bool indexable = 4 [deprecated = true];
*
* @deprecated google.cloud.retail.v2alpha.CustomAttribute.indexable is deprecated. See
* google/cloud/retail/v2alpha/common.proto;l=532
* @return Whether the indexable field is set.
*/
@java.lang.Deprecated
boolean hasIndexable();
/**
*
*
*
* This field is normally ignored unless
* [AttributesConfig.attribute_config_level][google.cloud.retail.v2alpha.AttributesConfig.attribute_config_level]
* of the [Catalog][google.cloud.retail.v2alpha.Catalog] is set to the
* deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about
* product-level attribute configuration, see [Configuration
* modes](https://cloud.google.com/retail/docs/attribute-config#config-modes).
* If true, custom attribute values are indexed, so that they can be filtered,
* faceted or boosted in
* [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search].
*
* This field is ignored in a
* [UserEvent][google.cloud.retail.v2alpha.UserEvent].
*
* See
* [SearchRequest.filter][google.cloud.retail.v2alpha.SearchRequest.filter],
* [SearchRequest.facet_specs][google.cloud.retail.v2alpha.SearchRequest.facet_specs]
* and
* [SearchRequest.boost_spec][google.cloud.retail.v2alpha.SearchRequest.boost_spec]
* for more details.
*
*
* optional bool indexable = 4 [deprecated = true];
*
* @deprecated google.cloud.retail.v2alpha.CustomAttribute.indexable is deprecated. See
* google/cloud/retail/v2alpha/common.proto;l=532
* @return The indexable.
*/
@java.lang.Deprecated
boolean getIndexable();
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy