Class RetrieveContextsRequest (3.43.0)

public final class RetrieveContextsRequest extends GeneratedMessageV3 implements RetrieveContextsRequestOrBuilder

Request message for VertexRagService.RetrieveContexts.

Protobuf type google.cloud.aiplatform.v1beta1.RetrieveContextsRequest

Static Fields

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER
Field Value
Type Description
int

VERTEX_RAG_STORE_FIELD_NUMBER

public static final int VERTEX_RAG_STORE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RetrieveContextsRequest getDefaultInstance()
Returns
Type Description
RetrieveContextsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static RetrieveContextsRequest.Builder newBuilder()
Returns
Type Description
RetrieveContextsRequest.Builder

newBuilder(RetrieveContextsRequest prototype)

public static RetrieveContextsRequest.Builder newBuilder(RetrieveContextsRequest prototype)
Parameter
Name Description
prototype RetrieveContextsRequest
Returns
Type Description
RetrieveContextsRequest.Builder

parseDelimitedFrom(InputStream input)

public static RetrieveContextsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RetrieveContextsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RetrieveContextsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetrieveContextsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RetrieveContextsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RetrieveContextsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RetrieveContextsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetrieveContextsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RetrieveContextsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RetrieveContextsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RetrieveContextsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetrieveContextsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RetrieveContextsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RetrieveContextsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RetrieveContextsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetrieveContextsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RetrieveContextsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RetrieveContextsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RetrieveContextsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetrieveContextsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RetrieveContextsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RetrieveContextsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RetrieveContextsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetrieveContextsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RetrieveContextsRequest> parser()
Returns
Type Description
Parser<RetrieveContextsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDataSourceCase()

public RetrieveContextsRequest.DataSourceCase getDataSourceCase()
Returns
Type Description
RetrieveContextsRequest.DataSourceCase

getDefaultInstanceForType()

public RetrieveContextsRequest getDefaultInstanceForType()
Returns
Type Description
RetrieveContextsRequest

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) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public 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) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<RetrieveContextsRequest> getParserForType()
Returns
Type Description
Parser<RetrieveContextsRequest>
Overrides

getQuery()

public RagQuery getQuery()

Required. Single RAG retrieve query.

.google.cloud.aiplatform.v1beta1.RagQuery query = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
RagQuery

The query.

getQueryOrBuilder()

public RagQueryOrBuilder getQueryOrBuilder()

Required. Single RAG retrieve query.

.google.cloud.aiplatform.v1beta1.RagQuery query = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
RagQueryOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getVertexRagStore()

public RetrieveContextsRequest.VertexRagStore getVertexRagStore()

The data source for Vertex RagStore.

.google.cloud.aiplatform.v1beta1.RetrieveContextsRequest.VertexRagStore vertex_rag_store = 2;

Returns
Type Description
RetrieveContextsRequest.VertexRagStore

The vertexRagStore.

getVertexRagStoreOrBuilder()

public RetrieveContextsRequest.VertexRagStoreOrBuilder getVertexRagStoreOrBuilder()

The data source for Vertex RagStore.

.google.cloud.aiplatform.v1beta1.RetrieveContextsRequest.VertexRagStore vertex_rag_store = 2;

Returns
Type Description
RetrieveContextsRequest.VertexRagStoreOrBuilder

hasQuery()

public boolean hasQuery()

Required. Single RAG retrieve query.

.google.cloud.aiplatform.v1beta1.RagQuery query = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the query field is set.

hasVertexRagStore()

public boolean hasVertexRagStore()

The data source for Vertex RagStore.

.google.cloud.aiplatform.v1beta1.RetrieveContextsRequest.VertexRagStore vertex_rag_store = 2;

Returns
Type Description
boolean

Whether the vertexRagStore field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RetrieveContextsRequest.Builder newBuilderForType()
Returns
Type Description
RetrieveContextsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RetrieveContextsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RetrieveContextsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RetrieveContextsRequest.Builder toBuilder()
Returns
Type Description
RetrieveContextsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException