com.google.cloud.aiplatform.v1beta1

Class RetrieveMemoriesRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest

All Implemented Interfaces:

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

public final class RetrieveMemoriesRequest
extends com.google.protobuf.GeneratedMessageV3
implements RetrieveMemoriesRequestOrBuilder

 Request message for
 [MemoryBankService.RetrieveMemories][google.cloud.aiplatform.v1beta1.MemoryBankService.RetrieveMemories].
 

Protobuf type google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RetrieveMemoriesRequest.Builder Request message for [MemoryBankService.RetrieveMemories][google.cloud.aiplatform.v1beta1.MemoryBankService.RetrieveMemories].
static class	RetrieveMemoriesRequest.RetrievalParamsCase
static class	RetrieveMemoriesRequest.SimilaritySearchParams Parameters for semantic similarity search based retrieval.
static interface	RetrieveMemoriesRequest.SimilaritySearchParamsOrBuilder
static class	RetrieveMemoriesRequest.SimpleRetrievalParams Parameters for simple (non-similarity search) retrieval.
static interface	RetrieveMemoriesRequest.SimpleRetrievalParamsOrBuilder

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	PARENT_FIELD_NUMBER
static int	SCOPE_FIELD_NUMBER
static int	SIMILARITY_SEARCH_PARAMS_FIELD_NUMBER
static int	SIMPLE_RETRIEVAL_PARAMS_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	containsScope(String key) Required.
boolean	equals(Object obj)
static RetrieveMemoriesRequest	getDefaultInstance()
RetrieveMemoriesRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
com.google.protobuf.Parser<RetrieveMemoriesRequest>	getParserForType()
RetrieveMemoriesRequest.RetrievalParamsCase	getRetrievalParamsCase()
Map<String,String>	getScope() Deprecated.
int	getScopeCount() Required.
Map<String,String>	getScopeMap() Required.
String	getScopeOrDefault(String key, String defaultValue) Required.
String	getScopeOrThrow(String key) Required.
int	getSerializedSize()
RetrieveMemoriesRequest.SimilaritySearchParams	getSimilaritySearchParams() Parameters for semantic similarity search based retrieval.
RetrieveMemoriesRequest.SimilaritySearchParamsOrBuilder	getSimilaritySearchParamsOrBuilder() Parameters for semantic similarity search based retrieval.
RetrieveMemoriesRequest.SimpleRetrievalParams	getSimpleRetrievalParams() Parameters for simple (non-similarity search) retrieval.
RetrieveMemoriesRequest.SimpleRetrievalParamsOrBuilder	getSimpleRetrievalParamsOrBuilder() Parameters for simple (non-similarity search) retrieval.
int	hashCode()
boolean	hasSimilaritySearchParams() Parameters for semantic similarity search based retrieval.
boolean	hasSimpleRetrievalParams() Parameters for simple (non-similarity search) retrieval.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMapFieldReflection(int number)
boolean	isInitialized()
static RetrieveMemoriesRequest.Builder	newBuilder()
static RetrieveMemoriesRequest.Builder	newBuilder(RetrieveMemoriesRequest prototype)
RetrieveMemoriesRequest.Builder	newBuilderForType()
protected RetrieveMemoriesRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static RetrieveMemoriesRequest	parseDelimitedFrom(InputStream input)
static RetrieveMemoriesRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RetrieveMemoriesRequest	parseFrom(byte[] data)
static RetrieveMemoriesRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RetrieveMemoriesRequest	parseFrom(ByteBuffer data)
static RetrieveMemoriesRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RetrieveMemoriesRequest	parseFrom(com.google.protobuf.ByteString data)
static RetrieveMemoriesRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RetrieveMemoriesRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static RetrieveMemoriesRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RetrieveMemoriesRequest	parseFrom(InputStream input)
static RetrieveMemoriesRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RetrieveMemoriesRequest>	parser()
RetrieveMemoriesRequest.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, 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

SIMILARITY_SEARCH_PARAMS_FIELD_NUMBER

public static final int SIMILARITY_SEARCH_PARAMS_FIELD_NUMBER

See Also:

Constant Field Values

SIMPLE_RETRIEVAL_PARAMS_FIELD_NUMBER

public static final int SIMPLE_RETRIEVAL_PARAMS_FIELD_NUMBER

See Also:

Constant Field Values

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER

See Also:

Constant Field Values

SCOPE_FIELD_NUMBER

public static final int SCOPE_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()

internalGetMapFieldReflection

protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getRetrievalParamsCase

public RetrieveMemoriesRequest.RetrievalParamsCase getRetrievalParamsCase()

Specified by:

getRetrievalParamsCase in interface RetrieveMemoriesRequestOrBuilder

hasSimilaritySearchParams

public boolean hasSimilaritySearchParams()

 Parameters for semantic similarity search based retrieval.
 

.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams similarity_search_params = 6;

Specified by:

hasSimilaritySearchParams in interface RetrieveMemoriesRequestOrBuilder

Returns:

Whether the similaritySearchParams field is set.

getSimilaritySearchParams

