Class RetrieveContextsRequest.Builder (3.47.0)

public static final class RetrieveContextsRequest.Builder extends GeneratedMessageV3.Builder<RetrieveContextsRequest.Builder> implements RetrieveContextsRequestOrBuilder

Request message for VertexRagService.RetrieveContexts.

Protobuf type google.cloud.aiplatform.v1beta1.RetrieveContextsRequest

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

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

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

clearOneof(Descriptors.OneofDescriptor oneof)

public RetrieveContextsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RetrieveContextsRequest.Builder
Overrides

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.v1beta1.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.v1beta1.RetrieveContextsRequest.VertexRagStore vertex_rag_store = 2;

Returns
Type Description
RetrieveContextsRequest.Builder

clone()

public RetrieveContextsRequest.Builder clone()
Returns
Type Description
RetrieveContextsRequest.Builder
Overrides

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

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

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RetrieveContextsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RetrieveContextsRequest.Builder
Overrides

mergeQuery(RagQuery value)

public RetrieveContextsRequest.Builder mergeQuery(RagQuery value)

Required. Single RAG retrieve query.

.google.cloud.aiplatform.v1beta1.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

mergeVertexRagStore(RetrieveContextsRequest.VertexRagStore value)

public RetrieveContextsRequest.Builder mergeVertexRagStore(RetrieveContextsRequest.VertexRagStore value)

The data source for Vertex RagStore.

.google.cloud.aiplatform.v1beta1.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

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

setUnknownFields(UnknownFieldSet unknownFields)

public final RetrieveContextsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RetrieveContextsRequest.Builder
Overrides

setVertexRagStore(RetrieveContextsRequest.VertexRagStore value)

public RetrieveContextsRequest.Builder setVertexRagStore(RetrieveContextsRequest.VertexRagStore value)

The data source for Vertex RagStore.

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

Parameter
Name Description
builderForValue RetrieveContextsRequest.VertexRagStore.Builder
Returns
Type Description
RetrieveContextsRequest.Builder