public final class SearchRequest extends GeneratedMessageV3 implements SearchRequestOrBuilder
Request message for
SearchService.Search
method.
Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest
Static Fields
BOOST_SPEC_FIELD_NUMBER
public static final int BOOST_SPEC_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
BRANCH_FIELD_NUMBER
public static final int BRANCH_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CONTENT_SEARCH_SPEC_FIELD_NUMBER
public static final int CONTENT_SEARCH_SPEC_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
FACET_SPECS_FIELD_NUMBER
public static final int FACET_SPECS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
OFFSET_FIELD_NUMBER
public static final int OFFSET_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ORDER_BY_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PARAMS_FIELD_NUMBER
public static final int PARAMS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
QUERY_EXPANSION_SPEC_FIELD_NUMBER
public static final int QUERY_EXPANSION_SPEC_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
QUERY_FIELD_NUMBER
public static final int QUERY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SERVING_CONFIG_FIELD_NUMBER
public static final int SERVING_CONFIG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SPELL_CORRECTION_SPEC_FIELD_NUMBER
public static final int SPELL_CORRECTION_SPEC_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
USER_PSEUDO_ID_FIELD_NUMBER
public static final int USER_PSEUDO_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static SearchRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static SearchRequest.Builder newBuilder()
newBuilder(SearchRequest prototype)
public static SearchRequest.Builder newBuilder(SearchRequest prototype)
public static SearchRequest parseDelimitedFrom(InputStream input)
public static SearchRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static SearchRequest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static SearchRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchRequest parseFrom(CodedInputStream input)
public static SearchRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchRequest parseFrom(InputStream input)
public static SearchRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static SearchRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<SearchRequest> parser()
Methods
containsParams(String key)
public boolean containsParams(String key)
Additional search parameters.
For
IndustryVertical.SITE_SEARCH
vertical, 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.
This field is ignored for other verticals.
map<string, .google.protobuf.Value> params = 11;
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getBoostSpec()
public SearchRequest.BoostSpec getBoostSpec()
Boost specification to boost certain documents.
.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10;
getBoostSpecOrBuilder()
public SearchRequest.BoostSpecOrBuilder getBoostSpecOrBuilder()
Boost specification to boost certain documents.
.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10;
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) = { ... }
| Returns |
|---|
| Type | Description |
String | The branch.
|
getBranchBytes()
public 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) = { ... }
| Returns |
|---|
| Type | Description |
ByteString | The bytes for branch.
|
getContentSearchSpec()
public SearchRequest.ContentSearchSpec getContentSearchSpec()
The content search spec that configs the desired behavior of content
search.
.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec content_search_spec = 24;
getContentSearchSpecOrBuilder()
public SearchRequest.ContentSearchSpecOrBuilder getContentSearchSpecOrBuilder()
The content search spec that configs the desired behavior of content
search.
.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec content_search_spec = 24;
getDefaultInstanceForType()
public SearchRequest getDefaultInstanceForType()
getFacetSpecs(int index)
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.v1beta.SearchRequest.FacetSpec facet_specs = 9;
| Parameter |
|---|
| Name | Description |
index | int
|
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.v1beta.SearchRequest.FacetSpec facet_specs = 9;
| Returns |
|---|
| Type | Description |
int | |
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.v1beta.SearchRequest.FacetSpec facet_specs = 9;
getFacetSpecsOrBuilder(int index)
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.v1beta.SearchRequest.FacetSpec facet_specs = 9;
| Parameter |
|---|
| Name | Description |
index | int
|
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.v1beta.SearchRequest.FacetSpec facet_specs = 9;
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpecOrBuilder> | |
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;
| Returns |
|---|
| Type | Description |
String | The filter.
|
getFilterBytes()
public 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;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for filter.
|
getOffset()
A 0-indexed integer that specifies the current offset (that is, starting
result location, amongst the
Documents deemed by the API
as relevant) in search results. This field is only considered if
page_token
is unset.
If this field is negative, an INVALID_ARGUMENT is returned.
int32 offset = 6;
| Returns |
|---|
| Type | Description |
int | The offset.
|
getOrderBy()
public String getOrderBy()
The order in which documents are returned. Document can be ordered by
a field in an Document
object. Leave it unset if ordered by relevance. OrderBy expression is
case-sensitive.
If this field is unrecognizable, an INVALID_ARGUMENT is returned.
string order_by = 8;
| Returns |
|---|
| Type | Description |
String | The orderBy.
|
getOrderByBytes()
public ByteString getOrderByBytes()
The order in which documents are returned. Document can be ordered by
a field in an Document
object. Leave it unset if ordered by relevance. OrderBy expression is
case-sensitive.
If this field is unrecognizable, an INVALID_ARGUMENT is returned.
string order_by = 8;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for orderBy.
|
getPageSize()
Maximum number of Documents
to return. If unspecified, defaults to a reasonable value. The maximum
allowed value is 100. Values above 100 will be coerced to 100.
If this field is negative, an INVALID_ARGUMENT is returned.
int32 page_size = 4;
| Returns |
|---|
| Type | Description |
int | The pageSize.
|
getPageToken()
public String getPageToken()
A page token received from a previous
SearchService.Search
call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
SearchService.Search
must match the call that provided the page token. Otherwise, an
INVALID_ARGUMENT error is returned.
string page_token = 5;
| Returns |
|---|
| Type | Description |
String | The pageToken.
|
getPageTokenBytes()
public ByteString getPageTokenBytes()
A page token received from a previous
SearchService.Search
call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
SearchService.Search
must match the call that provided the page token. Otherwise, an
INVALID_ARGUMENT error is returned.
string page_token = 5;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for pageToken.
|
getParams()
public Map<String,Value> getParams()
getParamsCount()
public int getParamsCount()
Additional search parameters.
For
IndustryVertical.SITE_SEARCH
vertical, 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.
This field is ignored for other verticals.
map<string, .google.protobuf.Value> params = 11;
| Returns |
|---|
| Type | Description |
int | |
getParamsMap()
public Map<String,Value> getParamsMap()
Additional search parameters.
For
IndustryVertical.SITE_SEARCH
vertical, 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.
This field is ignored for other verticals.
map<string, .google.protobuf.Value> params = 11;
getParamsOrDefault(String key, Value defaultValue)
public Value getParamsOrDefault(String key, Value defaultValue)
Additional search parameters.
For
IndustryVertical.SITE_SEARCH
vertical, 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.
This field is ignored for other verticals.
map<string, .google.protobuf.Value> params = 11;
| Returns |
|---|
| Type | Description |
Value | |
getParamsOrThrow(String key)
public Value getParamsOrThrow(String key)
Additional search parameters.
For
IndustryVertical.SITE_SEARCH
vertical, 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.
This field is ignored for other verticals.
map<string, .google.protobuf.Value> params = 11;
| Parameter |
|---|
| Name | Description |
key | String
|
| Returns |
|---|
| Type | Description |
Value | |
getParserForType()
public Parser<SearchRequest> getParserForType()
Overrides
getQuery()
Raw search query.
string query = 3;
| Returns |
|---|
| Type | Description |
String | The query.
|
getQueryBytes()
public ByteString getQueryBytes()
Raw search query.
string query = 3;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for query.
|
getQueryExpansionSpec()
public SearchRequest.QueryExpansionSpec getQueryExpansionSpec()
The query expansion specification that specifies the conditions under which
query expansion will occur.
.google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;
getQueryExpansionSpecOrBuilder()
public SearchRequest.QueryExpansionSpecOrBuilder getQueryExpansionSpecOrBuilder()
The query expansion specification that specifies the conditions under which
query expansion will occur.
.google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
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) = { ... }
| Returns |
|---|
| Type | Description |
String | The servingConfig.
|
getServingConfigBytes()
public 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) = { ... }
| Returns |
|---|
| Type | Description |
ByteString | The bytes for servingConfig.
|
getSpellCorrectionSpec()
public SearchRequest.SpellCorrectionSpec getSpellCorrectionSpec()
The spell correction specification that specifies the mode under
which spell correction will take effect.
.google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;
getSpellCorrectionSpecOrBuilder()
public SearchRequest.SpellCorrectionSpecOrBuilder getSpellCorrectionSpecOrBuilder()
The spell correction specification that specifies the mode under
which spell correction will take effect.
.google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
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
and
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;
| Returns |
|---|
| Type | Description |
String | The userPseudoId.
|
getUserPseudoIdBytes()
public 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
and
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;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for userPseudoId.
|
hasBoostSpec()
public boolean hasBoostSpec()
Boost specification to boost certain documents.
.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10;
| Returns |
|---|
| Type | Description |
boolean | Whether the boostSpec field is set.
|
hasContentSearchSpec()
public boolean hasContentSearchSpec()
The content search spec that configs the desired behavior of content
search.
.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec content_search_spec = 24;
| Returns |
|---|
| Type | Description |
boolean | Whether the contentSearchSpec field is set.
|
hasQueryExpansionSpec()
public boolean hasQueryExpansionSpec()
The query expansion specification that specifies the conditions under which
query expansion will occur.
.google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;
| Returns |
|---|
| Type | Description |
boolean | Whether the queryExpansionSpec field is set.
|
hasSpellCorrectionSpec()
public boolean hasSpellCorrectionSpec()
The spell correction specification that specifies the mode under
which spell correction will take effect.
.google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;
| Returns |
|---|
| Type | Description |
boolean | Whether the spellCorrectionSpec field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public SearchRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public SearchRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
