Class SearchRequest
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.cloud.discoveryengine.v1.SearchRequest
-
- All Implemented Interfaces:
SearchRequestOrBuilder
,com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Serializable
public final class SearchRequest extends com.google.protobuf.GeneratedMessageV3 implements SearchRequestOrBuilder
Request message for [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] method.
Protobuf typegoogle.cloud.discoveryengine.v1.SearchRequest
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SearchRequest.BoostSpec
Boost specification to boost certain documents.static interface
SearchRequest.BoostSpecOrBuilder
static class
SearchRequest.Builder
Request message for [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] method.static class
SearchRequest.ContentSearchSpec
A specification for configuring the behavior of content search.static interface
SearchRequest.ContentSearchSpecOrBuilder
static class
SearchRequest.FacetSpec
A facet specification to perform faceted search.static interface
SearchRequest.FacetSpecOrBuilder
static class
SearchRequest.ImageQuery
Specifies the image query input.static interface
SearchRequest.ImageQueryOrBuilder
static class
SearchRequest.QueryExpansionSpec
Specification to determine under which conditions query expansion should occur.static interface
SearchRequest.QueryExpansionSpecOrBuilder
static class
SearchRequest.SpellCorrectionSpec
The specification for query spell correction.static interface
SearchRequest.SpellCorrectionSpecOrBuilder
-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static int
BOOST_SPEC_FIELD_NUMBER
static int
BRANCH_FIELD_NUMBER
static int
CONTENT_SEARCH_SPEC_FIELD_NUMBER
static int
FACET_SPECS_FIELD_NUMBER
static int
FILTER_FIELD_NUMBER
static int
IMAGE_QUERY_FIELD_NUMBER
static int
OFFSET_FIELD_NUMBER
static int
ORDER_BY_FIELD_NUMBER
static int
PAGE_SIZE_FIELD_NUMBER
static int
PAGE_TOKEN_FIELD_NUMBER
static int
PARAMS_FIELD_NUMBER
static int
QUERY_EXPANSION_SPEC_FIELD_NUMBER
static int
QUERY_FIELD_NUMBER
static int
SAFE_SEARCH_FIELD_NUMBER
static int
SERVING_CONFIG_FIELD_NUMBER
static int
SPELL_CORRECTION_SPEC_FIELD_NUMBER
static int
USER_INFO_FIELD_NUMBER
static int
USER_LABELS_FIELD_NUMBER
static int
USER_PSEUDO_ID_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
containsParams(String key)
Additional search parameters.boolean
containsUserLabels(String key)
The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64.boolean
equals(Object obj)
SearchRequest.BoostSpec
getBoostSpec()
Boost specification to boost certain documents.SearchRequest.BoostSpecOrBuilder
getBoostSpecOrBuilder()
Boost specification to boost certain documents.String
getBranch()
The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.com.google.protobuf.ByteString
getBranchBytes()
The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.SearchRequest.ContentSearchSpec
getContentSearchSpec()
A specification for configuring the behavior of content search.SearchRequest.ContentSearchSpecOrBuilder
getContentSearchSpecOrBuilder()
A specification for configuring the behavior of content search.static SearchRequest
getDefaultInstance()
SearchRequest
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
SearchRequest.FacetSpec
getFacetSpecs(int index)
Facet specifications for faceted search.int
getFacetSpecsCount()
Facet specifications for faceted search.List<SearchRequest.FacetSpec>
getFacetSpecsList()
Facet specifications for faceted search.SearchRequest.FacetSpecOrBuilder
getFacetSpecsOrBuilder(int index)
Facet specifications for faceted search.List<? extends SearchRequest.FacetSpecOrBuilder>
getFacetSpecsOrBuilderList()
Facet specifications for faceted search.String
getFilter()
The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.com.google.protobuf.ByteString
getFilterBytes()
The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.SearchRequest.ImageQuery
getImageQuery()
Raw image query.SearchRequest.ImageQueryOrBuilder
getImageQueryOrBuilder()
Raw image query.int
getOffset()
A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the [Document][google.cloud.discoveryengine.v1.Document]s deemed by the API as relevant) in search results.String
getOrderBy()
The order in which documents are returned.com.google.protobuf.ByteString
getOrderByBytes()
The order in which documents are returned.int
getPageSize()
Maximum number of [Document][google.cloud.discoveryengine.v1.Document]s to return.String
getPageToken()
A page token received from a previous [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] call.com.google.protobuf.ByteString
getPageTokenBytes()
A page token received from a previous [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] call.Map<String,com.google.protobuf.Value>
getParams()
Deprecated.int
getParamsCount()
Additional search parameters.Map<String,com.google.protobuf.Value>
getParamsMap()
Additional search parameters.com.google.protobuf.Value
getParamsOrDefault(String key, com.google.protobuf.Value defaultValue)
Additional search parameters.com.google.protobuf.Value
getParamsOrThrow(String key)
Additional search parameters.com.google.protobuf.Parser<SearchRequest>
getParserForType()
String
getQuery()
Raw search query.com.google.protobuf.ByteString
getQueryBytes()
Raw search query.SearchRequest.QueryExpansionSpec
getQueryExpansionSpec()
The query expansion specification that specifies the conditions under which query expansion occurs.SearchRequest.QueryExpansionSpecOrBuilder
getQueryExpansionSpecOrBuilder()
The query expansion specification that specifies the conditions under which query expansion occurs.boolean
getSafeSearch()
Whether to turn on safe search.int
getSerializedSize()
String
getServingConfig()
Required.com.google.protobuf.ByteString
getServingConfigBytes()
Required.SearchRequest.SpellCorrectionSpec
getSpellCorrectionSpec()
The spell correction specification that specifies the mode under which spell correction takes effect.SearchRequest.SpellCorrectionSpecOrBuilder
getSpellCorrectionSpecOrBuilder()
The spell correction specification that specifies the mode under which spell correction takes effect.UserInfo
getUserInfo()
Information about the end user.UserInfoOrBuilder
getUserInfoOrBuilder()
Information about the end user.Map<String,String>
getUserLabels()
Deprecated.int
getUserLabelsCount()
The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64.Map<String,String>
getUserLabelsMap()
The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64.String
getUserLabelsOrDefault(String key, String defaultValue)
The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64.String
getUserLabelsOrThrow(String key)
The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64.String
getUserPseudoId()
A unique identifier for tracking visitors.com.google.protobuf.ByteString
getUserPseudoIdBytes()
A unique identifier for tracking visitors.boolean
hasBoostSpec()
Boost specification to boost certain documents.boolean
hasContentSearchSpec()
A specification for configuring the behavior of content search.int
hashCode()
boolean
hasImageQuery()
Raw image query.boolean
hasQueryExpansionSpec()
The query expansion specification that specifies the conditions under which query expansion occurs.boolean
hasSpellCorrectionSpec()
The spell correction specification that specifies the mode under which spell correction takes effect.boolean
hasUserInfo()
Information about the end user.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
protected com.google.protobuf.MapField
internalGetMapField(int number)
boolean
isInitialized()
static SearchRequest.Builder
newBuilder()
static SearchRequest.Builder
newBuilder(SearchRequest prototype)
SearchRequest.Builder
newBuilderForType()
protected SearchRequest.Builder
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static SearchRequest
parseDelimitedFrom(InputStream input)
static SearchRequest
parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest
parseFrom(byte[] data)
static SearchRequest
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest
parseFrom(com.google.protobuf.ByteString data)
static SearchRequest
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest
parseFrom(com.google.protobuf.CodedInputStream input)
static SearchRequest
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest
parseFrom(InputStream input)
static SearchRequest
parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest
parseFrom(ByteBuffer data)
static SearchRequest
parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SearchRequest>
parser()
SearchRequest.Builder
toBuilder()
void
writeTo(com.google.protobuf.CodedOutputStream output)
-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
SERVING_CONFIG_FIELD_NUMBER
public static final int SERVING_CONFIG_FIELD_NUMBER
- See Also:
- Constant Field Values
-
BRANCH_FIELD_NUMBER
public static final int BRANCH_FIELD_NUMBER
- See Also:
- Constant Field Values
-
QUERY_FIELD_NUMBER
public static final int QUERY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
IMAGE_QUERY_FIELD_NUMBER
public static final int IMAGE_QUERY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
- See Also:
- Constant Field Values
-
OFFSET_FIELD_NUMBER
public static final int OFFSET_FIELD_NUMBER
- See Also:
- Constant Field Values
-
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ORDER_BY_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
USER_INFO_FIELD_NUMBER
public static final int USER_INFO_FIELD_NUMBER
- See Also:
- Constant Field Values
-
FACET_SPECS_FIELD_NUMBER
public static final int FACET_SPECS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
BOOST_SPEC_FIELD_NUMBER
public static final int BOOST_SPEC_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PARAMS_FIELD_NUMBER
public static final int PARAMS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
QUERY_EXPANSION_SPEC_FIELD_NUMBER
public static final int QUERY_EXPANSION_SPEC_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SPELL_CORRECTION_SPEC_FIELD_NUMBER
public static final int SPELL_CORRECTION_SPEC_FIELD_NUMBER
- See Also:
- Constant Field Values
-
USER_PSEUDO_ID_FIELD_NUMBER
public static final int USER_PSEUDO_ID_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CONTENT_SEARCH_SPEC_FIELD_NUMBER
public static final int CONTENT_SEARCH_SPEC_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SAFE_SEARCH_FIELD_NUMBER
public static final int SAFE_SEARCH_FIELD_NUMBER
- See Also:
- Constant Field Values
-
USER_LABELS_FIELD_NUMBER
public static final int USER_LABELS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstance
in classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetMapField
protected com.google.protobuf.MapField internalGetMapField(int number)
- Overrides:
internalGetMapField
in classcom.google.protobuf.GeneratedMessageV3
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3
-
getServingConfig
public String getServingConfig()
Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
- Specified by:
getServingConfig
in interfaceSearchRequestOrBuilder
- Returns:
- The servingConfig.
-
getServingConfigBytes
public com.google.protobuf.ByteString getServingConfigBytes()
Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
- Specified by:
getServingConfigBytes
in interfaceSearchRequestOrBuilder
- Returns:
- The bytes for servingConfig.
-
getBranch
public String getBranch()
The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.
string branch = 2 [(.google.api.resource_reference) = { ... }
- Specified by:
getBranch
in interfaceSearchRequestOrBuilder
- Returns:
- The branch.
-
getBranchBytes
public com.google.protobuf.ByteString getBranchBytes()
The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.
string branch = 2 [(.google.api.resource_reference) = { ... }
- Specified by:
getBranchBytes
in interfaceSearchRequestOrBuilder
- Returns:
- The bytes for branch.
-
getQuery
public String getQuery()
Raw search query.
string query = 3;
- Specified by:
getQuery
in interfaceSearchRequestOrBuilder
- Returns:
- The query.
-
getQueryBytes
public com.google.protobuf.ByteString getQueryBytes()
Raw search query.
string query = 3;
- Specified by:
getQueryBytes
in interfaceSearchRequestOrBuilder
- Returns:
- The bytes for query.
-
hasImageQuery
public boolean hasImageQuery()
Raw image query.
.google.cloud.discoveryengine.v1.SearchRequest.ImageQuery image_query = 19;
- Specified by:
hasImageQuery
in interfaceSearchRequestOrBuilder
- Returns:
- Whether the imageQuery field is set.
-
getImageQuery
public SearchRequest.ImageQuery getImageQuery()
Raw image query.
.google.cloud.discoveryengine.v1.SearchRequest.ImageQuery image_query = 19;
- Specified by:
getImageQuery
in interfaceSearchRequestOrBuilder
- Returns:
- The imageQuery.
-
getImageQueryOrBuilder
public SearchRequest.ImageQueryOrBuilder getImageQueryOrBuilder()
Raw image query.
.google.cloud.discoveryengine.v1.SearchRequest.ImageQuery image_query = 19;
- Specified by:
getImageQueryOrBuilder
in interfaceSearchRequestOrBuilder
-
getPageSize
public int getPageSize()
Maximum number of [Document][google.cloud.discoveryengine.v1.Document]s to return. If unspecified, defaults to a reasonable value. The maximum allowed value is 100. Values above 100 are coerced to 100. If this field is negative, an `INVALID_ARGUMENT` is returned.
int32 page_size = 4;
- Specified by:
getPageSize
in interfaceSearchRequestOrBuilder
- Returns:
- The pageSize.
-
getPageToken
public String getPageToken()
A page token received from a previous [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
string page_token = 5;
- Specified by:
getPageToken
in interfaceSearchRequestOrBuilder
- Returns:
- The pageToken.
-
getPageTokenBytes
public com.google.protobuf.ByteString getPageTokenBytes()
A page token received from a previous [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
string page_token = 5;
- Specified by:
getPageTokenBytes
in interfaceSearchRequestOrBuilder
- Returns:
- The bytes for pageToken.
-
getOffset
public int getOffset()
A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the [Document][google.cloud.discoveryengine.v1.Document]s deemed by the API as relevant) in search results. This field is only considered if [page_token][google.cloud.discoveryengine.v1.SearchRequest.page_token] is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
int32 offset = 6;
- Specified by:
getOffset
in interfaceSearchRequestOrBuilder
- Returns:
- The offset.
-
getFilter
public String getFilter()
The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
string filter = 7;
- Specified by:
getFilter
in interfaceSearchRequestOrBuilder
- Returns:
- The filter.
-
getFilterBytes
public com.google.protobuf.ByteString getFilterBytes()
The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
string filter = 7;
- Specified by:
getFilterBytes
in interfaceSearchRequestOrBuilder
- Returns:
- The bytes for filter.
-
getOrderBy
public String getOrderBy()
The order in which documents are returned. Documents can be ordered by a field in an [Document][google.cloud.discoveryengine.v1.Document] object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
string order_by = 8;
- Specified by:
getOrderBy
in interfaceSearchRequestOrBuilder
- Returns:
- The orderBy.
-
getOrderByBytes
public com.google.protobuf.ByteString getOrderByBytes()
The order in which documents are returned. Documents can be ordered by a field in an [Document][google.cloud.discoveryengine.v1.Document] object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
string order_by = 8;
- Specified by:
getOrderByBytes
in interfaceSearchRequestOrBuilder
- Returns:
- The bytes for orderBy.
-
hasUserInfo
public boolean hasUserInfo()
Information about the end user. Highly recommended for analytics. [UserInfo.user_agent][google.cloud.discoveryengine.v1.UserInfo.user_agent] is used to deduce `device_type` for analytics.
.google.cloud.discoveryengine.v1.UserInfo user_info = 21;
- Specified by:
hasUserInfo
in interfaceSearchRequestOrBuilder
- Returns:
- Whether the userInfo field is set.
-
getUserInfo
public UserInfo getUserInfo()
Information about the end user. Highly recommended for analytics. [UserInfo.user_agent][google.cloud.discoveryengine.v1.UserInfo.user_agent] is used to deduce `device_type` for analytics.
.google.cloud.discoveryengine.v1.UserInfo user_info = 21;
- Specified by:
getUserInfo
in interfaceSearchRequestOrBuilder
- Returns:
- The userInfo.
-
getUserInfoOrBuilder
public UserInfoOrBuilder getUserInfoOrBuilder()
Information about the end user. Highly recommended for analytics. [UserInfo.user_agent][google.cloud.discoveryengine.v1.UserInfo.user_agent] is used to deduce `device_type` for analytics.
.google.cloud.discoveryengine.v1.UserInfo user_info = 21;
- Specified by:
getUserInfoOrBuilder
in interfaceSearchRequestOrBuilder
-
getFacetSpecsList
public List<SearchRequest.FacetSpec> getFacetSpecsList()
Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;
- Specified by:
getFacetSpecsList
in interfaceSearchRequestOrBuilder
-
getFacetSpecsOrBuilderList
public List<? extends SearchRequest.FacetSpecOrBuilder> getFacetSpecsOrBuilderList()
Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;
- Specified by:
getFacetSpecsOrBuilderList
in interfaceSearchRequestOrBuilder
-
getFacetSpecsCount
public int getFacetSpecsCount()
Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;
- Specified by:
getFacetSpecsCount
in interfaceSearchRequestOrBuilder
-
getFacetSpecs
public SearchRequest.FacetSpec getFacetSpecs(int index)
Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;
- Specified by:
getFacetSpecs
in interfaceSearchRequestOrBuilder
-
getFacetSpecsOrBuilder
public SearchRequest.FacetSpecOrBuilder getFacetSpecsOrBuilder(int index)
Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;
- Specified by:
getFacetSpecsOrBuilder
in interfaceSearchRequestOrBuilder
-
hasBoostSpec
public boolean hasBoostSpec()
Boost specification to boost certain documents.
.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec boost_spec = 10;
- Specified by:
hasBoostSpec
in interfaceSearchRequestOrBuilder
- Returns:
- Whether the boostSpec field is set.
-
getBoostSpec
public SearchRequest.BoostSpec getBoostSpec()
Boost specification to boost certain documents.
.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec boost_spec = 10;
- Specified by:
getBoostSpec
in interfaceSearchRequestOrBuilder
- Returns:
- The boostSpec.
-
getBoostSpecOrBuilder
public SearchRequest.BoostSpecOrBuilder getBoostSpecOrBuilder()
Boost specification to boost certain documents.
.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec boost_spec = 10;
- Specified by:
getBoostSpecOrBuilder
in interfaceSearchRequestOrBuilder
-
getParamsCount
public int getParamsCount()
Description copied from interface:SearchRequestOrBuilder
Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching.
map<string, .google.protobuf.Value> params = 11;
- Specified by:
getParamsCount
in interfaceSearchRequestOrBuilder
-
containsParams
public boolean containsParams(String key)
Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching.
map<string, .google.protobuf.Value> params = 11;
- Specified by:
containsParams
in interfaceSearchRequestOrBuilder
-
getParams
@Deprecated public Map<String,com.google.protobuf.Value> getParams()
Deprecated.UsegetParamsMap()
instead.- Specified by:
getParams
in interfaceSearchRequestOrBuilder
-
getParamsMap
public Map<String,com.google.protobuf.Value> getParamsMap()
Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching.
map<string, .google.protobuf.Value> params = 11;
- Specified by:
getParamsMap
in interfaceSearchRequestOrBuilder
-
getParamsOrDefault
public com.google.protobuf.Value getParamsOrDefault(String key, com.google.protobuf.Value defaultValue)
Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching.
map<string, .google.protobuf.Value> params = 11;
- Specified by:
getParamsOrDefault
in interfaceSearchRequestOrBuilder
-
getParamsOrThrow
public com.google.protobuf.Value getParamsOrThrow(String key)
Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching.
map<string, .google.protobuf.Value> params = 11;
- Specified by:
getParamsOrThrow
in interfaceSearchRequestOrBuilder
-
hasQueryExpansionSpec
public boolean hasQueryExpansionSpec()
The query expansion specification that specifies the conditions under which query expansion occurs.
.google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;
- Specified by:
hasQueryExpansionSpec
in interfaceSearchRequestOrBuilder
- Returns:
- Whether the queryExpansionSpec field is set.
-
getQueryExpansionSpec
public SearchRequest.QueryExpansionSpec getQueryExpansionSpec()
The query expansion specification that specifies the conditions under which query expansion occurs.
.google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;
- Specified by:
getQueryExpansionSpec
in interfaceSearchRequestOrBuilder
- Returns:
- The queryExpansionSpec.
-
getQueryExpansionSpecOrBuilder
public SearchRequest.QueryExpansionSpecOrBuilder getQueryExpansionSpecOrBuilder()
The query expansion specification that specifies the conditions under which query expansion occurs.
.google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;
- Specified by:
getQueryExpansionSpecOrBuilder
in interfaceSearchRequestOrBuilder
-
hasSpellCorrectionSpec
public boolean hasSpellCorrectionSpec()
The spell correction specification that specifies the mode under which spell correction takes effect.
.google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;
- Specified by:
hasSpellCorrectionSpec
in interfaceSearchRequestOrBuilder
- Returns:
- Whether the spellCorrectionSpec field is set.
-
getSpellCorrectionSpec
public SearchRequest.SpellCorrectionSpec getSpellCorrectionSpec()
The spell correction specification that specifies the mode under which spell correction takes effect.
.google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;
- Specified by:
getSpellCorrectionSpec
in interfaceSearchRequestOrBuilder
- Returns:
- The spellCorrectionSpec.
-
getSpellCorrectionSpecOrBuilder
public SearchRequest.SpellCorrectionSpecOrBuilder getSpellCorrectionSpecOrBuilder()
The spell correction specification that specifies the mode under which spell correction takes effect.
.google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;
- Specified by:
getSpellCorrectionSpecOrBuilder
in interfaceSearchRequestOrBuilder
-
getUserPseudoId
public String getUserPseudoId()
A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id] and [CompleteQueryRequest.user_pseudo_id][google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id] The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
string user_pseudo_id = 15;
- Specified by:
getUserPseudoId
in interfaceSearchRequestOrBuilder
- Returns:
- The userPseudoId.
-
getUserPseudoIdBytes
public com.google.protobuf.ByteString getUserPseudoIdBytes()
A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id] and [CompleteQueryRequest.user_pseudo_id][google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id] The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
string user_pseudo_id = 15;
- Specified by:
getUserPseudoIdBytes
in interfaceSearchRequestOrBuilder
- Returns:
- The bytes for userPseudoId.
-
hasContentSearchSpec
public boolean hasContentSearchSpec()
A specification for configuring the behavior of content search.
.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec content_search_spec = 24;
- Specified by:
hasContentSearchSpec
in interfaceSearchRequestOrBuilder
- Returns:
- Whether the contentSearchSpec field is set.
-
getContentSearchSpec
public SearchRequest.ContentSearchSpec getContentSearchSpec()
A specification for configuring the behavior of content search.
.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec content_search_spec = 24;
- Specified by:
getContentSearchSpec
in interfaceSearchRequestOrBuilder
- Returns:
- The contentSearchSpec.
-
getContentSearchSpecOrBuilder
public SearchRequest.ContentSearchSpecOrBuilder getContentSearchSpecOrBuilder()
A specification for configuring the behavior of content search.
.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec content_search_spec = 24;
- Specified by:
getContentSearchSpecOrBuilder
in interfaceSearchRequestOrBuilder
-
getSafeSearch
public boolean getSafeSearch()
Whether to turn on safe search. This is only supported for website search.
bool safe_search = 20;
- Specified by:
getSafeSearch
in interfaceSearchRequestOrBuilder
- Returns:
- The safeSearch.
-
getUserLabelsCount
public int getUserLabelsCount()
Description copied from interface:SearchRequestOrBuilder
The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
map<string, string> user_labels = 22;
- Specified by:
getUserLabelsCount
in interfaceSearchRequestOrBuilder
-
containsUserLabels
public boolean containsUserLabels(String key)
The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
map<string, string> user_labels = 22;
- Specified by:
containsUserLabels
in interfaceSearchRequestOrBuilder
-
getUserLabels
@Deprecated public Map<String,String> getUserLabels()
Deprecated.UsegetUserLabelsMap()
instead.- Specified by:
getUserLabels
in interfaceSearchRequestOrBuilder
-
getUserLabelsMap
public Map<String,String> getUserLabelsMap()
The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
map<string, string> user_labels = 22;
- Specified by:
getUserLabelsMap
in interfaceSearchRequestOrBuilder
-
getUserLabelsOrDefault
public String getUserLabelsOrDefault(String key, String defaultValue)
The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
map<string, string> user_labels = 22;
- Specified by:
getUserLabelsOrDefault
in interfaceSearchRequestOrBuilder
-
getUserLabelsOrThrow
public String getUserLabelsOrThrow(String key)
The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
map<string, string> user_labels = 22;
- Specified by:
getUserLabelsOrThrow
in interfaceSearchRequestOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static SearchRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SearchRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SearchRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SearchRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SearchRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SearchRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SearchRequest parseFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static SearchRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static SearchRequest parseDelimitedFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static SearchRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseFrom
public static SearchRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static SearchRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
newBuilderForType
public SearchRequest.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static SearchRequest.Builder newBuilder()
-
newBuilder
public static SearchRequest.Builder newBuilder(SearchRequest prototype)
-
toBuilder
public SearchRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected SearchRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static SearchRequest getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<SearchRequest> parser()
-
getParserForType
public com.google.protobuf.Parser<SearchRequest> getParserForType()
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public SearchRequest getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-