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.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
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 
{

  // Union field matcher_value can be only one of the following:
  "uri": string,
  "fhirResource": string
  // End of list of possible types for union field matcher_value.
}
Fields
Union field matcher_value. The value of the matcher that was used to match the Document. matcher_value can be only one of the following:
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}

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.