Package com.google.cloud.aiplatform.v1beta1

Class RetrieveMemoriesRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<RetrieveMemoriesRequest.Builder>
com.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.Builder
All Implemented Interfaces:
RetrieveMemoriesRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
RetrieveMemoriesRequest
public static final class RetrieveMemoriesRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<RetrieveMemoriesRequest.Builder> implements RetrieveMemoriesRequestOrBuilder
 Request message for
 [MemoryBankService.RetrieveMemories][google.cloud.aiplatform.v1beta1.MemoryBankService.RetrieveMemories].
Protobuf type google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest

  • Method Details

    • 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.GeneratedMessage.Builder<RetrieveMemoriesRequest.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<RetrieveMemoriesRequest.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<RetrieveMemoriesRequest.Builder>

    • clear

      public RetrieveMemoriesRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<RetrieveMemoriesRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<RetrieveMemoriesRequest.Builder>

    • getDefaultInstanceForType

      public RetrieveMemoriesRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public RetrieveMemoriesRequest build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public RetrieveMemoriesRequest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public RetrieveMemoriesRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RetrieveMemoriesRequest.Builder>

    • mergeFrom

      public RetrieveMemoriesRequest.Builder mergeFrom(RetrieveMemoriesRequest other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<RetrieveMemoriesRequest.Builder>

    • mergeFrom

      public RetrieveMemoriesRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RetrieveMemoriesRequest.Builder>
      Throws:
      IOException

    • getRetrievalParamsCase

      public RetrieveMemoriesRequest.RetrievalParamsCase getRetrievalParamsCase()
      Specified by:
      getRetrievalParamsCase in interface RetrieveMemoriesRequestOrBuilder

    • clearRetrievalParams

      public RetrieveMemoriesRequest.Builder clearRetrievalParams()

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

    • setSimilaritySearchParams

      public RetrieveMemoriesRequest.Builder setSimilaritySearchParams(RetrieveMemoriesRequest.SimilaritySearchParams value)
       Parameters for semantic similarity search based retrieval.
      .google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams similarity_search_params = 6;

    • setSimilaritySearchParams

      public RetrieveMemoriesRequest.Builder setSimilaritySearchParams(RetrieveMemoriesRequest.SimilaritySearchParams.Builder builderForValue)
       Parameters for semantic similarity search based retrieval.
      .google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams similarity_search_params = 6;

    • mergeSimilaritySearchParams

      public RetrieveMemoriesRequest.Builder mergeSimilaritySearchParams(RetrieveMemoriesRequest.SimilaritySearchParams value)
       Parameters for semantic similarity search based retrieval.
      .google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams similarity_search_params = 6;

    • clearSimilaritySearchParams

      public RetrieveMemoriesRequest.Builder clearSimilaritySearchParams()
       Parameters for semantic similarity search based retrieval.
      .google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams similarity_search_params = 6;

    • getSimilaritySearchParamsBuilder

      public RetrieveMemoriesRequest.SimilaritySearchParams.Builder getSimilaritySearchParamsBuilder()
       Parameters for semantic similarity search based retrieval.
      .google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams similarity_search_params = 6;

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

    • setSimpleRetrievalParams

      public RetrieveMemoriesRequest.Builder setSimpleRetrievalParams(RetrieveMemoriesRequest.SimpleRetrievalParams value)
       Parameters for simple (non-similarity search) retrieval.
      .google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimpleRetrievalParams simple_retrieval_params = 7;

    • setSimpleRetrievalParams

      public RetrieveMemoriesRequest.Builder setSimpleRetrievalParams(RetrieveMemoriesRequest.SimpleRetrievalParams.Builder builderForValue)
       Parameters for simple (non-similarity search) retrieval.
      .google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimpleRetrievalParams simple_retrieval_params = 7;

    • mergeSimpleRetrievalParams

      public RetrieveMemoriesRequest.Builder mergeSimpleRetrievalParams(RetrieveMemoriesRequest.SimpleRetrievalParams value)
       Parameters for simple (non-similarity search) retrieval.
      .google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimpleRetrievalParams simple_retrieval_params = 7;

    • clearSimpleRetrievalParams

      public RetrieveMemoriesRequest.Builder clearSimpleRetrievalParams()
       Parameters for simple (non-similarity search) retrieval.
      .google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimpleRetrievalParams simple_retrieval_params = 7;

    • getSimpleRetrievalParamsBuilder

      public RetrieveMemoriesRequest.SimpleRetrievalParams.Builder getSimpleRetrievalParamsBuilder()
       Parameters for simple (non-similarity search) retrieval.
      .google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimpleRetrievalParams simple_retrieval_params = 7;

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

    • setParent

      public RetrieveMemoriesRequest.Builder setParent(String value)
       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) = { ... }
      Parameters:
      value - The parent to set.
      Returns:
      This builder for chaining.

    • clearParent

      public RetrieveMemoriesRequest.Builder clearParent()
       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:
      This builder for chaining.

    • setParentBytes

      public RetrieveMemoriesRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for parent to set.
      Returns:
      This builder for chaining.

    • 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

    • clearScope

      public RetrieveMemoriesRequest.Builder clearScope()

    • removeScope

      public RetrieveMemoriesRequest.Builder removeScope(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];

    • getMutableScope

      @Deprecated public Map<String,String> getMutableScope()
      Deprecated.
      Use alternate mutation accessors instead.

    • putScope

      public RetrieveMemoriesRequest.Builder putScope(String key, String value)
       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];

    • putAllScope

      public RetrieveMemoriesRequest.Builder putAllScope(Map<String,String> values)
       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];