public RetrieveMemoriesRequest.SimilaritySearchParams getSimilaritySearchParams()

 Parameters for semantic similarity search based retrieval.
 

.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams similarity_search_params = 6;

Specified by:

getSimilaritySearchParams in interface RetrieveMemoriesRequestOrBuilder

Returns:

The similaritySearchParams.

getSimilaritySearchParamsOrBuilder

public RetrieveMemoriesRequest.SimilaritySearchParamsOrBuilder getSimilaritySearchParamsOrBuilder()

 Parameters for semantic similarity search based retrieval.
 

.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams similarity_search_params = 6;

Specified by:

getSimilaritySearchParamsOrBuilder in interface RetrieveMemoriesRequestOrBuilder

hasSimpleRetrievalParams

public boolean hasSimpleRetrievalParams()

 Parameters for simple (non-similarity search) retrieval.
 

.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimpleRetrievalParams simple_retrieval_params = 7;

Specified by:

hasSimpleRetrievalParams in interface RetrieveMemoriesRequestOrBuilder

Returns:

Whether the simpleRetrievalParams field is set.

getSimpleRetrievalParams

public RetrieveMemoriesRequest.SimpleRetrievalParams getSimpleRetrievalParams()

 Parameters for simple (non-similarity search) retrieval.
 

.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimpleRetrievalParams simple_retrieval_params = 7;

Specified by:

getSimpleRetrievalParams in interface RetrieveMemoriesRequestOrBuilder

Returns:

The simpleRetrievalParams.

getSimpleRetrievalParamsOrBuilder

public RetrieveMemoriesRequest.SimpleRetrievalParamsOrBuilder getSimpleRetrievalParamsOrBuilder()

 Parameters for simple (non-similarity search) retrieval.
 

.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimpleRetrievalParams simple_retrieval_params = 7;

Specified by:

getSimpleRetrievalParamsOrBuilder in interface RetrieveMemoriesRequestOrBuilder

getParent

public String getParent()

 Required. The resource name of the ReasoningEngine to retrieve memories
 from. Format:
 `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
 

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

Specified by:

getParent in interface RetrieveMemoriesRequestOrBuilder

Returns:

The parent.

getParentBytes

public com.google.protobuf.ByteString getParentBytes()

 Required. The resource name of the ReasoningEngine to retrieve memories
 from. Format:
 `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
 

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

Specified by:

getParentBytes in interface RetrieveMemoriesRequestOrBuilder

Returns:

The bytes for parent.

getScopeCount

public int getScopeCount()

Description copied from interface: RetrieveMemoriesRequestOrBuilder

 Required. The scope of the memories to retrieve. A memory must have
 exactly the same scope (`Memory.scope`) as the scope provided here to be
 retrieved (same keys and values). Order does not matter, but it is
 case-sensitive.
 

map<string, string> scope = 8 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getScopeCount in interface RetrieveMemoriesRequestOrBuilder

containsScope

public boolean containsScope(String key)

 Required. The scope of the memories to retrieve. A memory must have
 exactly the same scope (`Memory.scope`) as the scope provided here to be
 retrieved (same keys and values). Order does not matter, but it is
 case-sensitive.
 

map<string, string> scope = 8 [(.google.api.field_behavior) = REQUIRED];

Specified by:

containsScope in interface RetrieveMemoriesRequestOrBuilder

getScope

@Deprecated
public Map<String,String> getScope()

Deprecated.

Use getScopeMap() instead.

Specified by:

getScope in interface RetrieveMemoriesRequestOrBuilder

getScopeMap

public Map<String,String> getScopeMap()

 Required. The scope of the memories to retrieve. A memory must have
 exactly the same scope (`Memory.scope`) as the scope provided here to be
 retrieved (same keys and values). Order does not matter, but it is
 case-sensitive.
 

map<string, string> scope = 8 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getScopeMap in interface RetrieveMemoriesRequestOrBuilder

getScopeOrDefault

public String getScopeOrDefault(String key,
                                String defaultValue)

 Required. The scope of the memories to retrieve. A memory must have
 exactly the same scope (`Memory.scope`) as the scope provided here to be
 retrieved (same keys and values). Order does not matter, but it is
 case-sensitive.
 

map<string, string> scope = 8 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getScopeOrDefault in interface RetrieveMemoriesRequestOrBuilder

getScopeOrThrow

public String getScopeOrThrow(String key)

 Required. The scope of the memories to retrieve. A memory must have
 exactly the same scope (`Memory.scope`) as the scope provided here to be
 retrieved (same keys and values). Order does not matter, but it is
 case-sensitive.
 

map<string, string> scope = 8 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getScopeOrThrow in interface RetrieveMemoriesRequestOrBuilder

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RetrieveMemoriesRequest parseFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static RetrieveMemoriesRequest parseDelimitedFrom(InputStream input)
                                                  throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public RetrieveMemoriesRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RetrieveMemoriesRequest.Builder newBuilder()

newBuilder

public static RetrieveMemoriesRequest.Builder newBuilder(RetrieveMemoriesRequest prototype)

toBuilder

public RetrieveMemoriesRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static RetrieveMemoriesRequest getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder