com.google.cloud.discoveryengine.v1

Class SearchRequest.DataStoreSpec

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec

All Implemented Interfaces:

SearchRequest.DataStoreSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

SearchRequest

public static final class SearchRequest.DataStoreSpec
extends com.google.protobuf.GeneratedMessage
implements SearchRequest.DataStoreSpecOrBuilder

 A struct to define data stores to filter on in a search call and
 configurations for those data stores. Otherwise, an `INVALID_ARGUMENT`
 error is returned.
 

Protobuf type google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchRequest.DataStoreSpec.Builder A struct to define data stores to filter on in a search call and configurations for those data stores.

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	BOOST_SPEC_FIELD_NUMBER
static int	CUSTOM_SEARCH_OPERATORS_FIELD_NUMBER
static int	DATA_STORE_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.BoostSpec	getBoostSpec() Optional.
SearchRequest.BoostSpecOrBuilder	getBoostSpecOrBuilder() Optional.
String	getCustomSearchOperators() Optional.
com.google.protobuf.ByteString	getCustomSearchOperatorsBytes() Optional.
String	getDataStore() Required.
com.google.protobuf.ByteString	getDataStoreBytes() Required.
static SearchRequest.DataStoreSpec	getDefaultInstance()
SearchRequest.DataStoreSpec	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getFilter() Optional.
com.google.protobuf.ByteString	getFilterBytes() Optional.
com.google.protobuf.Parser<SearchRequest.DataStoreSpec>	getParserForType()
int	getSerializedSize()
boolean	hasBoostSpec() Optional.
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static SearchRequest.DataStoreSpec.Builder	newBuilder()
static SearchRequest.DataStoreSpec.Builder	newBuilder(SearchRequest.DataStoreSpec prototype)
SearchRequest.DataStoreSpec.Builder	newBuilderForType()
protected SearchRequest.DataStoreSpec.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static SearchRequest.DataStoreSpec	parseDelimitedFrom(InputStream input)
static SearchRequest.DataStoreSpec	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.DataStoreSpec	parseFrom(byte[] data)
static SearchRequest.DataStoreSpec	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.DataStoreSpec	parseFrom(ByteBuffer data)
static SearchRequest.DataStoreSpec	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.DataStoreSpec	parseFrom(com.google.protobuf.ByteString data)
static SearchRequest.DataStoreSpec	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.DataStoreSpec	parseFrom(com.google.protobuf.CodedInputStream input)
static SearchRequest.DataStoreSpec	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.DataStoreSpec	parseFrom(InputStream input)
static SearchRequest.DataStoreSpec	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SearchRequest.DataStoreSpec>	parser()
SearchRequest.DataStoreSpec.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_FIELD_NUMBER

public static final int DATA_STORE_FIELD_NUMBER

See Also:

Constant Field Values

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

See Also:

Constant Field Values

BOOST_SPEC_FIELD_NUMBER

public static final int BOOST_SPEC_FIELD_NUMBER

See Also:

Constant Field Values

CUSTOM_SEARCH_OPERATORS_FIELD_NUMBER

public static final int CUSTOM_SEARCH_OPERATORS_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

getDataStore

public String getDataStore()

 Required. Full resource name of
 [DataStore][google.cloud.discoveryengine.v1.DataStore], such as
 `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
 The path must include the project number, project id is not supported for
 this field.
 

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

Specified by:

getDataStore in interface SearchRequest.DataStoreSpecOrBuilder

Returns:

The dataStore.

getDataStoreBytes

public com.google.protobuf.ByteString getDataStoreBytes()

 Required. Full resource name of
 [DataStore][google.cloud.discoveryengine.v1.DataStore], such as
 `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
 The path must include the project number, project id is not supported for
 this field.
 

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

Specified by:

getDataStoreBytes in interface SearchRequest.DataStoreSpecOrBuilder

Returns:

The bytes for dataStore.

getFilter

public String getFilter()

 Optional. Filter specification to filter documents in the data store
 specified by data_store field. For more information on filtering, see
 [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
 

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

Specified by:

getFilter in interface SearchRequest.DataStoreSpecOrBuilder

Returns:

The filter.

getFilterBytes

public com.google.protobuf.ByteString getFilterBytes()

 Optional. Filter specification to filter documents in the data store
 specified by data_store field. For more information on filtering, see
 [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
 

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

Specified by:

getFilterBytes in interface SearchRequest.DataStoreSpecOrBuilder

Returns:

The bytes for filter.

hasBoostSpec

public boolean hasBoostSpec()

 Optional. Boost specification to boost certain documents.
 For more information on boosting, see
 [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
 

.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasBoostSpec in interface SearchRequest.DataStoreSpecOrBuilder

Returns:

Whether the boostSpec field is set.

getBoostSpec

public SearchRequest.BoostSpec getBoostSpec()

 Optional. Boost specification to boost certain documents.
 For more information on boosting, see
 [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
 

.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getBoostSpec in interface SearchRequest.DataStoreSpecOrBuilder

Returns:

The boostSpec.

getBoostSpecOrBuilder

public SearchRequest.BoostSpecOrBuilder getBoostSpecOrBuilder()

 Optional. Boost specification to boost certain documents.
 For more information on boosting, see
 [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
 

.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getBoostSpecOrBuilder in interface SearchRequest.DataStoreSpecOrBuilder

getCustomSearchOperators

public String getCustomSearchOperators()

 Optional. Custom search operators which if specified will be used to
 filter results from workspace data stores. For more information on custom
 search operators, see
 [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
 

string custom_search_operators = 7 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getCustomSearchOperators in interface SearchRequest.DataStoreSpecOrBuilder

Returns:

The customSearchOperators.

getCustomSearchOperatorsBytes

public com.google.protobuf.ByteString getCustomSearchOperatorsBytes()

 Optional. Custom search operators which if specified will be used to
 filter results from workspace data stores. For more information on custom
 search operators, see
 [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
 

string custom_search_operators = 7 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getCustomSearchOperatorsBytes in interface SearchRequest.DataStoreSpecOrBuilder

Returns:

The bytes for customSearchOperators.

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 SearchRequest.DataStoreSpec parseFrom(ByteBuffer data)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.DataStoreSpec parseFrom(InputStream input)
                                             throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static SearchRequest.DataStoreSpec parseDelimitedFrom(InputStream input)
                                                      throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public SearchRequest.DataStoreSpec.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static SearchRequest.DataStoreSpec.Builder newBuilder()

newBuilder

public static SearchRequest.DataStoreSpec.Builder newBuilder(SearchRequest.DataStoreSpec prototype)

toBuilder

public SearchRequest.DataStoreSpec.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected SearchRequest.DataStoreSpec.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static SearchRequest.DataStoreSpec getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<SearchRequest.DataStoreSpec> 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 SearchRequest.DataStoreSpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder