GroundingChunk.RetrievedContext.Builder (proto-google-cloud-aiplatform-v1 3.86.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessage.Builder<GroundingChunk.RetrievedContext.Builder>
    - - com.google.cloud.aiplatform.v1.GroundingChunk.RetrievedContext.Builder

All Implemented Interfaces:

GroundingChunk.RetrievedContextOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

GroundingChunk.RetrievedContext
```
public static final class GroundingChunk.RetrievedContext.Builder
extends com.google.protobuf.GeneratedMessage.Builder<GroundingChunk.RetrievedContext.Builder>
implements GroundingChunk.RetrievedContextOrBuilder
```
```
 Chunk from context retrieved by the retrieval tools.
 
```
Protobuf type google.cloud.aiplatform.v1.GroundingChunk.RetrievedContext

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GroundingChunk.RetrievedContext`	`build()`
`GroundingChunk.RetrievedContext`	`buildPartial()`
`GroundingChunk.RetrievedContext.Builder`	`clear()`
`GroundingChunk.RetrievedContext.Builder`	`clearContextDetails()`
`GroundingChunk.RetrievedContext.Builder`	`clearDocumentName()` Output only.
`GroundingChunk.RetrievedContext.Builder`	`clearRagChunk()` Additional context for the RAG retrieval result.
`GroundingChunk.RetrievedContext.Builder`	`clearText()` Text of the attribution.
`GroundingChunk.RetrievedContext.Builder`	`clearTitle()` Title of the attribution.
`GroundingChunk.RetrievedContext.Builder`	`clearUri()` URI reference of the attribution.
`GroundingChunk.RetrievedContext.ContextDetailsCase`	`getContextDetailsCase()`
`GroundingChunk.RetrievedContext`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getDocumentName()` Output only.
`com.google.protobuf.ByteString`	`getDocumentNameBytes()` Output only.
`RagChunk`	`getRagChunk()` Additional context for the RAG retrieval result.
`RagChunk.Builder`	`getRagChunkBuilder()` Additional context for the RAG retrieval result.
`RagChunkOrBuilder`	`getRagChunkOrBuilder()` Additional context for the RAG retrieval result.
`String`	`getText()` Text of the attribution.
`com.google.protobuf.ByteString`	`getTextBytes()` Text of the attribution.
`String`	`getTitle()` Title of the attribution.
`com.google.protobuf.ByteString`	`getTitleBytes()` Title of the attribution.
`String`	`getUri()` URI reference of the attribution.
`com.google.protobuf.ByteString`	`getUriBytes()` URI reference of the attribution.
`boolean`	`hasDocumentName()` Output only.
`boolean`	`hasRagChunk()` Additional context for the RAG retrieval result.
`boolean`	`hasText()` Text of the attribution.
`boolean`	`hasTitle()` Title of the attribution.
`boolean`	`hasUri()` URI reference of the attribution.
`protected com.google.protobuf.GeneratedMessage.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`GroundingChunk.RetrievedContext.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`GroundingChunk.RetrievedContext.Builder`	`mergeFrom(GroundingChunk.RetrievedContext other)`
`GroundingChunk.RetrievedContext.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`GroundingChunk.RetrievedContext.Builder`	`mergeRagChunk(RagChunk value)` Additional context for the RAG retrieval result.
`GroundingChunk.RetrievedContext.Builder`	`setDocumentName(String value)` Output only.
`GroundingChunk.RetrievedContext.Builder`	`setDocumentNameBytes(com.google.protobuf.ByteString value)` Output only.
`GroundingChunk.RetrievedContext.Builder`	`setRagChunk(RagChunk.Builder builderForValue)` Additional context for the RAG retrieval result.
`GroundingChunk.RetrievedContext.Builder`	`setRagChunk(RagChunk value)` Additional context for the RAG retrieval result.
`GroundingChunk.RetrievedContext.Builder`	`setText(String value)` Text of the attribution.
`GroundingChunk.RetrievedContext.Builder`	`setTextBytes(com.google.protobuf.ByteString value)` Text of the attribution.
`GroundingChunk.RetrievedContext.Builder`	`setTitle(String value)` Title of the attribution.
`GroundingChunk.RetrievedContext.Builder`	`setTitleBytes(com.google.protobuf.ByteString value)` Title of the attribution.
`GroundingChunk.RetrievedContext.Builder`	`setUri(String value)` URI reference of the attribution.
`GroundingChunk.RetrievedContext.Builder`	`setUriBytes(com.google.protobuf.ByteString value)` URI reference of the attribution.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, 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, mergeFrom, 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

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

- Method Detail
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<GroundingChunk.RetrievedContext.Builder>
  - clear
```
public GroundingChunk.RetrievedContext.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.GeneratedMessage.Builder<GroundingChunk.RetrievedContext.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.GeneratedMessage.Builder<GroundingChunk.RetrievedContext.Builder>
  - getDefaultInstanceForType
```
public GroundingChunk.RetrievedContext getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public GroundingChunk.RetrievedContext build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public GroundingChunk.RetrievedContext buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - mergeFrom
```
public GroundingChunk.RetrievedContext.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<GroundingChunk.RetrievedContext.Builder>
  - mergeFrom
```
public GroundingChunk.RetrievedContext.Builder mergeFrom(GroundingChunk.RetrievedContext other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessage.Builder<GroundingChunk.RetrievedContext.Builder>
  - mergeFrom
```
public GroundingChunk.RetrievedContext.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<GroundingChunk.RetrievedContext.Builder>
    
    Throws:
    
    IOException
  - getContextDetailsCase
```
public GroundingChunk.RetrievedContext.ContextDetailsCase getContextDetailsCase()
```
    Specified by:
    
    getContextDetailsCase in interface GroundingChunk.RetrievedContextOrBuilder
  - clearContextDetails
```
public GroundingChunk.RetrievedContext.Builder clearContextDetails()
```
  - hasRagChunk
```
public boolean hasRagChunk()
```
```
 Additional context for the RAG retrieval result. This is only populated
 when using the RAG retrieval tool.
 
```
    .google.cloud.aiplatform.v1.RagChunk rag_chunk = 4;
    Specified by:
    
    hasRagChunk in interface GroundingChunk.RetrievedContextOrBuilder
    
    Returns:
    
    Whether the ragChunk field is set.
  - getRagChunk
```
public RagChunk getRagChunk()
```
```
 Additional context for the RAG retrieval result. This is only populated
 when using the RAG retrieval tool.
 
```
    .google.cloud.aiplatform.v1.RagChunk rag_chunk = 4;
    Specified by:
    
    getRagChunk in interface GroundingChunk.RetrievedContextOrBuilder
    
    Returns:
    
    The ragChunk.
  - setRagChunk
```
public GroundingChunk.RetrievedContext.Builder setRagChunk(RagChunk value)
```
```
 Additional context for the RAG retrieval result. This is only populated
 when using the RAG retrieval tool.
 
```
    .google.cloud.aiplatform.v1.RagChunk rag_chunk = 4;
  - setRagChunk
```
public GroundingChunk.RetrievedContext.Builder setRagChunk(RagChunk.Builder builderForValue)
```
```
 Additional context for the RAG retrieval result. This is only populated
 when using the RAG retrieval tool.
 
```
    .google.cloud.aiplatform.v1.RagChunk rag_chunk = 4;
  - mergeRagChunk
```
public GroundingChunk.RetrievedContext.Builder mergeRagChunk(RagChunk value)
```
```
 Additional context for the RAG retrieval result. This is only populated
 when using the RAG retrieval tool.
 
```
    .google.cloud.aiplatform.v1.RagChunk rag_chunk = 4;
  - clearRagChunk
```
public GroundingChunk.RetrievedContext.Builder clearRagChunk()
```
```
 Additional context for the RAG retrieval result. This is only populated
 when using the RAG retrieval tool.
 
```
    .google.cloud.aiplatform.v1.RagChunk rag_chunk = 4;
  - getRagChunkBuilder
```
public RagChunk.Builder getRagChunkBuilder()
```
```
 Additional context for the RAG retrieval result. This is only populated
 when using the RAG retrieval tool.
 
```
    .google.cloud.aiplatform.v1.RagChunk rag_chunk = 4;
  - getRagChunkOrBuilder
```
public RagChunkOrBuilder getRagChunkOrBuilder()
```
```
 Additional context for the RAG retrieval result. This is only populated
 when using the RAG retrieval tool.
 
```
    .google.cloud.aiplatform.v1.RagChunk rag_chunk = 4;
    Specified by:
    
    getRagChunkOrBuilder in interface GroundingChunk.RetrievedContextOrBuilder
  - hasUri
```
public boolean hasUri()
```
```
 URI reference of the attribution.
 
```
    optional string uri = 1;
    Specified by:
    
    hasUri in interface GroundingChunk.RetrievedContextOrBuilder
    
    Returns:
    
    Whether the uri field is set.
  - getUri
```
public String getUri()
```
```
 URI reference of the attribution.
 
```
    optional string uri = 1;
    Specified by:
    
    getUri in interface GroundingChunk.RetrievedContextOrBuilder
    
    Returns:
    
    The uri.
  - getUriBytes
```
public com.google.protobuf.ByteString getUriBytes()
```
```
 URI reference of the attribution.
 
```
    optional string uri = 1;
    Specified by:
    
    getUriBytes in interface GroundingChunk.RetrievedContextOrBuilder
    
    Returns:
    
    The bytes for uri.
  - setUri
```
public GroundingChunk.RetrievedContext.Builder setUri(String value)
```
```
 URI reference of the attribution.
 
```
    optional string uri = 1;
    Parameters:
    
    value - The uri to set.
    
    Returns:
    
    This builder for chaining.
  - clearUri
```
public GroundingChunk.RetrievedContext.Builder clearUri()
```
```
 URI reference of the attribution.
 
```
    optional string uri = 1;
    Returns:
    
    This builder for chaining.
  - setUriBytes
```
public GroundingChunk.RetrievedContext.Builder setUriBytes(com.google.protobuf.ByteString value)
```
```
 URI reference of the attribution.
 
```
    optional string uri = 1;
    Parameters:
    
    value - The bytes for uri to set.
    
    Returns:
    
    This builder for chaining.
  - hasTitle
```
public boolean hasTitle()
```
```
 Title of the attribution.
 
```
    optional string title = 2;
    Specified by:
    
    hasTitle in interface GroundingChunk.RetrievedContextOrBuilder
    
    Returns:
    
    Whether the title field is set.
  - getTitle
```
public String getTitle()
```
```
 Title of the attribution.
 
```
    optional string title = 2;
    Specified by:
    
    getTitle in interface GroundingChunk.RetrievedContextOrBuilder
    
    Returns:
    
    The title.
  - getTitleBytes
```
public com.google.protobuf.ByteString getTitleBytes()
```
```
 Title of the attribution.
 
```
    optional string title = 2;
    Specified by:
    
    getTitleBytes in interface GroundingChunk.RetrievedContextOrBuilder
    
    Returns:
    
    The bytes for title.
  - setTitle
```
public GroundingChunk.RetrievedContext.Builder setTitle(String value)
```
```
 Title of the attribution.
 
```
    optional string title = 2;
    Parameters:
    
    value - The title to set.
    
    Returns:
    
    This builder for chaining.
  - clearTitle
```
public GroundingChunk.RetrievedContext.Builder clearTitle()
```
```
 Title of the attribution.
 
```
    optional string title = 2;
    Returns:
    
    This builder for chaining.
  - setTitleBytes
```
public GroundingChunk.RetrievedContext.Builder setTitleBytes(com.google.protobuf.ByteString value)
```
```
 Title of the attribution.
 
```
    optional string title = 2;
    Parameters:
    
    value - The bytes for title to set.
    
    Returns:
    
    This builder for chaining.
  - hasText
```
public boolean hasText()
```
```
 Text of the attribution.
 
```
    optional string text = 3;
    Specified by:
    
    hasText in interface GroundingChunk.RetrievedContextOrBuilder
    
    Returns:
    
    Whether the text field is set.
  - getText
```
public String getText()
```
```
 Text of the attribution.
 
```
    optional string text = 3;
    Specified by:
    
    getText in interface GroundingChunk.RetrievedContextOrBuilder
    
    Returns:
    
    The text.
  - getTextBytes
```
public com.google.protobuf.ByteString getTextBytes()
```
```
 Text of the attribution.
 
```
    optional string text = 3;
    Specified by:
    
    getTextBytes in interface GroundingChunk.RetrievedContextOrBuilder
    
    Returns:
    
    The bytes for text.
  - setText
```
public GroundingChunk.RetrievedContext.Builder setText(String value)
```
```
 Text of the attribution.
 
```
    optional string text = 3;
    Parameters:
    
    value - The text to set.
    
    Returns:
    
    This builder for chaining.
  - clearText
```
public GroundingChunk.RetrievedContext.Builder clearText()
```
```
 Text of the attribution.
 
```
    optional string text = 3;
    Returns:
    
    This builder for chaining.
  - setTextBytes
```
public GroundingChunk.RetrievedContext.Builder setTextBytes(com.google.protobuf.ByteString value)
```
```
 Text of the attribution.
 
```
    optional string text = 3;
    Parameters:
    
    value - The bytes for text to set.
    
    Returns:
    
    This builder for chaining.
  - hasDocumentName
```
public boolean hasDocumentName()
```
```
 Output only. The full document name for the referenced Vertex AI Search
 document.
 
```
    optional string document_name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    hasDocumentName in interface GroundingChunk.RetrievedContextOrBuilder
    
    Returns:
    
    Whether the documentName field is set.
  - getDocumentName
```
public String getDocumentName()
```
```
 Output only. The full document name for the referenced Vertex AI Search
 document.
 
```
    optional string document_name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    getDocumentName in interface GroundingChunk.RetrievedContextOrBuilder
    
    Returns:
    
    The documentName.
  - getDocumentNameBytes
```
public com.google.protobuf.ByteString getDocumentNameBytes()
```
```
 Output only. The full document name for the referenced Vertex AI Search
 document.
 
```
    optional string document_name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    getDocumentNameBytes in interface GroundingChunk.RetrievedContextOrBuilder
    
    Returns:
    
    The bytes for documentName.
  - setDocumentName
```
public GroundingChunk.RetrievedContext.Builder setDocumentName(String value)
```
```
 Output only. The full document name for the referenced Vertex AI Search
 document.
 
```
    optional string document_name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Parameters:
    
    value - The documentName to set.
    
    Returns:
    
    This builder for chaining.
  - clearDocumentName
```
public GroundingChunk.RetrievedContext.Builder clearDocumentName()
```
```
 Output only. The full document name for the referenced Vertex AI Search
 document.
 
```
    optional string document_name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Returns:
    
    This builder for chaining.
  - setDocumentNameBytes
```
public GroundingChunk.RetrievedContext.Builder setDocumentNameBytes(com.google.protobuf.ByteString value)
```
```
 Output only. The full document name for the referenced Vertex AI Search
 document.
 
```
    optional string document_name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Parameters:
    
    value - The bytes for documentName to set.
    
    Returns:
    
    This builder for chaining.

Class GroundingChunk.RetrievedContext.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessage.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

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

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

mergeFrom

mergeFrom

isInitialized

mergeFrom

getContextDetailsCase

clearContextDetails

hasRagChunk

getRagChunk

setRagChunk

setRagChunk

mergeRagChunk

clearRagChunk

getRagChunkBuilder

getRagChunkOrBuilder

hasUri

getUri

getUriBytes

setUri

clearUri

setUriBytes

hasTitle

getTitle

getTitleBytes

setTitle

clearTitle

setTitleBytes

hasText

getText

getTextBytes

setText

clearText

setTextBytes

hasDocumentName

getDocumentName

getDocumentNameBytes

setDocumentName

clearDocumentName

setDocumentNameBytes