blob: d7bbef74230d73f470146ac71684b5bcf7013b28 [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="discoveryengine_v1.html">Discovery Engine API</a> . <a href="discoveryengine_v1.projects.html">projects</a> . <a href="discoveryengine_v1.projects.locations.html">locations</a> . <a href="discoveryengine_v1.projects.locations.collections.html">collections</a> . <a href="discoveryengine_v1.projects.locations.collections.dataStores.html">dataStores</a> . <a href="discoveryengine_v1.projects.locations.collections.dataStores.branches.html">branches</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="discoveryengine_v1.projects.locations.collections.dataStores.branches.documents.html">documents()</a></code>
</p>
<p class="firstline">Returns the documents Resource.</p>
<p class="toc_element">
<code><a href="discoveryengine_v1.projects.locations.collections.dataStores.branches.operations.html">operations()</a></code>
</p>
<p class="firstline">Returns the operations Resource.</p>
<p class="toc_element">
<code><a href="#batchGetDocumentsMetadata">batchGetDocumentsMetadata(parent, matcher_fhirMatcher_fhirResources=None, matcher_urisMatcher_uris=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets index freshness metadata for Documents. Supported for website search only.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="batchGetDocumentsMetadata">batchGetDocumentsMetadata(parent, matcher_fhirMatcher_fhirResources=None, matcher_urisMatcher_uris=None, x__xgafv=None)</code>
<pre>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.
&quot;documentsMetadata&quot;: [ # The metadata of the Documents.
{ # The metadata of a Document.
&quot;dataIngestionSource&quot;: &quot;A String&quot;, # 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.
&quot;lastRefreshedTime&quot;: &quot;A String&quot;, # The timestamp of the last time the Document was last indexed.
&quot;matcherValue&quot;: { # The value of the matcher that was used to match the Document. # The value of the matcher that was used to match the Document.
&quot;fhirResource&quot;: &quot;A String&quot;, # Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}
&quot;uri&quot;: &quot;A String&quot;, # If match by URI, the URI of the Document.
},
&quot;state&quot;: &quot;A String&quot;, # The state of the document.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
</body></html>