BatchGetDocumentsMetadataResponse

Response message for DocumentService.BatchGetDocumentsMetadata method.

JSON representation 
{
  "documentsMetadata": [
    {
      object (DocumentMetadata)
    }
  ]
}
Fields
documentsMetadata[]

object (DocumentMetadata)

The metadata of the Documents.

DocumentMetadata

The metadata of a Document.

JSON representation 
{
  "matcherValue": {
    object (MatcherValue)
  },
  "state": enum (State),
  "lastRefreshedTime": string,
  "dataIngestionSource": string
}
Fields
matcherValue

object (MatcherValue)

The value of the matcher that was used to match the Document.
state

enum (State)

The state of the document.
lastRefreshedTime

string (Timestamp format)

The timestamp of the last time the Document was last indexed.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
dataIngestionSource

string

The data ingestion source of the Document.

Allowed values are:

  • batch: Data ingested via Batch API, e.g., ImportDocuments.
  • streaming data ingested via Streaming API, e.g., FHIR streaming.

MatcherValue

The value of the matcher that was used to match the Document.

JSON representation 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "uri": string,
  "fhirResource": string
  // End of mutually exclusive fields.
}
Fields
The value of the matcher that was used to match the Document. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
uri

string

If match by URI, the URI of the Document.
fhirResource

string

Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhirStore}/fhir/{resourceType}/{fhir_resource_id}
End of mutually exclusive fields.

State

The state of the Document.

Enums
STATE_UNSPECIFIED Should never be set.
INDEXED The Document is indexed.
NOT_IN_TARGET_SITE The Document is not indexed because its URI is not in the TargetSite.
NOT_IN_INDEX The Document is not indexed.