GoogleCloudDiscoveryengineV1Document (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.GoogleCloudDiscoveryengineV1Document

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleCloudDiscoveryengineV1Document
extends com.google.api.client.json.GenericJson
```
Document captures all raw metadata information of items to be recommended or searched.
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

GoogleCloudDiscoveryengineV1Document()

Constructors
Constructor and Description
`GoogleCloudDiscoveryengineV1Document()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleCloudDiscoveryengineV1Document`	`clone()`
`GoogleCloudDiscoveryengineV1DocumentAclInfo`	`getAclInfo()` Access control information for the document.
`GoogleCloudDiscoveryengineV1DocumentContent`	`getContent()` The unstructured data linked to this document.
`Map<String,Object>`	`getDerivedStructData()` Output only.
`String`	`getId()` Immutable.
`GoogleCloudDiscoveryengineV1DocumentIndexStatus`	`getIndexStatus()` Output only.
`String`	`getIndexTime()` Output only.
`String`	`getJsonData()` The JSON string representation of the document.
`String`	`getName()` Immutable.
`String`	`getParentDocumentId()` The identifier of the parent document.
`String`	`getSchemaId()` The identifier of the schema located in the same data store.
`Map<String,Object>`	`getStructData()` The structured JSON data for the document.
`GoogleCloudDiscoveryengineV1Document`	`set(String fieldName, Object value)`
`GoogleCloudDiscoveryengineV1Document`	`setAclInfo(GoogleCloudDiscoveryengineV1DocumentAclInfo aclInfo)` Access control information for the document.
`GoogleCloudDiscoveryengineV1Document`	`setContent(GoogleCloudDiscoveryengineV1DocumentContent content)` The unstructured data linked to this document.
`GoogleCloudDiscoveryengineV1Document`	`setDerivedStructData(Map<String,Object> derivedStructData)` Output only.
`GoogleCloudDiscoveryengineV1Document`	`setId(String id)` Immutable.
`GoogleCloudDiscoveryengineV1Document`	`setIndexStatus(GoogleCloudDiscoveryengineV1DocumentIndexStatus indexStatus)` Output only.
`GoogleCloudDiscoveryengineV1Document`	`setIndexTime(String indexTime)` Output only.
`GoogleCloudDiscoveryengineV1Document`	`setJsonData(String jsonData)` The JSON string representation of the document.
`GoogleCloudDiscoveryengineV1Document`	`setName(String name)` Immutable.
`GoogleCloudDiscoveryengineV1Document`	`setParentDocumentId(String parentDocumentId)` The identifier of the parent document.
`GoogleCloudDiscoveryengineV1Document`	`setSchemaId(String schemaId)` The identifier of the schema located in the same data store.
`GoogleCloudDiscoveryengineV1Document`	`setStructData(Map<String,Object> structData)` The structured JSON data for the document.

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
  - GoogleCloudDiscoveryengineV1Document
```
public GoogleCloudDiscoveryengineV1Document()
```
- Method Detail
  - getAclInfo
```
public GoogleCloudDiscoveryengineV1DocumentAclInfo getAclInfo()
```
    Access control information for the document.
    
    Returns:
    
    value or null for none
  - setAclInfo
```
public GoogleCloudDiscoveryengineV1Document setAclInfo(GoogleCloudDiscoveryengineV1DocumentAclInfo aclInfo)
```
    Access control information for the document.
    
    Parameters:
    
    aclInfo - aclInfo or null for none
  - getContent
```
public GoogleCloudDiscoveryengineV1DocumentContent getContent()
```
    The unstructured data linked to this document. Content can only be set and must be set if this document is under a `CONTENT_REQUIRED` data store.
    
    Returns:
    
    value or null for none
  - setContent
```
public GoogleCloudDiscoveryengineV1Document setContent(GoogleCloudDiscoveryengineV1DocumentContent content)
```
    The unstructured data linked to this document. Content can only be set and must be set if this document is under a `CONTENT_REQUIRED` data store.
    
    Parameters:
    
    content - content 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 GoogleCloudDiscoveryengineV1Document 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
  - getId
```
public String getId()
```
    Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters.
    
    Returns:
    
    value or null for none
  - setId
```
public GoogleCloudDiscoveryengineV1Document setId(String id)
```
    Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters.
    
    Parameters:
    
    id - id or null for none
  - getIndexStatus
```
public GoogleCloudDiscoveryengineV1DocumentIndexStatus getIndexStatus()
```
    Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, if document's index is in progress, the pending_message field is populated.
    
    Returns:
    
    value or null for none
  - setIndexStatus
```
public GoogleCloudDiscoveryengineV1Document setIndexStatus(GoogleCloudDiscoveryengineV1DocumentIndexStatus indexStatus)
```
    Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, if document's index is in progress, the pending_message field is populated.
    
    Parameters:
    
    indexStatus - indexStatus or null for none
  - getIndexTime
```
public String getIndexTime()
```
    Output only. The time when the document was last indexed. If this field is populated, it means the document has been indexed. While documents typically become searchable within seconds of indexing, it can sometimes take up to a few hours. If this field is not populated, it means the document has never been indexed.
    
    Returns:
    
    value or null for none
  - setIndexTime
```
public GoogleCloudDiscoveryengineV1Document setIndexTime(String indexTime)
```
    Output only. The time when the document was last indexed. If this field is populated, it means the document has been indexed. While documents typically become searchable within seconds of indexing, it can sometimes take up to a few hours. If this field is not populated, it means the document has never been indexed.
    
    Parameters:
    
    indexTime - indexTime or null for none
  - getJsonData
```
public String getJsonData()
```
    The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.
    
    Returns:
    
    value or null for none
  - setJsonData
```
public GoogleCloudDiscoveryengineV1Document setJsonData(String jsonData)
```
    The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.
    
    Parameters:
    
    jsonData - jsonData or null for none
  - getName
```
public String getName()
```
    Immutable. The full resource name of the document. Format: `projects/{project}/locations/{locat ion}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_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 GoogleCloudDiscoveryengineV1Document setName(String name)
```
    Immutable. The full resource name of the document. Format: `projects/{project}/locations/{locat ion}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id} `. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
    
    Parameters:
    
    name - name or null for none
  - getParentDocumentId
```
public String getParentDocumentId()
```
    The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
    
    Returns:
    
    value or null for none
  - setParentDocumentId
```
public GoogleCloudDiscoveryengineV1Document setParentDocumentId(String parentDocumentId)
```
    The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
    
    Parameters:
    
    parentDocumentId - parentDocumentId or null for none
  - getSchemaId
```
public String getSchemaId()
```
    The identifier of the schema located in the same data store.
    
    Returns:
    
    value or null for none
  - setSchemaId
```
public GoogleCloudDiscoveryengineV1Document setSchemaId(String schemaId)
```
    The identifier of the schema located in the same data store.
    
    Parameters:
    
    schemaId - schemaId or null for none
  - getStructData
```
public Map<String,Object> getStructData()
```
    The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.
    
    Returns:
    
    value or null for none
  - setStructData
```
public GoogleCloudDiscoveryengineV1Document setStructData(Map<String,Object> structData)
```
    The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.
    
    Parameters:
    
    structData - structData or null for none
  - set
```
public GoogleCloudDiscoveryengineV1Document set(String fieldName,
                                                Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleCloudDiscoveryengineV1Document clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleCloudDiscoveryengineV1Document

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

GoogleCloudDiscoveryengineV1Document

Method Detail

getAclInfo

setAclInfo

getContent

setContent

getDerivedStructData

setDerivedStructData

getId

setId

getIndexStatus

setIndexStatus

getIndexTime

setIndexTime

getJsonData

setJsonData

getName

setName

getParentDocumentId

setParentDocumentId

getSchemaId

setSchemaId

getStructData

setStructData

set

clone