com.google.api.services.discoveryengine.v1.model

Class GoogleCloudDiscoveryengineV1SearchInfo

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.discoveryengine.v1.model.GoogleCloudDiscoveryengineV1SearchInfo

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleCloudDiscoveryengineV1SearchInfo
extends com.google.api.client.json.GenericJson

Detailed search information.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Discovery Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GoogleCloudDiscoveryengineV1SearchInfo()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1SearchInfo	clone()
Integer	getOffset() An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant).
String	getOrderBy() The order in which products are returned, if applicable.
String	getSearchQuery() The user's search query.
GoogleCloudDiscoveryengineV1SearchInfo	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1SearchInfo	setOffset(Integer offset) An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant).
GoogleCloudDiscoveryengineV1SearchInfo	setOrderBy(String orderBy) The order in which products are returned, if applicable.
GoogleCloudDiscoveryengineV1SearchInfo	setSearchQuery(String searchQuery) The user's search query.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GoogleCloudDiscoveryengineV1SearchInfo

public GoogleCloudDiscoveryengineV1SearchInfo()

Method Detail

getOffset

public Integer getOffset()

An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant). See SearchRequest.offset for definition. If this field is negative, an `INVALID_ARGUMENT` is returned. This can only be set for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.

Returns:

value or null for none

setOffset

public GoogleCloudDiscoveryengineV1SearchInfo setOffset(Integer offset)

An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant). See SearchRequest.offset for definition. If this field is negative, an `INVALID_ARGUMENT` is returned. This can only be set for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.

Parameters:

offset - offset or null for none

getOrderBy

public String getOrderBy()

The order in which products are returned, if applicable. See SearchRequest.order_by for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This can only be set for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.

Returns:

value or null for none

setOrderBy

public GoogleCloudDiscoveryengineV1SearchInfo setOrderBy(String orderBy)

The order in which products are returned, if applicable. See SearchRequest.order_by for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This can only be set for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.

Parameters:

orderBy - orderBy or null for none

getSearchQuery

public String getSearchQuery()

The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. At least one of search_query or PageInfo.page_category is required for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.

Returns:

value or null for none

setSearchQuery

public GoogleCloudDiscoveryengineV1SearchInfo setSearchQuery(String searchQuery)

The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. At least one of search_query or PageInfo.page_category is required for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.

Parameters:

searchQuery - searchQuery or null for none

set

public GoogleCloudDiscoveryengineV1SearchInfo set(String fieldName,
                                                  Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public GoogleCloudDiscoveryengineV1SearchInfo clone()

Overrides:

clone in class com.google.api.client.json.GenericJson