Google Cloud Discovery Engine V1 Client - Class IndexStatus (1.7.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class IndexStatus.

Index status of the document.

Generated from protobuf message google.cloud.discoveryengine.v1.Document.IndexStatus

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ Document

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ index_time`	`Google\Protobuf\Timestamp` The time when the document was indexed. If this field is populated, it means the document has been indexed.
`↳ error_samples`	`array<Google\Rpc\Status>` A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors.
`↳ pending_message`	`string` Immutable. The message indicates the document index is in progress. If this field is populated, the document index is pending.

getIndexTime

The time when the document was indexed.

If this field is populated, it means the document has been indexed.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasIndexTime

clearIndexTime

setIndexTime

The time when the document was indexed.

If this field is populated, it means the document has been indexed.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getErrorSamples

A sample of errors encountered while indexing the document.

If this field is populated, the document is not indexed due to errors.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setErrorSamples