batchGetDocumentsMetadata(parent, matcher_fhirMatcher_fhirResources=None, matcher_urisMatcher_uris=None, x__xgafv=None)

Gets index freshness metadata for Documents. Supported for website search only.

Args:
  parent: string, Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. (required)
  matcher_fhirMatcher_fhirResources: string, Required. The FHIR resources to match by. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} (repeated)
  matcher_urisMatcher_uris: string, The exact URIs to match by. (repeated)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for DocumentService.BatchGetDocumentsMetadata method.
  "documentsMetadata": [ # The metadata of the Documents.
    { # The metadata of a Document.
      "dataIngestionSource": "A 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.
      "lastRefreshedTime": "A String", # The timestamp of the last time the Document was last indexed.
      "matcherValue": { # The value of the matcher that was used to match the Document. # The value of the matcher that was used to match the Document.
        "fhirResource": "A String", # Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}
        "uri": "A String", # If match by URI, the URI of the Document.
      },
      "state": "A String", # The state of the document.
    },
  ],
}

Discovery Engine API . projects . locations . dataStores . branches

Instance Methods

Method Details