com.google.cloud.discoveryengine.v1

Class StreamAssistRequest.ToolsSpec.VertexAiSearchSpec

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.cloud.discoveryengine.v1.StreamAssistRequest.ToolsSpec.VertexAiSearchSpec

All Implemented Interfaces:

StreamAssistRequest.ToolsSpec.VertexAiSearchSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

StreamAssistRequest.ToolsSpec

public static final class StreamAssistRequest.ToolsSpec.VertexAiSearchSpec
extends com.google.protobuf.GeneratedMessage
implements StreamAssistRequest.ToolsSpec.VertexAiSearchSpecOrBuilder

 Specification of the Vertex AI Search tool.
 

Protobuf type google.cloud.discoveryengine.v1.StreamAssistRequest.ToolsSpec.VertexAiSearchSpec

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder Specification of the Vertex AI Search tool.

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

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

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

com.google.protobuf.AbstractMessage.BuilderParent

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	DATA_STORE_SPECS_FIELD_NUMBER
static int	FILTER_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, 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)
SearchRequest.DataStoreSpec	getDataStoreSpecs(int index) Optional.
int	getDataStoreSpecsCount() Optional.
List<SearchRequest.DataStoreSpec>	getDataStoreSpecsList() Optional.
SearchRequest.DataStoreSpecOrBuilder	getDataStoreSpecsOrBuilder(int index) Optional.
List<? extends SearchRequest.DataStoreSpecOrBuilder>	getDataStoreSpecsOrBuilderList() Optional.
static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec	getDefaultInstance()
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getFilter() Optional.
com.google.protobuf.ByteString	getFilterBytes() Optional.
com.google.protobuf.Parser<StreamAssistRequest.ToolsSpec.VertexAiSearchSpec>	getParserForType()
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder	newBuilder()
static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder	newBuilder(StreamAssistRequest.ToolsSpec.VertexAiSearchSpec prototype)
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder	newBuilderForType()
protected StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec	parseDelimitedFrom(InputStream input)
static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec	parseFrom(byte[] data)
static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec	parseFrom(ByteBuffer data)
static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec	parseFrom(com.google.protobuf.ByteString data)
static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec	parseFrom(com.google.protobuf.CodedInputStream input)
static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec	parseFrom(InputStream input)
static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<StreamAssistRequest.ToolsSpec.VertexAiSearchSpec>	parser()
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

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, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

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

DATA_STORE_SPECS_FIELD_NUMBER

public static final int DATA_STORE_SPECS_FIELD_NUMBER

See Also:

Constant Field Values

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getDataStoreSpecsList

public List<SearchRequest.DataStoreSpec> getDataStoreSpecsList()

 Optional. Specs defining
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to filter on in
 a search call and configurations for those data stores. This is only
 considered for [Engine][google.cloud.discoveryengine.v1.Engine]s with
 multiple data stores.
 

repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getDataStoreSpecsList in interface StreamAssistRequest.ToolsSpec.VertexAiSearchSpecOrBuilder

getDataStoreSpecsOrBuilderList

public List<? extends SearchRequest.DataStoreSpecOrBuilder> getDataStoreSpecsOrBuilderList()

 Optional. Specs defining
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to filter on in
 a search call and configurations for those data stores. This is only
 considered for [Engine][google.cloud.discoveryengine.v1.Engine]s with
 multiple data stores.
 

repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getDataStoreSpecsOrBuilderList in interface StreamAssistRequest.ToolsSpec.VertexAiSearchSpecOrBuilder

getDataStoreSpecsCount

public int getDataStoreSpecsCount()

 Optional. Specs defining
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to filter on in
 a search call and configurations for those data stores. This is only
 considered for [Engine][google.cloud.discoveryengine.v1.Engine]s with
 multiple data stores.
 

repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getDataStoreSpecsCount in interface StreamAssistRequest.ToolsSpec.VertexAiSearchSpecOrBuilder

getDataStoreSpecs

public SearchRequest.DataStoreSpec getDataStoreSpecs(int index)

 Optional. Specs defining
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to filter on in
 a search call and configurations for those data stores. This is only
 considered for [Engine][google.cloud.discoveryengine.v1.Engine]s with
 multiple data stores.
 

repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getDataStoreSpecs in interface StreamAssistRequest.ToolsSpec.VertexAiSearchSpecOrBuilder

getDataStoreSpecsOrBuilder

public SearchRequest.DataStoreSpecOrBuilder getDataStoreSpecsOrBuilder(int index)

 Optional. Specs defining
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to filter on in
 a search call and configurations for those data stores. This is only
 considered for [Engine][google.cloud.discoveryengine.v1.Engine]s with
 multiple data stores.
 

repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getDataStoreSpecsOrBuilder in interface StreamAssistRequest.ToolsSpec.VertexAiSearchSpecOrBuilder

getFilter

public String getFilter()

 Optional. 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.

 Filtering in Vertex AI Search is done by mapping the LHS filter key to
 a key property defined in the Vertex AI Search backend -- this mapping
 is defined by the customer in their schema. For example a media
 customer might have a field 'name' in their schema. In this case the
 filter would look like this: filter --> name:'ANY("king kong")'

 For more information about filtering including syntax and filter
 operators, see
 [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
 

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getFilter in interface StreamAssistRequest.ToolsSpec.VertexAiSearchSpecOrBuilder

Returns:

The filter.

getFilterBytes

public com.google.protobuf.ByteString getFilterBytes()

 Optional. 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.

 Filtering in Vertex AI Search is done by mapping the LHS filter key to
 a key property defined in the Vertex AI Search backend -- this mapping
 is defined by the customer in their schema. For example a media
 customer might have a field 'name' in their schema. In this case the
 filter would look like this: filter --> name:'ANY("king kong")'

 For more information about filtering including syntax and filter
 operators, see
 [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
 

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getFilterBytes in interface StreamAssistRequest.ToolsSpec.VertexAiSearchSpecOrBuilder

Returns:

The bytes for filter.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

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.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

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 StreamAssistRequest.ToolsSpec.VertexAiSearchSpec parseFrom(ByteBuffer data)
                                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec parseFrom(com.google.protobuf.ByteString data)
                                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec parseFrom(byte[] data)
                                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec parseFrom(InputStream input)
                                                                  throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec parseDelimitedFrom(InputStream input)
                                                                           throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec parseFrom(com.google.protobuf.CodedInputStream input)
                                                                  throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder newBuilder()

newBuilder

public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder newBuilder(StreamAssistRequest.ToolsSpec.VertexAiSearchSpec prototype)

toBuilder

public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec getDefaultInstance()

parser

public static com.google.protobuf.Parser<StreamAssistRequest.ToolsSpec.VertexAiSearchSpec> parser()

getParserForType

public com.google.protobuf.Parser<StreamAssistRequest.ToolsSpec.VertexAiSearchSpec> 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.GeneratedMessage

getDefaultInstanceForType

public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder