Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class DocumentMetadata.
The metadata of a Document.
Generated from protobuf message google.cloud.discoveryengine.v1.BatchGetDocumentsMetadataResponse.DocumentMetadata
Namespace
Google \ Cloud \ DiscoveryEngine \ V1 \ BatchGetDocumentsMetadataResponseMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ matcher_value |
DocumentMetadata\MatcherValue
The value of the matcher that was used to match the Document. |
↳ state |
int
The state of the document. |
↳ last_refreshed_time |
Google\Protobuf\Timestamp
The timestamp of the last time the Document was last indexed. |
↳ data_ingestion_source |
string
The data ingestion source of the Document. Allowed values are: * * |
getMatcherValue
The value of the matcher that was used to match the Document.
| Returns | |
|---|---|
| Type | Description |
DocumentMetadata\MatcherValue|null |
|
hasMatcherValue
clearMatcherValue
setMatcherValue
The value of the matcher that was used to match the Document.
| Parameter | |
|---|---|
| Name | Description |
var |
DocumentMetadata\MatcherValue
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
The state of the document.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type State. |
setState
The state of the document.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type State. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLastRefreshedTime
The timestamp of the last time the Document was last indexed.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasLastRefreshedTime
clearLastRefreshedTime
setLastRefreshedTime
The timestamp of the last time the Document was last indexed.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDataIngestionSource
The data ingestion source of the Document.
Allowed values are:
batch: Data ingested via Batch API, e.g., ImportDocuments.streamingData ingested via Streaming API, e.g., FHIR streaming.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDataIngestionSource
The data ingestion source of the Document.
Allowed values are:
batch: Data ingested via Batch API, e.g., ImportDocuments.streamingData ingested via Streaming API, e.g., FHIR streaming.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|