Class DataStoreTool.EngineSource (0.1.0)

public static final class DataStoreTool.EngineSource extends GeneratedMessage implements DataStoreTool.EngineSourceOrBuilder

Configuration for searching within an Engine, potentially targeting specific DataStores.

Protobuf type google.cloud.ces.v1.DataStoreTool.EngineSource

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > DataStoreTool.EngineSource

Implements

DataStoreTool.EngineSourceOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

DATA_STORE_SOURCES_FIELD_NUMBER

public static final int DATA_STORE_SOURCES_FIELD_NUMBER

Field Value
Type	Description
int

ENGINE_FIELD_NUMBER

public static final int ENGINE_FIELD_NUMBER

Field Value
Type	Description
int

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static DataStoreTool.EngineSource getDefaultInstance()

Returns
Type	Description
DataStoreTool.EngineSource

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static DataStoreTool.EngineSource.Builder newBuilder()

Returns
Type	Description
DataStoreTool.EngineSource.Builder

newBuilder(DataStoreTool.EngineSource prototype)

public static DataStoreTool.EngineSource.Builder newBuilder(DataStoreTool.EngineSource prototype)

Parameter
Name	Description
prototype	DataStoreTool.EngineSource

Returns
Type	Description
DataStoreTool.EngineSource.Builder

parseDelimitedFrom(InputStream input)

public static DataStoreTool.EngineSource parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
DataStoreTool.EngineSource

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataStoreTool.EngineSource parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DataStoreTool.EngineSource

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static DataStoreTool.EngineSource parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
DataStoreTool.EngineSource

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DataStoreTool.EngineSource parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DataStoreTool.EngineSource

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DataStoreTool.EngineSource parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
DataStoreTool.EngineSource

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DataStoreTool.EngineSource parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DataStoreTool.EngineSource

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DataStoreTool.EngineSource parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
DataStoreTool.EngineSource

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DataStoreTool.EngineSource parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DataStoreTool.EngineSource

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static DataStoreTool.EngineSource parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
DataStoreTool.EngineSource

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataStoreTool.EngineSource parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DataStoreTool.EngineSource

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static DataStoreTool.EngineSource parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
DataStoreTool.EngineSource

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DataStoreTool.EngineSource parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DataStoreTool.EngineSource

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<DataStoreTool.EngineSource> parser()

Returns
Type	Description
Parser<EngineSource>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDataStoreSources(int index)

public DataStoreTool.DataStoreSource getDataStoreSources(int index)

Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.

repeated .google.cloud.ces.v1.DataStoreTool.DataStoreSource data_store_sources = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
DataStoreTool.DataStoreSource

getDataStoreSourcesCount()

public int getDataStoreSourcesCount()

Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.

repeated .google.cloud.ces.v1.DataStoreTool.DataStoreSource data_store_sources = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getDataStoreSourcesList()

public List<DataStoreTool.DataStoreSource> getDataStoreSourcesList()

Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.

repeated .google.cloud.ces.v1.DataStoreTool.DataStoreSource data_store_sources = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<DataStoreSource>

getDataStoreSourcesOrBuilder(int index)

public DataStoreTool.DataStoreSourceOrBuilder getDataStoreSourcesOrBuilder(int index)

Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.

repeated .google.cloud.ces.v1.DataStoreTool.DataStoreSource data_store_sources = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
DataStoreTool.DataStoreSourceOrBuilder

getDataStoreSourcesOrBuilderList()

public List<? extends DataStoreTool.DataStoreSourceOrBuilder> getDataStoreSourcesOrBuilderList()

Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.

repeated .google.cloud.ces.v1.DataStoreTool.DataStoreSource data_store_sources = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<? extends com.google.cloud.ces.v1.DataStoreTool.DataStoreSourceOrBuilder>

getDefaultInstanceForType()

public DataStoreTool.EngineSource getDefaultInstanceForType()

Returns
Type	Description
DataStoreTool.EngineSource

getEngine()

public String getEngine()

Required. Full resource name of the Engine. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

string engine = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The engine.

getEngineBytes()

public ByteString getEngineBytes()

Required. Full resource name of the Engine. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

string engine = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for engine.

getFilter()

public String getFilter()

Optional. A filter applied to the search across the Engine. Not relevant and not used if 'data_store_sources' is provided. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata

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

Returns
Type	Description
String	The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. A filter applied to the search across the Engine. Not relevant and not used if 'data_store_sources' is provided. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata

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

Returns
Type	Description
ByteString	The bytes for filter.

getParserForType()

public Parser<DataStoreTool.EngineSource> getParserForType()

Returns
Type	Description
Parser<EngineSource>

Overrides

GeneratedMessage.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public DataStoreTool.EngineSource.Builder newBuilderForType()

Returns
Type	Description
DataStoreTool.EngineSource.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected DataStoreTool.EngineSource.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
DataStoreTool.EngineSource.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public DataStoreTool.EngineSource.Builder toBuilder()

Returns
Type	Description
DataStoreTool.EngineSource.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException