com.google.cloud.aiplatform.v1beta1

Class RetrieveContextsRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1beta1.RetrieveContextsRequest

All Implemented Interfaces:

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

public final class RetrieveContextsRequest
extends com.google.protobuf.GeneratedMessageV3
implements RetrieveContextsRequestOrBuilder

 Request message for
 [VertexRagService.RetrieveContexts][google.cloud.aiplatform.v1beta1.VertexRagService.RetrieveContexts].
 

Protobuf type google.cloud.aiplatform.v1beta1.RetrieveContextsRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RetrieveContextsRequest.Builder Request message for [VertexRagService.RetrieveContexts][google.cloud.aiplatform.v1beta1.VertexRagService.RetrieveContexts].
static class	RetrieveContextsRequest.DataSourceCase
static class	RetrieveContextsRequest.VertexRagStore The data source for Vertex RagStore.
static interface	RetrieveContextsRequest.VertexRagStoreOrBuilder

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	QUERY_FIELD_NUMBER
static int	VERTEX_RAG_STORE_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	equals(Object obj)
RetrieveContextsRequest.DataSourceCase	getDataSourceCase()
static RetrieveContextsRequest	getDefaultInstance()
RetrieveContextsRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
com.google.protobuf.Parser<RetrieveContextsRequest>	getParserForType()
RagQuery	getQuery() Required.
RagQueryOrBuilder	getQueryOrBuilder() Required.
int	getSerializedSize()
RetrieveContextsRequest.VertexRagStore	getVertexRagStore() The data source for Vertex RagStore.
RetrieveContextsRequest.VertexRagStoreOrBuilder	getVertexRagStoreOrBuilder() The data source for Vertex RagStore.
int	hashCode()
boolean	hasQuery() Required.
boolean	hasVertexRagStore() The data source for Vertex RagStore.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static RetrieveContextsRequest.Builder	newBuilder()
static RetrieveContextsRequest.Builder	newBuilder(RetrieveContextsRequest prototype)
RetrieveContextsRequest.Builder	newBuilderForType()
protected RetrieveContextsRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static RetrieveContextsRequest	parseDelimitedFrom(InputStream input)
static RetrieveContextsRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RetrieveContextsRequest	parseFrom(byte[] data)
static RetrieveContextsRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RetrieveContextsRequest	parseFrom(ByteBuffer data)
static RetrieveContextsRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RetrieveContextsRequest	parseFrom(com.google.protobuf.ByteString data)
static RetrieveContextsRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RetrieveContextsRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static RetrieveContextsRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RetrieveContextsRequest	parseFrom(InputStream input)
static RetrieveContextsRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RetrieveContextsRequest>	parser()
RetrieveContextsRequest.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, internalGetMapFieldReflection, 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

VERTEX_RAG_STORE_FIELD_NUMBER

public static final int VERTEX_RAG_STORE_FIELD_NUMBER

See Also:

Constant Field Values

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER

See Also:

Constant Field Values

QUERY_FIELD_NUMBER

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getDataSourceCase

public RetrieveContextsRequest.DataSourceCase getDataSourceCase()

Specified by:

getDataSourceCase in interface RetrieveContextsRequestOrBuilder

hasVertexRagStore

public boolean hasVertexRagStore()

 The data source for Vertex RagStore.
 

.google.cloud.aiplatform.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.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 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.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

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

getDefaultInstanceForType

public RetrieveContextsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder