GoogleCloudDiscoveryengineV1Chunk (Discovery Engine API v1-rev20260427-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.discoveryengine.v1.model.GoogleCloudDiscoveryengineV1Chunk

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleCloudDiscoveryengineV1Chunk
extends com.google.api.client.json.GenericJson
```
Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Discovery Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

GoogleCloudDiscoveryengineV1Chunk()

Constructors
Constructor and Description
`GoogleCloudDiscoveryengineV1Chunk()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleCloudDiscoveryengineV1Chunk`	`clone()`
`List<String>`	`getAnnotationContents()` Output only.
`List<GoogleCloudDiscoveryengineV1ChunkAnnotationMetadata>`	`getAnnotationMetadata()` Output only.
`GoogleCloudDiscoveryengineV1ChunkChunkMetadata`	`getChunkMetadata()` Output only.
`String`	`getContent()` Content is a string from a document (parsed content).
`List<String>`	`getDataUrls()` Output only.
`Map<String,Object>`	`getDerivedStructData()` Output only.
`GoogleCloudDiscoveryengineV1ChunkDocumentMetadata`	`getDocumentMetadata()` Metadata of the document from the current chunk.
`String`	`getId()` Unique chunk ID of the current chunk.
`String`	`getName()` The full resource name of the chunk.
`GoogleCloudDiscoveryengineV1ChunkPageSpan`	`getPageSpan()` Page span of the chunk.
`Double`	`getRelevanceScore()` Output only.
`GoogleCloudDiscoveryengineV1Chunk`	`set(String fieldName, Object value)`
`GoogleCloudDiscoveryengineV1Chunk`	`setAnnotationContents(List<String> annotationContents)` Output only.
`GoogleCloudDiscoveryengineV1Chunk`	`setAnnotationMetadata(List<GoogleCloudDiscoveryengineV1ChunkAnnotationMetadata> annotationMetadata)` Output only.
`GoogleCloudDiscoveryengineV1Chunk`	`setChunkMetadata(GoogleCloudDiscoveryengineV1ChunkChunkMetadata chunkMetadata)` Output only.
`GoogleCloudDiscoveryengineV1Chunk`	`setContent(String content)` Content is a string from a document (parsed content).
`GoogleCloudDiscoveryengineV1Chunk`	`setDataUrls(List<String> dataUrls)` Output only.
`GoogleCloudDiscoveryengineV1Chunk`	`setDerivedStructData(Map<String,Object> derivedStructData)` Output only.
`GoogleCloudDiscoveryengineV1Chunk`	`setDocumentMetadata(GoogleCloudDiscoveryengineV1ChunkDocumentMetadata documentMetadata)` Metadata of the document from the current chunk.
`GoogleCloudDiscoveryengineV1Chunk`	`setId(String id)` Unique chunk ID of the current chunk.
`GoogleCloudDiscoveryengineV1Chunk`	`setName(String name)` The full resource name of the chunk.
`GoogleCloudDiscoveryengineV1Chunk`	`setPageSpan(GoogleCloudDiscoveryengineV1ChunkPageSpan pageSpan)` Page span of the chunk.
`GoogleCloudDiscoveryengineV1Chunk`	`setRelevanceScore(Double relevanceScore)` Output only.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

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

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - GoogleCloudDiscoveryengineV1Chunk
```
public GoogleCloudDiscoveryengineV1Chunk()
```
- Method Detail
  - getAnnotationContents
```
public List<String> getAnnotationContents()
```
    Output only. Annotation contents if the current chunk contains annotations.
    
    Returns:
    
    value or null for none
  - setAnnotationContents
```
public GoogleCloudDiscoveryengineV1Chunk setAnnotationContents(List<String> annotationContents)
```
    Output only. Annotation contents if the current chunk contains annotations.
    
    Parameters:
    
    annotationContents - annotationContents or null for none
  - getAnnotationMetadata
```
public List<GoogleCloudDiscoveryengineV1ChunkAnnotationMetadata> getAnnotationMetadata()
```
    Output only. The annotation metadata includes structured content in the current chunk.
    
    Returns:
    
    value or null for none
  - setAnnotationMetadata
```
public GoogleCloudDiscoveryengineV1Chunk setAnnotationMetadata(List<GoogleCloudDiscoveryengineV1ChunkAnnotationMetadata> annotationMetadata)
```
    Output only. The annotation metadata includes structured content in the current chunk.
    
    Parameters:
    
    annotationMetadata - annotationMetadata or null for none
  - getChunkMetadata
```
public GoogleCloudDiscoveryengineV1ChunkChunkMetadata getChunkMetadata()
```
    Output only. Metadata of the current chunk.
    
    Returns:
    
    value or null for none
  - setChunkMetadata
```
public GoogleCloudDiscoveryengineV1Chunk setChunkMetadata(GoogleCloudDiscoveryengineV1ChunkChunkMetadata chunkMetadata)
```
    Output only. Metadata of the current chunk.
    
    Parameters:
    
    chunkMetadata - chunkMetadata or null for none
  - getContent
```
public String getContent()
```
    Content is a string from a document (parsed content).
    
    Returns:
    
    value or null for none
  - setContent
```
public GoogleCloudDiscoveryengineV1Chunk setContent(String content)
```
    Content is a string from a document (parsed content).
    
    Parameters:
    
    content - content or null for none
  - getDataUrls
```
public List<String> getDataUrls()
```
    Output only. Image Data URLs if the current chunk contains images. Data URLs are composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:,
    
    Returns:
    
    value or null for none
  - setDataUrls
```
public GoogleCloudDiscoveryengineV1Chunk setDataUrls(List<String> dataUrls)
```
    Output only. Image Data URLs if the current chunk contains images. Data URLs are composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:,
    
    Parameters:
    
    dataUrls - dataUrls or null for none
  - getDerivedStructData
```
public Map<String,Object> getDerivedStructData()
```
    Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
    
    Returns:
    
    value or null for none
  - setDerivedStructData
```
public GoogleCloudDiscoveryengineV1Chunk setDerivedStructData(Map<String,Object> derivedStructData)
```
    Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
    
    Parameters:
    
    derivedStructData - derivedStructData or null for none
  - getDocumentMetadata
```
public GoogleCloudDiscoveryengineV1ChunkDocumentMetadata getDocumentMetadata()
```
    Metadata of the document from the current chunk.
    
    Returns:
    
    value or null for none
  - setDocumentMetadata
```
public GoogleCloudDiscoveryengineV1Chunk setDocumentMetadata(GoogleCloudDiscoveryengineV1ChunkDocumentMetadata documentMetadata)
```
    Metadata of the document from the current chunk.
    
    Parameters:
    
    documentMetadata - documentMetadata or null for none
  - getId
```
public String getId()
```
    Unique chunk ID of the current chunk.
    
    Returns:
    
    value or null for none
  - setId
```
public GoogleCloudDiscoveryengineV1Chunk setId(String id)
```
    Unique chunk ID of the current chunk.
    
    Parameters:
    
    id - id or null for none
  - getName
```
public String getName()
```
    The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collectio ns/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk _id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
    
    Returns:
    
    value or null for none
  - setName
```
public GoogleCloudDiscoveryengineV1Chunk setName(String name)
```
    The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collectio ns/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk _id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
    
    Parameters:
    
    name - name or null for none
  - getPageSpan
```
public GoogleCloudDiscoveryengineV1ChunkPageSpan getPageSpan()
```
    Page span of the chunk.
    
    Returns:
    
    value or null for none
  - setPageSpan
```
public GoogleCloudDiscoveryengineV1Chunk setPageSpan(GoogleCloudDiscoveryengineV1ChunkPageSpan pageSpan)
```
    Page span of the chunk.
    
    Parameters:
    
    pageSpan - pageSpan or null for none
  - getRelevanceScore
```
public Double getRelevanceScore()
```
    Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchResponse.
    
    Returns:
    
    value or null for none
  - setRelevanceScore
```
public GoogleCloudDiscoveryengineV1Chunk setRelevanceScore(Double relevanceScore)
```
    Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchResponse.
    
    Parameters:
    
    relevanceScore - relevanceScore or null for none
  - set
```
public GoogleCloudDiscoveryengineV1Chunk set(String fieldName,
                                             Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleCloudDiscoveryengineV1Chunk clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleCloudDiscoveryengineV1Chunk

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

GoogleCloudDiscoveryengineV1Chunk

Method Detail

getAnnotationContents

setAnnotationContents

getAnnotationMetadata

setAnnotationMetadata

getChunkMetadata

setChunkMetadata

getContent

setContent

getDataUrls

setDataUrls

getDerivedStructData

setDerivedStructData

getDocumentMetadata

setDocumentMetadata

getId

setId

getName

setName

getPageSpan

setPageSpan

getRelevanceScore

setRelevanceScore

set

clone