com.google.cloud.discoveryengine.v1alpha

Class SearchInfo

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1alpha.SearchInfo

All Implemented Interfaces:

SearchInfoOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class SearchInfo
extends com.google.protobuf.GeneratedMessageV3
implements SearchInfoOrBuilder

 Detailed search information.
 

Protobuf type google.cloud.discoveryengine.v1alpha.SearchInfo

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchInfo.Builder Detailed search information.

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

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	OFFSET_FIELD_NUMBER
static int	ORDER_BY_FIELD_NUMBER
static int	SEARCH_QUERY_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static SearchInfo	getDefaultInstance()
SearchInfo	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
int	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.
com.google.protobuf.ByteString	getOrderByBytes() The order in which products are returned, if applicable.
com.google.protobuf.Parser<SearchInfo>	getParserForType()
String	getSearchQuery() The user's search query.
com.google.protobuf.ByteString	getSearchQueryBytes() The user's search query.
int	getSerializedSize()
int	hashCode()
boolean	hasOffset() An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant).
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static SearchInfo.Builder	newBuilder()
static SearchInfo.Builder	newBuilder(SearchInfo prototype)
SearchInfo.Builder	newBuilderForType()
protected SearchInfo.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static SearchInfo	parseDelimitedFrom(InputStream input)
static SearchInfo	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchInfo	parseFrom(byte[] data)
static SearchInfo	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchInfo	parseFrom(ByteBuffer data)
static SearchInfo	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchInfo	parseFrom(com.google.protobuf.ByteString data)
static SearchInfo	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchInfo	parseFrom(com.google.protobuf.CodedInputStream input)
static SearchInfo	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchInfo	parseFrom(InputStream input)
static SearchInfo	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SearchInfo>	parser()
SearchInfo.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, 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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

SEARCH_QUERY_FIELD_NUMBER

public static final int SEARCH_QUERY_FIELD_NUMBER

See Also:

Constant Field Values

ORDER_BY_FIELD_NUMBER

public static final int ORDER_BY_FIELD_NUMBER

See Also:

Constant Field Values

OFFSET_FIELD_NUMBER

public static final int OFFSET_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getSearchQuery

public String getSearchQuery()

 The user's search query.

 See
 [SearchRequest.query][google.cloud.discoveryengine.v1alpha.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][google.cloud.discoveryengine.v1alpha.SearchInfo.search_query]
 or
 [PageInfo.page_category][google.cloud.discoveryengine.v1alpha.PageInfo.page_category]
 is required for `search` events. Other event types should not set this
 field. Otherwise, an `INVALID_ARGUMENT` error is returned.
 

string search_query = 1;

Specified by:

getSearchQuery in interface SearchInfoOrBuilder

Returns:

The searchQuery.

getSearchQueryBytes

public com.google.protobuf.ByteString getSearchQueryBytes()

 The user's search query.

 See
 [SearchRequest.query][google.cloud.discoveryengine.v1alpha.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][google.cloud.discoveryengine.v1alpha.SearchInfo.search_query]
 or
 [PageInfo.page_category][google.cloud.discoveryengine.v1alpha.PageInfo.page_category]
 is required for `search` events. Other event types should not set this
 field. Otherwise, an `INVALID_ARGUMENT` error is returned.
 

string search_query = 1;

Specified by:

getSearchQueryBytes in interface SearchInfoOrBuilder

Returns:

The bytes for searchQuery.

getOrderBy

public String getOrderBy()

 The order in which products are returned, if applicable.

 See
 [SearchRequest.order_by][google.cloud.discoveryengine.v1alpha.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.
 

string order_by = 2;

Specified by:

getOrderBy in interface SearchInfoOrBuilder

Returns:

The orderBy.

getOrderByBytes

public com.google.protobuf.ByteString getOrderByBytes()

 The order in which products are returned, if applicable.

 See
 [SearchRequest.order_by][google.cloud.discoveryengine.v1alpha.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.
 

string order_by = 2;

Specified by:

getOrderByBytes in interface SearchInfoOrBuilder

Returns:

The bytes for orderBy.

hasOffset

public boolean hasOffset()

 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][google.cloud.discoveryengine.v1alpha.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.
 

optional int32 offset = 3;

Specified by:

hasOffset in interface SearchInfoOrBuilder

Returns:

Whether the offset field is set.

getOffset

public int 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][google.cloud.discoveryengine.v1alpha.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.
 

optional int32 offset = 3;

Specified by:

getOffset in interface SearchInfoOrBuilder

Returns:

The offset.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static SearchInfo parseFrom(ByteBuffer data)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchInfo parseFrom(ByteBuffer data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchInfo parseFrom(com.google.protobuf.ByteString data)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchInfo parseFrom(com.google.protobuf.ByteString data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchInfo parseFrom(byte[] data)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchInfo parseFrom(byte[] data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchInfo parseFrom(InputStream input)
                            throws IOException

Throws:

IOException

parseFrom

public static SearchInfo parseFrom(InputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws IOException

Throws:

IOException

parseDelimitedFrom

public static SearchInfo parseDelimitedFrom(InputStream input)
                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static SearchInfo parseDelimitedFrom(InputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

parseFrom

public static SearchInfo parseFrom(com.google.protobuf.CodedInputStream input)
                            throws IOException

Throws:

IOException

parseFrom

public static SearchInfo parseFrom(com.google.protobuf.CodedInputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws IOException

Throws:

IOException

newBuilderForType

public SearchInfo.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static SearchInfo.Builder newBuilder()

newBuilder

public static SearchInfo.Builder newBuilder(SearchInfo prototype)

toBuilder

public SearchInfo.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected SearchInfo.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static SearchInfo getDefaultInstance()

parser

public static com.google.protobuf.Parser<SearchInfo> parser()

getParserForType

public com.google.protobuf.Parser<SearchInfo> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public SearchInfo getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder