public static final class RetrieveContextsRequest.Builder extends GeneratedMessage.Builder<RetrieveContextsRequest.Builder> implements RetrieveContextsRequestOrBuilderRequest message for VertexRagService.RetrieveContexts.
Protobuf type google.cloud.aiplatform.v1beta1.RetrieveContextsRequest
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > RetrieveContextsRequest.BuilderImplements
RetrieveContextsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
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 |
|
clearDataSource()
public RetrieveContextsRequest.Builder clearDataSource()| Returns | |
|---|---|
| Type | Description |
RetrieveContextsRequest.Builder |
|
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 |
|
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 |
|
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 GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public RetrieveContextsRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
RetrieveContextsRequest.Builder |
|
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 |
|
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 |
|
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 |
StringThe 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 |
ByteStringThe 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 |
|
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 |
|