RetrieveContextsRequest.Builder (proto-google-cloud-aiplatform-v1beta1 0.62.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<RetrieveContextsRequest.Builder>
    - - com.google.cloud.aiplatform.v1beta1.RetrieveContextsRequest.Builder

All Implemented Interfaces:

RetrieveContextsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

RetrieveContextsRequest
```
public static final class RetrieveContextsRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<RetrieveContextsRequest.Builder>
implements RetrieveContextsRequestOrBuilder
```
```
 Request message for
 [VertexRagService.RetrieveContexts][google.cloud.aiplatform.v1beta1.VertexRagService.RetrieveContexts].
 
```
Protobuf type google.cloud.aiplatform.v1beta1.RetrieveContextsRequest

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RetrieveContextsRequest.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`RetrieveContextsRequest`	`build()`
`RetrieveContextsRequest`	`buildPartial()`
`RetrieveContextsRequest.Builder`	`clear()`
`RetrieveContextsRequest.Builder`	`clearDataSource()`
`RetrieveContextsRequest.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`RetrieveContextsRequest.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`RetrieveContextsRequest.Builder`	`clearParent()` Required.
`RetrieveContextsRequest.Builder`	`clearQuery()` Required.
`RetrieveContextsRequest.Builder`	`clearVertexRagStore()` The data source for Vertex RagStore.
`RetrieveContextsRequest.Builder`	`clone()`
`RetrieveContextsRequest.DataSourceCase`	`getDataSourceCase()`
`RetrieveContextsRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getParent()` Required.
`com.google.protobuf.ByteString`	`getParentBytes()` Required.
`RagQuery`	`getQuery()` Required.
`RagQuery.Builder`	`getQueryBuilder()` Required.
`RagQueryOrBuilder`	`getQueryOrBuilder()` Required.
`RetrieveContextsRequest.VertexRagStore`	`getVertexRagStore()` The data source for Vertex RagStore.
`RetrieveContextsRequest.VertexRagStore.Builder`	`getVertexRagStoreBuilder()` The data source for Vertex RagStore.
`RetrieveContextsRequest.VertexRagStoreOrBuilder`	`getVertexRagStoreOrBuilder()` The data source for Vertex RagStore.
`boolean`	`hasQuery()` Required.
`boolean`	`hasVertexRagStore()` The data source for Vertex RagStore.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`RetrieveContextsRequest.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`RetrieveContextsRequest.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`RetrieveContextsRequest.Builder`	`mergeFrom(RetrieveContextsRequest other)`
`RetrieveContextsRequest.Builder`	`mergeQuery(RagQuery value)` Required.
`RetrieveContextsRequest.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`RetrieveContextsRequest.Builder`	`mergeVertexRagStore(RetrieveContextsRequest.VertexRagStore value)` The data source for Vertex RagStore.
`RetrieveContextsRequest.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`RetrieveContextsRequest.Builder`	`setParent(String value)` Required.
`RetrieveContextsRequest.Builder`	`setParentBytes(com.google.protobuf.ByteString value)` Required.
`RetrieveContextsRequest.Builder`	`setQuery(RagQuery.Builder builderForValue)` Required.
`RetrieveContextsRequest.Builder`	`setQuery(RagQuery value)` Required.
`RetrieveContextsRequest.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`RetrieveContextsRequest.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`RetrieveContextsRequest.Builder`	`setVertexRagStore(RetrieveContextsRequest.VertexRagStore.Builder builderForValue)` The data source for Vertex RagStore.
`RetrieveContextsRequest.Builder`	`setVertexRagStore(RetrieveContextsRequest.VertexRagStore value)` The data source for Vertex RagStore.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

- Method Detail
  - 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.Builder<RetrieveContextsRequest.Builder>
  - clear
```
public RetrieveContextsRequest.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessageV3.Builder<RetrieveContextsRequest.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RetrieveContextsRequest.Builder>
  - getDefaultInstanceForType
```
public RetrieveContextsRequest getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public RetrieveContextsRequest build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public RetrieveContextsRequest buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public RetrieveContextsRequest.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<RetrieveContextsRequest.Builder>
  - setField
```
public RetrieveContextsRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<RetrieveContextsRequest.Builder>
  - clearField
```
public RetrieveContextsRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<RetrieveContextsRequest.Builder>
  - clearOneof
```
public RetrieveContextsRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RetrieveContextsRequest.Builder>
  - setRepeatedField
```
public RetrieveContextsRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                        int index,
                                                        Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RetrieveContextsRequest.Builder>
  - addRepeatedField
```
public RetrieveContextsRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                        Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RetrieveContextsRequest.Builder>
  - mergeFrom
```
public RetrieveContextsRequest.Builder mergeFrom(com.google.protobuf.Message other)
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RetrieveContextsRequest.Builder>
  - mergeFrom
```
public RetrieveContextsRequest.Builder mergeFrom(RetrieveContextsRequest other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RetrieveContextsRequest.Builder>
  - mergeFrom
```
public RetrieveContextsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RetrieveContextsRequest.Builder>
    
    Throws:
    
    IOException
  - getDataSourceCase
```
public RetrieveContextsRequest.DataSourceCase getDataSourceCase()
```
    Specified by:
    
    getDataSourceCase in interface RetrieveContextsRequestOrBuilder
  - clearDataSource
```
public RetrieveContextsRequest.Builder clearDataSource()
```
  - 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.
  - setVertexRagStore
```
public RetrieveContextsRequest.Builder setVertexRagStore(RetrieveContextsRequest.VertexRagStore value)
```
```
 The data source for Vertex RagStore.
 
```
    .google.cloud.aiplatform.v1beta1.RetrieveContextsRequest.VertexRagStore vertex_rag_store = 2;
  - setVertexRagStore
```
public RetrieveContextsRequest.Builder setVertexRagStore(RetrieveContextsRequest.VertexRagStore.Builder builderForValue)
```
```
 The data source for Vertex RagStore.
 
```
    .google.cloud.aiplatform.v1beta1.RetrieveContextsRequest.VertexRagStore vertex_rag_store = 2;
  - mergeVertexRagStore
```
public RetrieveContextsRequest.Builder mergeVertexRagStore(RetrieveContextsRequest.VertexRagStore value)
```
```
 The data source for Vertex RagStore.
 
```
    .google.cloud.aiplatform.v1beta1.RetrieveContextsRequest.VertexRagStore vertex_rag_store = 2;
  - clearVertexRagStore
```
public RetrieveContextsRequest.Builder clearVertexRagStore()
```
```
 The data source for Vertex RagStore.
 
```
    .google.cloud.aiplatform.v1beta1.RetrieveContextsRequest.VertexRagStore vertex_rag_store = 2;
  - getVertexRagStoreBuilder
```
public RetrieveContextsRequest.VertexRagStore.Builder getVertexRagStoreBuilder()
```
```
 The data source for Vertex RagStore.
 
```
    .google.cloud.aiplatform.v1beta1.RetrieveContextsRequest.VertexRagStore vertex_rag_store = 2;
  - 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.
  - setParent
```
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) = { ... }
    Parameters:
    
    value - The parent to set.
    
    Returns:
    
    This builder for chaining.
  - 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:
    
    This builder for chaining.
  - setParentBytes
```
public RetrieveContextsRequest.Builder setParentBytes(com.google.protobuf.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) = { ... }
    Parameters:
    
    value - The bytes for parent to set.
    
    Returns:
    
    This builder for chaining.
  - 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.
  - setQuery
```
public RetrieveContextsRequest.Builder setQuery(RagQuery value)
```
```
 Required. Single RAG retrieve query.
 
```
    .google.cloud.aiplatform.v1beta1.RagQuery query = 3 [(.google.api.field_behavior) = REQUIRED];
  - setQuery
```
public RetrieveContextsRequest.Builder setQuery(RagQuery.Builder builderForValue)
```
```
 Required. Single RAG retrieve query.
 
```
    .google.cloud.aiplatform.v1beta1.RagQuery query = 3 [(.google.api.field_behavior) = REQUIRED];
  - mergeQuery
```
public RetrieveContextsRequest.Builder mergeQuery(RagQuery value)
```
```
 Required. Single RAG retrieve query.
 
```
    .google.cloud.aiplatform.v1beta1.RagQuery query = 3 [(.google.api.field_behavior) = REQUIRED];
  - clearQuery
```
public RetrieveContextsRequest.Builder clearQuery()
```
```
 Required. Single RAG retrieve query.
 
```
    .google.cloud.aiplatform.v1beta1.RagQuery query = 3 [(.google.api.field_behavior) = REQUIRED];
  - getQueryBuilder
```
public RagQuery.Builder getQueryBuilder()
```
```
 Required. Single RAG retrieve query.
 
```
    .google.cloud.aiplatform.v1beta1.RagQuery query = 3 [(.google.api.field_behavior) = REQUIRED];
  - 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
  - setUnknownFields
```
public final RetrieveContextsRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RetrieveContextsRequest.Builder>
  - mergeUnknownFields
```
public final RetrieveContextsRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RetrieveContextsRequest.Builder>

Class RetrieveContextsRequest.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getDataSourceCase

clearDataSource

hasVertexRagStore

getVertexRagStore

setVertexRagStore

setVertexRagStore

mergeVertexRagStore

clearVertexRagStore

getVertexRagStoreBuilder

getVertexRagStoreOrBuilder

getParent

getParentBytes

setParent

clearParent

setParentBytes

hasQuery

getQuery

setQuery

setQuery

mergeQuery

clearQuery

getQueryBuilder

getQueryOrBuilder

setUnknownFields

mergeUnknownFields