Class SearchRequest.Builder (0.12.0)

public static final class SearchRequest.Builder extends GeneratedMessageV3.Builder<SearchRequest.Builder> implements SearchRequestOrBuilder

Request message for SearchService.Search method.

Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchRequest.Builder

Implements

SearchRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllFacetSpecs(Iterable<? extends SearchRequest.FacetSpec> values)

public SearchRequest.Builder addAllFacetSpecs(Iterable<? extends SearchRequest.FacetSpec> values)

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
`values`	`Iterable<? extends com.google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec>`

Returns
Type	Description
`SearchRequest.Builder`

addFacetSpecs(SearchRequest.FacetSpec value)

public SearchRequest.Builder addFacetSpecs(SearchRequest.FacetSpec value)

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
`value`	`SearchRequest.FacetSpec`

Returns
Type	Description
`SearchRequest.Builder`

addFacetSpecs(SearchRequest.FacetSpec.Builder builderForValue)

public SearchRequest.Builder addFacetSpecs(SearchRequest.FacetSpec.Builder builderForValue)

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
`builderForValue`	`SearchRequest.FacetSpec.Builder`

Returns
Type	Description
`SearchRequest.Builder`

addFacetSpecs(int index, SearchRequest.FacetSpec value)

public SearchRequest.Builder addFacetSpecs(int index, SearchRequest.FacetSpec value)

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;

Parameters
Name	Description
`index`	`int`
`value`	`SearchRequest.FacetSpec`

Returns
Type	Description
`SearchRequest.Builder`

addFacetSpecs(int index, SearchRequest.FacetSpec.Builder builderForValue)

public SearchRequest.Builder addFacetSpecs(int index, SearchRequest.FacetSpec.Builder builderForValue)

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;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`SearchRequest.FacetSpec.Builder`

Returns
Type	Description
`SearchRequest.Builder`

addFacetSpecsBuilder()

public SearchRequest.FacetSpec.Builder addFacetSpecsBuilder()

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
`SearchRequest.FacetSpec.Builder`

addFacetSpecsBuilder(int index)

