Class RetrieveContextsRequest.Builder (3.56.0)

Version latest

• 3.56.0 (latest)
• 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 static final class RetrieveContextsRequest.Builder extends GeneratedMessageV3.Builder<RetrieveContextsRequest.Builder> implements RetrieveContextsRequestOrBuilder

Request message for VertexRagService.RetrieveContexts.

Protobuf type google.cloud.aiplatform.v1.RetrieveContextsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RetrieveContextsRequest.Builder

Implements

RetrieveContextsRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RetrieveContextsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
RetrieveContextsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public RetrieveContextsRequest build()

Returns
Type	Description
RetrieveContextsRequest

buildPartial()

public RetrieveContextsRequest buildPartial()

Returns
Type	Description
RetrieveContextsRequest

clear()

public RetrieveContextsRequest.Builder clear()

Returns
Type	Description
RetrieveContextsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDataSource()

public RetrieveContextsRequest.Builder clearDataSource()

Returns
Type	Description
RetrieveContextsRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public RetrieveContextsRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
RetrieveContextsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public RetrieveContextsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
RetrieveContextsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearParent()

public RetrieveContextsRequest.Builder clearParent()

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
RetrieveContextsRequest.Builder	This builder for chaining.

clearQuery()

public RetrieveContextsRequest.Builder clearQuery()

Required. Single RAG retrieve query.

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

Returns
Type	Description
RetrieveContextsRequest.Builder

clearVertexRagStore()

public RetrieveContextsRequest.Builder clearVertexRagStore()

The data source for Vertex RagStore.

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

Returns
Type	Description
RetrieveContextsRequest.Builder

clone()

public RetrieveContextsRequest.Builder clone()

Returns
Type	Description
RetrieveContextsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDataSourceCase()

public RetrieveContextsRequest.DataSourceCase getDataSourceCase()

Returns
Type	Description
RetrieveContextsRequest.DataSourceCase

getDefaultInstanceForType()

public RetrieveContextsRequest getDefaultInstanceForType()

Returns
Type	Description
RetrieveContextsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

getQuery()

public RagQuery getQuery()

Required. Single RAG retrieve query.

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

Returns
Type	Description
RagQuery	The query.

getQueryBuilder()

public RagQuery.Builder getQueryBuilder()

Required. Single RAG retrieve query.

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

Returns
Type	Description
RagQuery.Builder

getQueryOrBuilder()

public RagQueryOrBuilder getQueryOrBuilder()

Required. Single RAG retrieve query.

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

Returns
Type	Description
RagQueryOrBuilder

getVertexRagStore()

public RetrieveContextsRequest.VertexRagStore getVertexRagStore()

The data source for Vertex RagStore.

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

Returns
Type	Description
RetrieveContextsRequest.VertexRagStore	The vertexRagStore.

getVertexRagStoreBuilder()

public RetrieveContextsRequest.VertexRagStore.Builder getVertexRagStoreBuilder()

The data source for Vertex RagStore.

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

Returns
Type	Description
RetrieveContextsRequest.VertexRagStore.Builder

getVertexRagStoreOrBuilder()

public RetrieveContextsRequest.VertexRagStoreOrBuilder getVertexRagStoreOrBuilder()

The data source for Vertex RagStore.

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

Returns
Type	Description
RetrieveContextsRequest.VertexRagStoreOrBuilder

hasQuery()

public boolean hasQuery()

Required. Single RAG retrieve query.

.google.cloud.aiplatform.v1.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.v1.RetrieveContextsRequest.VertexRagStore vertex_rag_store = 2;

Returns
Type	Description
boolean	Whether the vertexRagStore field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(RetrieveContextsRequest other)

public RetrieveContextsRequest.Builder mergeFrom(RetrieveContextsRequest other)

Parameter
Name	Description
other	RetrieveContextsRequest

Returns
Type	Description
RetrieveContextsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RetrieveContextsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RetrieveContextsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public RetrieveContextsRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
RetrieveContextsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeQuery(RagQuery value)

public RetrieveContextsRequest.Builder mergeQuery(RagQuery value)

Required. Single RAG retrieve query.

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

Parameter
Name	Description
value	RagQuery

Returns
Type	Description
RetrieveContextsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RetrieveContextsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
RetrieveContextsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeVertexRagStore(RetrieveContextsRequest.VertexRagStore value)

public RetrieveContextsRequest.Builder mergeVertexRagStore(RetrieveContextsRequest.VertexRagStore value)

The data source for Vertex RagStore.

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

Parameter
Name	Description
value	RetrieveContextsRequest.VertexRagStore

Returns
Type	Description
RetrieveContextsRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public RetrieveContextsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
RetrieveContextsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setParent(String value)

public RetrieveContextsRequest.Builder setParent(String value)

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

Parameter
Name	Description
value	String The parent to set.

Returns
Type	Description
RetrieveContextsRequest.Builder	This builder for chaining.

setParentBytes(ByteString value)

public RetrieveContextsRequest.Builder setParentBytes(ByteString value)

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

Parameter
Name	Description
value	ByteString The bytes for parent to set.

Returns
Type	Description
RetrieveContextsRequest.Builder	This builder for chaining.

setQuery(RagQuery value)

public RetrieveContextsRequest.Builder setQuery(RagQuery value)

Required. Single RAG retrieve query.

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

Parameter
Name	Description
value	RagQuery

Returns
Type	Description
RetrieveContextsRequest.Builder

setQuery(RagQuery.Builder builderForValue)

public RetrieveContextsRequest.Builder setQuery(RagQuery.Builder builderForValue)

Required. Single RAG retrieve query.

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

Parameter
Name	Description
builderForValue	RagQuery.Builder

Returns
Type	Description
RetrieveContextsRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RetrieveContextsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
RetrieveContextsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final RetrieveContextsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
RetrieveContextsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setVertexRagStore(RetrieveContextsRequest.VertexRagStore value)

public RetrieveContextsRequest.Builder setVertexRagStore(RetrieveContextsRequest.VertexRagStore value)

The data source for Vertex RagStore.

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

Parameter
Name	Description
value	RetrieveContextsRequest.VertexRagStore

Returns
Type	Description
RetrieveContextsRequest.Builder

setVertexRagStore(RetrieveContextsRequest.VertexRagStore.Builder builderForValue)

public RetrieveContextsRequest.Builder setVertexRagStore(RetrieveContextsRequest.VertexRagStore.Builder builderForValue)

The data source for Vertex RagStore.

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

Parameter
Name	Description
builderForValue	RetrieveContextsRequest.VertexRagStore.Builder

Returns
Type	Description
RetrieveContextsRequest.Builder