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.
    },
  ],
}

close()

Close httplib2 connections.

get(name, view=None, x__xgafv=None)

Retrieves a Branch.

Args:
  name: string, Required. The name of the branch to retrieve. Format: `projects/*/locations/global/dataStores/default_data_store/branches/some_branch_id`. "default_branch" can be used as a special branch_id, it returns the default branch that has been set for the document. (required)
  view: string, The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.
    Allowed values
      BRANCH_VIEW_UNSPECIFIED - The value when it's unspecified. This defaults to the BASIC view.
      BRANCH_VIEW_BASIC - Includes basic metadata about the branch, but not statistical fields. See documentation of individual fields of Branch to know what is excluded.
      BRANCH_VIEW_FULL - Includes all fields of a Branch.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A data branch that stores Documents.
  "branchStats": { # Statistics describing a branch. # Output only. Stistics describing a branch. This field is not populated in BranchView.BASIC view.
    "documentCounts": { # The number of documents in a given branch. The key is a group representing a set of documents, and the value is the number of document in that group. Note: keys in this map may change over time. Supported keys: ['all'].
      "a_key": "A String",
    },
  },
  "displayName": "A String", # Output only. Human readable name of the branch to display in the UI.
  "isDefault": True or False, # Output only. Indicates whether this branch is set as the default branch of its parent data store.
  "lastDocumentImportTime": "A String", # Output only. Timestamp of last import through DocumentService.ImportDocuments. Empty value means no import has been made to this branch.
  "name": "A String", # Immutable. Full resource name of the branch, such as `projects/*/locations/global/dataStores/data_store/branches/branch_id`.
}

list(parent, view=None, x__xgafv=None)

Lists all Branchs under the specified parent DataStore.

Args:
  parent: string, Required. The parent data store resource name. (required)
  view: string, The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.
    Allowed values
      BRANCH_VIEW_UNSPECIFIED - The value when it's unspecified. This defaults to the BASIC view.
      BRANCH_VIEW_BASIC - Includes basic metadata about the branch, but not statistical fields. See documentation of individual fields of Branch to know what is excluded.
      BRANCH_VIEW_FULL - Includes all fields of a Branch.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for BranchService.ListBranches method.
  "branches": [ # The Branches.
    { # A data branch that stores Documents.
      "branchStats": { # Statistics describing a branch. # Output only. Stistics describing a branch. This field is not populated in BranchView.BASIC view.
        "documentCounts": { # The number of documents in a given branch. The key is a group representing a set of documents, and the value is the number of document in that group. Note: keys in this map may change over time. Supported keys: ['all'].
          "a_key": "A String",
        },
      },
      "displayName": "A String", # Output only. Human readable name of the branch to display in the UI.
      "isDefault": True or False, # Output only. Indicates whether this branch is set as the default branch of its parent data store.
      "lastDocumentImportTime": "A String", # Output only. Timestamp of last import through DocumentService.ImportDocuments. Empty value means no import has been made to this branch.
      "name": "A String", # Immutable. Full resource name of the branch, such as `projects/*/locations/global/dataStores/data_store/branches/branch_id`.
    },
  ],
}

Discovery Engine API . projects . locations . dataStores . branches

Instance Methods

Method Details