public SearchRequest.FacetSpec.Builder addFacetSpecsBuilder(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`

Returns
Type	Description
`SearchRequest.FacetSpec.Builder`

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`SearchRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public SearchRequest build()

Returns
Type	Description
`SearchRequest`

buildPartial()

public SearchRequest buildPartial()

Returns
Type	Description
`SearchRequest`

clear()

public SearchRequest.Builder clear()

Returns
Type	Description
`SearchRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearBoostSpec()

public SearchRequest.Builder clearBoostSpec()

Boost specification to boost certain documents.

.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10;

Returns
Type	Description
`SearchRequest.Builder`

clearBranch()

public SearchRequest.Builder clearBranch()

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
`SearchRequest.Builder`	This builder for chaining.

clearContentSearchSpec()

public SearchRequest.Builder clearContentSearchSpec()

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
`SearchRequest.Builder`

clearFacetSpecs()

public SearchRequest.Builder clearFacetSpecs()

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
`SearchRequest.Builder`

clearField(Descriptors.FieldDescriptor field)

public SearchRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`SearchRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFilter()

public SearchRequest.Builder clearFilter()

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
`SearchRequest.Builder`	This builder for chaining.

clearOffset()

public SearchRequest.Builder clearOffset()

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
`SearchRequest.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`SearchRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearOrderBy()

public SearchRequest.Builder clearOrderBy()

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
`SearchRequest.Builder`	This builder for chaining.

clearPageSize()

public SearchRequest.Builder clearPageSize()

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
`SearchRequest.Builder`	This builder for chaining.

clearPageToken()

public SearchRequest.Builder clearPageToken()

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
`SearchRequest.Builder`	This builder for chaining.

clearParams()

public SearchRequest.Builder clearParams()

Returns
Type	Description
`SearchRequest.Builder`

clearQuery()

public SearchRequest.Builder clearQuery()

Raw search query.

string query = 3;

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

clearQueryExpansionSpec()

public SearchRequest.Builder clearQueryExpansionSpec()

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
`SearchRequest.Builder`

clearServingConfig()

public SearchRequest.Builder clearServingConfig()

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
`SearchRequest.Builder`	This builder for chaining.

clearSpellCorrectionSpec()

public SearchRequest.Builder clearSpellCorrectionSpec()

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
`SearchRequest.Builder`

clearUserPseudoId()

public SearchRequest.Builder clearUserPseudoId()

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
`SearchRequest.Builder`	This builder for chaining.

clone()

public SearchRequest.Builder clone()

Returns
Type	Description
`SearchRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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`

Returns
Type	Description
`boolean`

getBoostSpec()

public SearchRequest.BoostSpec getBoostSpec()

Boost specification to boost certain documents.

.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10;

Returns
Type	Description
`SearchRequest.BoostSpec`	The boostSpec.

getBoostSpecBuilder()

public SearchRequest.BoostSpec.Builder getBoostSpecBuilder()

Boost specification to boost certain documents.

.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10;

Returns
Type	Description
`SearchRequest.BoostSpec.Builder`

getBoostSpecOrBuilder()

public SearchRequest.BoostSpecOrBuilder getBoostSpecOrBuilder()

Boost specification to boost certain documents.

.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10;

Returns
Type	Description
`SearchRequest.BoostSpecOrBuilder`

getBranch()

public String getBranch()

string branch = 2 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`String`	The branch.

getBranchBytes()

public ByteString getBranchBytes()

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;

Returns
Type	Description
`SearchRequest.ContentSearchSpec`	The contentSearchSpec.

getContentSearchSpecBuilder()

public SearchRequest.ContentSearchSpec.Builder getContentSearchSpecBuilder()

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
`SearchRequest.ContentSearchSpec.Builder`

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;

Returns
Type	Description
`SearchRequest.ContentSearchSpecOrBuilder`

getDefaultInstanceForType()

public SearchRequest getDefaultInstanceForType()

Returns
Type	Description
`SearchRequest`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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`

Returns
Type	Description
`SearchRequest.FacetSpec`

getFacetSpecsBuilder(int index)

public SearchRequest.FacetSpec.Builder getFacetSpecsBuilder(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`

Returns
Type	Description
`SearchRequest.FacetSpec.Builder`

getFacetSpecsBuilderList()

public List<SearchRequest.FacetSpec.Builder> getFacetSpecsBuilderList()

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<Builder>`

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;

Returns
Type	Description
`List<FacetSpec>`

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`

Returns
Type	Description
`SearchRequest.FacetSpecOrBuilder`

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()

string filter = 7;

Returns
Type	Description
`String`	The filter.

getFilterBytes()

public ByteString getFilterBytes()

string filter = 7;

Returns
Type	Description
`ByteString`	The bytes for filter.

getMutableParams()

public Map<String,Value> getMutableParams()

Use alternate mutation accessors instead.

Returns
Type	Description
`Map<String,Value>`

getOffset()

public int getOffset()

int32 offset = 6;

Returns
Type	Description
`int`	The offset.

getOrderBy()

public String getOrderBy()

string order_by = 8;

Returns
Type	Description
`String`	The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

string order_by = 8;

Returns
Type	Description
`ByteString`	The bytes for orderBy.

getPageSize()

public int getPageSize()

int32 page_size = 4;

Returns
Type	Description
`int`	The pageSize.

getPageToken()

public String getPageToken()

string page_token = 5;

Returns
Type	Description
`String`	The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

string page_token = 5;

Returns
Type	Description
`ByteString`	The bytes for pageToken.

getParams()

public Map<String,Value> getParams()

Use #getParamsMap() instead.

Returns
Type	Description
`Map<String,Value>`

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;

Returns
Type	Description
`Map<String,Value>`

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;

Parameters
Name	Description
`key`	`String`
`defaultValue`	`Value`

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`

getQuery()

public String 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;

Returns
Type	Description
`SearchRequest.QueryExpansionSpec`	The queryExpansionSpec.

getQueryExpansionSpecBuilder()

public SearchRequest.QueryExpansionSpec.Builder getQueryExpansionSpecBuilder()

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
`SearchRequest.QueryExpansionSpec.Builder`

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;

Returns
Type	Description
`SearchRequest.QueryExpansionSpecOrBuilder`

getServingConfig()

public String getServingConfig()

string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`String`	The servingConfig.

getServingConfigBytes()

public ByteString getServingConfigBytes()

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;

Returns
Type	Description
`SearchRequest.SpellCorrectionSpec`	The spellCorrectionSpec.

getSpellCorrectionSpecBuilder()

public SearchRequest.SpellCorrectionSpec.Builder getSpellCorrectionSpecBuilder()

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
`SearchRequest.SpellCorrectionSpec.Builder`

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;

Returns
Type	Description
`SearchRequest.SpellCorrectionSpecOrBuilder`

getUserPseudoId()

public String getUserPseudoId()

string user_pseudo_id = 15;

Returns
Type	Description
`String`	The userPseudoId.

getUserPseudoIdBytes()

public ByteString getUserPseudoIdBytes()

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`MapField`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMapField(int fieldNumber)

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`MapField`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMutableMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeBoostSpec(SearchRequest.BoostSpec value)

public SearchRequest.Builder mergeBoostSpec(SearchRequest.BoostSpec value)

Boost specification to boost certain documents.

.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10;

Parameter
Name	Description
`value`	`SearchRequest.BoostSpec`

Returns
Type	Description
`SearchRequest.Builder`

mergeContentSearchSpec(SearchRequest.ContentSearchSpec value)

public SearchRequest.Builder mergeContentSearchSpec(SearchRequest.ContentSearchSpec value)

The content search spec that configs the desired behavior of content search.

.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec content_search_spec = 24;

Parameter
Name	Description
`value`	`SearchRequest.ContentSearchSpec`

Returns
Type	Description
`SearchRequest.Builder`

mergeFrom(SearchRequest other)

public SearchRequest.Builder mergeFrom(SearchRequest other)

Parameter
Name	Description
`other`	`SearchRequest`

Returns
Type	Description
`SearchRequest.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SearchRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public SearchRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`SearchRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeQueryExpansionSpec(SearchRequest.QueryExpansionSpec value)

public SearchRequest.Builder mergeQueryExpansionSpec(SearchRequest.QueryExpansionSpec value)

The query expansion specification that specifies the conditions under which query expansion will occur.

.google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;

Parameter
Name	Description
`value`	`SearchRequest.QueryExpansionSpec`

Returns
Type	Description
`SearchRequest.Builder`

mergeSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec value)

public SearchRequest.Builder mergeSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec value)

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;

Parameter
Name	Description
`value`	`SearchRequest.SpellCorrectionSpec`

Returns
Type	Description
`SearchRequest.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`SearchRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

putAllParams(Map<String,Value> values)

public SearchRequest.Builder putAllParams(Map<String,Value> values)

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
`values`	`Map<String,Value>`

Returns
Type	Description
`SearchRequest.Builder`

putParams(String key, Value value)

public SearchRequest.Builder putParams(String key, Value value)

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;

Parameters
Name	Description
`key`	`String`
`value`	`Value`

Returns
Type	Description
`SearchRequest.Builder`

removeFacetSpecs(int index)

public SearchRequest.Builder removeFacetSpecs(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`

Returns
Type	Description
`SearchRequest.Builder`

removeParams(String key)

public SearchRequest.Builder removeParams(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
`SearchRequest.Builder`

setBoostSpec(SearchRequest.BoostSpec value)

public SearchRequest.Builder setBoostSpec(SearchRequest.BoostSpec value)

Boost specification to boost certain documents.

.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10;

Parameter
Name	Description
`value`	`SearchRequest.BoostSpec`

Returns
Type	Description
`SearchRequest.Builder`

setBoostSpec(SearchRequest.BoostSpec.Builder builderForValue)

public SearchRequest.Builder setBoostSpec(SearchRequest.BoostSpec.Builder builderForValue)

Boost specification to boost certain documents.

.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10;

Parameter
Name	Description
`builderForValue`	`SearchRequest.BoostSpec.Builder`

Returns
Type	Description
`SearchRequest.Builder`

setBranch(String value)

public SearchRequest.Builder setBranch(String value)

string branch = 2 [(.google.api.resource_reference) = { ... }

Parameter
Name	Description
`value`	`String` The branch to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setBranchBytes(ByteString value)

public SearchRequest.Builder setBranchBytes(ByteString value)

string branch = 2 [(.google.api.resource_reference) = { ... }

Parameter
Name	Description
`value`	`ByteString` The bytes for branch to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setContentSearchSpec(SearchRequest.ContentSearchSpec value)

public SearchRequest.Builder setContentSearchSpec(SearchRequest.ContentSearchSpec value)

The content search spec that configs the desired behavior of content search.

.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec content_search_spec = 24;

Parameter
Name	Description
`value`	`SearchRequest.ContentSearchSpec`

Returns
Type	Description
`SearchRequest.Builder`

setContentSearchSpec(SearchRequest.ContentSearchSpec.Builder builderForValue)

public SearchRequest.Builder setContentSearchSpec(SearchRequest.ContentSearchSpec.Builder builderForValue)

The content search spec that configs the desired behavior of content search.

.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec content_search_spec = 24;

Parameter
Name	Description
`builderForValue`	`SearchRequest.ContentSearchSpec.Builder`

Returns
Type	Description
`SearchRequest.Builder`

setFacetSpecs(int index, SearchRequest.FacetSpec value)

public SearchRequest.Builder setFacetSpecs(int index, SearchRequest.FacetSpec value)

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;

Parameters
Name	Description
`index`	`int`
`value`	`SearchRequest.FacetSpec`

Returns
Type	Description
`SearchRequest.Builder`

setFacetSpecs(int index, SearchRequest.FacetSpec.Builder builderForValue)

public SearchRequest.Builder setFacetSpecs(int index, SearchRequest.FacetSpec.Builder builderForValue)

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;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`SearchRequest.FacetSpec.Builder`

Returns
Type	Description
`SearchRequest.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`SearchRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFilter(String value)

public SearchRequest.Builder setFilter(String value)

string filter = 7;

Parameter
Name	Description
`value`	`String` The filter to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setFilterBytes(ByteString value)

public SearchRequest.Builder setFilterBytes(ByteString value)

string filter = 7;

Parameter
Name	Description
`value`	`ByteString` The bytes for filter to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setOffset(int value)

public SearchRequest.Builder setOffset(int value)

int32 offset = 6;

Parameter
Name	Description
`value`	`int` The offset to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setOrderBy(String value)

public SearchRequest.Builder setOrderBy(String value)

string order_by = 8;

Parameter
Name	Description
`value`	`String` The orderBy to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setOrderByBytes(ByteString value)

public SearchRequest.Builder setOrderByBytes(ByteString value)

string order_by = 8;

Parameter
Name	Description
`value`	`ByteString` The bytes for orderBy to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setPageSize(int value)

public SearchRequest.Builder setPageSize(int value)

int32 page_size = 4;

Parameter
Name	Description
`value`	`int` The pageSize to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setPageToken(String value)

public SearchRequest.Builder setPageToken(String value)

string page_token = 5;

Parameter
Name	Description
`value`	`String` The pageToken to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setPageTokenBytes(ByteString value)

public SearchRequest.Builder setPageTokenBytes(ByteString value)

string page_token = 5;

Parameter
Name	Description
`value`	`ByteString` The bytes for pageToken to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setQuery(String value)

public SearchRequest.Builder setQuery(String value)

Raw search query.

string query = 3;

Parameter
Name	Description
`value`	`String` The query to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setQueryBytes(ByteString value)

public SearchRequest.Builder setQueryBytes(ByteString value)

Raw search query.

string query = 3;

Parameter
Name	Description
`value`	`ByteString` The bytes for query to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setQueryExpansionSpec(SearchRequest.QueryExpansionSpec value)

public SearchRequest.Builder setQueryExpansionSpec(SearchRequest.QueryExpansionSpec value)

The query expansion specification that specifies the conditions under which query expansion will occur.

.google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;

Parameter
Name	Description
`value`	`SearchRequest.QueryExpansionSpec`

Returns
Type	Description
`SearchRequest.Builder`

setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.Builder builderForValue)

public SearchRequest.Builder setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.Builder builderForValue)

The query expansion specification that specifies the conditions under which query expansion will occur.

.google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;

Parameter
Name	Description
`builderForValue`	`SearchRequest.QueryExpansionSpec.Builder`

Returns
Type	Description
`SearchRequest.Builder`

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SearchRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`SearchRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setServingConfig(String value)

public SearchRequest.Builder setServingConfig(String value)

string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
`value`	`String` The servingConfig to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setServingConfigBytes(ByteString value)

public SearchRequest.Builder setServingConfigBytes(ByteString value)

string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
`value`	`ByteString` The bytes for servingConfig to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec value)

public SearchRequest.Builder setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec value)

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;

Parameter
Name	Description
`value`	`SearchRequest.SpellCorrectionSpec`

Returns
Type	Description
`SearchRequest.Builder`

setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.Builder builderForValue)

public SearchRequest.Builder setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.Builder builderForValue)

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;

Parameter
Name	Description
`builderForValue`	`SearchRequest.SpellCorrectionSpec.Builder`

Returns
Type	Description
`SearchRequest.Builder`

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`SearchRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUserPseudoId(String value)

public SearchRequest.Builder setUserPseudoId(String value)

string user_pseudo_id = 15;

Parameter
Name	Description
`value`	`String` The userPseudoId to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setUserPseudoIdBytes(ByteString value)

public SearchRequest.Builder setUserPseudoIdBytes(ByteString value)

string user_pseudo_id = 15;

Parameter
Name	Description
`value`	`ByteString` The bytes for userPseudoId to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.