Class RetrieveMemoriesRequest (3.83.0)
3.88.0 (latest)
3.86.0
3.84.0
3.83.0
3.82.0
3.81.0
3.79.0
3.77.0
3.76.0
3.75.0
3.74.0
3.73.0
3.71.0
3.69.0
3.68.0
3.65.0
3.64.0
3.63.0
3.61.0
3.60.0
3.59.0
3.58.0
3.57.0
3.56.0
3.55.0
3.54.0
3.53.0
3.52.0
3.50.0
3.49.0
3.48.0
3.47.0
3.46.0
3.45.0
3.44.0
3.43.0
3.42.0
3.41.0
3.40.0
3.38.0
3.37.0
3.36.0
3.35.0
3.34.0
3.33.0
3.32.0
3.31.0
3.30.0
3.29.0
3.28.0
3.25.0
3.24.0
3.23.0
3.22.0
3.21.0
3.20.0
3.19.0
3.18.0
3.17.0
3.16.0
3.15.0
3.14.0
3.13.0
3.12.0
3.11.0
3.10.0
3.9.0
3.8.0
3.7.0
3.6.0
3.5.0
3.4.2
3.3.0
3.2.0
3.0.0
2.9.8
2.8.9
2.7.4
2.5.3
2.4.0
public final class RetrieveMemoriesRequest extends GeneratedMessageV3 implements RetrieveMemoriesRequestOrBuilder
Request message for
MemoryBankService.RetrieveMemories .
Protobuf type google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int
public static final int SCOPE_FIELD_NUMBER
Field Value
Type Description
int
public static final int SIMILARITY_SEARCH_PARAMS_FIELD_NUMBER
Field Value
Type Description
int
public static final int SIMPLE_RETRIEVAL_PARAMS_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
public static RetrieveMemoriesRequest getDefaultInstance ()
public static final Descriptors . Descriptor getDescriptor ()
public static RetrieveMemoriesRequest . Builder newBuilder ()
public static RetrieveMemoriesRequest . Builder newBuilder ( RetrieveMemoriesRequest prototype )
public static RetrieveMemoriesRequest parseDelimitedFrom ( InputStream input )
public static RetrieveMemoriesRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static RetrieveMemoriesRequest parseFrom ( byte [] data )
Parameter
Name Description
databyte []
public static RetrieveMemoriesRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
public static RetrieveMemoriesRequest parseFrom ( ByteString data )
public static RetrieveMemoriesRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static RetrieveMemoriesRequest parseFrom ( CodedInputStream input )
public static RetrieveMemoriesRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static RetrieveMemoriesRequest parseFrom ( InputStream input )
public static RetrieveMemoriesRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static RetrieveMemoriesRequest parseFrom ( ByteBuffer data )
public static RetrieveMemoriesRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
public static Parser<RetrieveMemoriesRequest> parser ()
Methods
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];
Parameter
Name Description
keyString
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
public RetrieveMemoriesRequest getDefaultInstanceForType ()
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) = { ... }
Returns
Type Description
String The parent.
public 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) = { ... }
Returns
Type Description
ByteString The bytes for parent.
public Parser<RetrieveMemoriesRequest> getParserForType ()
Overrides
public RetrieveMemoriesRequest . RetrievalParamsCase getRetrievalParamsCase ()
public Map<String , String > getScope ()
public int getScopeCount ()
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];
Returns
Type Description
int
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];
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];
Returns
Type Description
String
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];
Parameter
Name Description
keyString
Returns
Type Description
String
public int getSerializedSize ()
Returns
Type Description
int
Overrides
public RetrieveMemoriesRequest . SimilaritySearchParams getSimilaritySearchParams ()
Parameters for semantic similarity search based retrieval.
.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams similarity_search_params = 6;
public RetrieveMemoriesRequest . SimilaritySearchParamsOrBuilder getSimilaritySearchParamsOrBuilder ()
Parameters for semantic similarity search based retrieval.
.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams similarity_search_params = 6;
public RetrieveMemoriesRequest . SimpleRetrievalParams getSimpleRetrievalParams ()
Parameters for simple (non-similarity search) retrieval.
.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimpleRetrievalParams simple_retrieval_params = 7;
public RetrieveMemoriesRequest . SimpleRetrievalParamsOrBuilder getSimpleRetrievalParamsOrBuilder ()
Parameters for simple (non-similarity search) retrieval.
.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimpleRetrievalParams simple_retrieval_params = 7;
public boolean hasSimilaritySearchParams ()
Parameters for semantic similarity search based retrieval.
.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams similarity_search_params = 6;
Returns
Type Description
boolean Whether the similaritySearchParams field is set.
public boolean hasSimpleRetrievalParams ()
Parameters for simple (non-similarity search) retrieval.
.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimpleRetrievalParams simple_retrieval_params = 7;
Returns
Type Description
boolean Whether the simpleRetrievalParams field is set.
Returns
Type Description
int
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
protected MapFieldReflectionAccessor internalGetMapFieldReflection ( int number )
Parameter
Name Description
numberint
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
public final boolean isInitialized ()
Overrides
public RetrieveMemoriesRequest . Builder newBuilderForType ()
protected RetrieveMemoriesRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
public RetrieveMemoriesRequest . Builder toBuilder ()
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-03-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-03-14 UTC."],[],[]]
