com.google.api.services.discoveryengine.v1.model

Class GoogleCloudDiscoveryengineV1DocumentIndexStatus

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.GoogleCloudDiscoveryengineV1DocumentIndexStatus

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleCloudDiscoveryengineV1DocumentIndexStatus
extends com.google.api.client.json.GenericJson

Index status of the document.

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
GoogleCloudDiscoveryengineV1DocumentIndexStatus()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1DocumentIndexStatus	clone()
List<GoogleRpcStatus>	getErrorSamples() A sample of errors encountered while indexing the document.
String	getIndexTime() The time when the document was indexed.
String	getPendingMessage() Immutable.
GoogleCloudDiscoveryengineV1DocumentIndexStatus	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1DocumentIndexStatus	setErrorSamples(List<GoogleRpcStatus> errorSamples) A sample of errors encountered while indexing the document.
GoogleCloudDiscoveryengineV1DocumentIndexStatus	setIndexTime(String indexTime) The time when the document was indexed.
GoogleCloudDiscoveryengineV1DocumentIndexStatus	setPendingMessage(String pendingMessage) Immutable.

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

GoogleCloudDiscoveryengineV1DocumentIndexStatus

public GoogleCloudDiscoveryengineV1DocumentIndexStatus()

Method Detail

getErrorSamples

public List<GoogleRpcStatus> getErrorSamples()

A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors.

Returns:

value or null for none

setErrorSamples

public GoogleCloudDiscoveryengineV1DocumentIndexStatus setErrorSamples(List<GoogleRpcStatus> errorSamples)

A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors.

Parameters:

errorSamples - errorSamples or null for none

getIndexTime

public String getIndexTime()

The time when the document was 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.

Returns:

value or null for none

setIndexTime

public GoogleCloudDiscoveryengineV1DocumentIndexStatus setIndexTime(String indexTime)

The time when the document was 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.

Parameters:

indexTime - indexTime or null for none

getPendingMessage

public String getPendingMessage()

Immutable. The message indicates the document index is in progress. If this field is populated, the document index is pending.

Returns:

value or null for none

setPendingMessage

public GoogleCloudDiscoveryengineV1DocumentIndexStatus setPendingMessage(String pendingMessage)

Immutable. The message indicates the document index is in progress. If this field is populated, the document index is pending.

Parameters:

pendingMessage - pendingMessage or null for none

set

public GoogleCloudDiscoveryengineV1DocumentIndexStatus set(String fieldName,
                                                           Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public GoogleCloudDiscoveryengineV1DocumentIndexStatus clone()

Overrides:

clone in class com.google.api.client.json.GenericJson