Class RetrieveContextsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.RetrieveContextsRequest
All Implemented Interfaces:
RetrieveContextsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class RetrieveContextsRequest extends com.google.protobuf.GeneratedMessage implements RetrieveContextsRequestOrBuilder
 Request message for
 [VertexRagService.RetrieveContexts][google.cloud.aiplatform.v1.VertexRagService.RetrieveContexts].
 
Protobuf type google.cloud.aiplatform.v1.RetrieveContextsRequest
See Also:
  • Field Details

  • Method Details

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

      public RetrieveContextsRequest.DataSourceCase getDataSourceCase()
      Specified by:
      getDataSourceCase in interface RetrieveContextsRequestOrBuilder
    • hasVertexRagStore

      public boolean hasVertexRagStore()
       The data source for Vertex RagStore.
       
      .google.cloud.aiplatform.v1.RetrieveContextsRequest.VertexRagStore vertex_rag_store = 2;
      Specified by:
      hasVertexRagStore in interface RetrieveContextsRequestOrBuilder
      Returns:
      Whether the vertexRagStore field is set.
    • getVertexRagStore

      public RetrieveContextsRequest.VertexRagStore getVertexRagStore()
       The data source for Vertex RagStore.
       
      .google.cloud.aiplatform.v1.RetrieveContextsRequest.VertexRagStore vertex_rag_store = 2;
      Specified by:
      getVertexRagStore in interface RetrieveContextsRequestOrBuilder
      Returns:
      The vertexRagStore.
    • getVertexRagStoreOrBuilder

      public RetrieveContextsRequest.VertexRagStoreOrBuilder getVertexRagStoreOrBuilder()
       The data source for Vertex RagStore.
       
      .google.cloud.aiplatform.v1.RetrieveContextsRequest.VertexRagStore vertex_rag_store = 2;
      Specified by:
      getVertexRagStoreOrBuilder in interface RetrieveContextsRequestOrBuilder
    • getParent

      public String getParent()
       Required. The resource name of the Location from which to retrieve
       RagContexts. The users must have permission to make a call in the project.
       Format:
       `projects/{project}/locations/{location}`.
       
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParent in interface RetrieveContextsRequestOrBuilder
      Returns:
      The parent.
    • getParentBytes

      public com.google.protobuf.ByteString getParentBytes()
       Required. The resource name of the Location from which to retrieve
       RagContexts. The users must have permission to make a call in the project.
       Format:
       `projects/{project}/locations/{location}`.
       
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParentBytes in interface RetrieveContextsRequestOrBuilder
      Returns:
      The bytes for parent.
    • hasQuery

      public boolean hasQuery()
       Required. Single RAG retrieve query.
       
      .google.cloud.aiplatform.v1.RagQuery query = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasQuery in interface RetrieveContextsRequestOrBuilder
      Returns:
      Whether the query field is set.
    • getQuery

      public RagQuery getQuery()
       Required. Single RAG retrieve query.
       
      .google.cloud.aiplatform.v1.RagQuery query = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getQuery in interface RetrieveContextsRequestOrBuilder
      Returns:
      The query.
    • getQueryOrBuilder

      public RagQueryOrBuilder getQueryOrBuilder()
       Required. Single RAG retrieve query.
       
      .google.cloud.aiplatform.v1.RagQuery query = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getQueryOrBuilder in interface RetrieveContextsRequestOrBuilder
    • 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 RetrieveContextsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static RetrieveContextsRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static RetrieveContextsRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static RetrieveContextsRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static RetrieveContextsRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static RetrieveContextsRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static RetrieveContextsRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static RetrieveContextsRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static RetrieveContextsRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static RetrieveContextsRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static RetrieveContextsRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static RetrieveContextsRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public RetrieveContextsRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static RetrieveContextsRequest.Builder newBuilder()
    • newBuilder

      public static RetrieveContextsRequest.Builder newBuilder(RetrieveContextsRequest prototype)
    • toBuilder

      public RetrieveContextsRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected RetrieveContextsRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static RetrieveContextsRequest getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<RetrieveContextsRequest> parser()
    • getParserForType

      public com.google.protobuf.Parser<RetrieveContextsRequest> 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 RetrieveContextsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder