Class: Google::Cloud::DiscoveryEngine::V1::BatchGetDocumentsMetadataResponse

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1/document_service.rb

Overview

Response message for DocumentService.BatchGetDocumentsMetadata method.

Defined Under Namespace

Modules: State Classes: DocumentMetadata

Instance Attribute Summary collapse

Instance Attribute Details

#documents_metadata ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1::BatchGetDocumentsMetadataResponse::DocumentMetadata>

Returns The metadata of the Documents.

Returns:



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'proto_docs/google/cloud/discoveryengine/v1/document_service.rb', line 240

class BatchGetDocumentsMetadataResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The metadata of a {::Google::Cloud::DiscoveryEngine::V1::Document Document}.
  # @!attribute [rw] matcher_value
  #   @return [::Google::Cloud::DiscoveryEngine::V1::BatchGetDocumentsMetadataResponse::DocumentMetadata::MatcherValue]
  #     The value of the matcher that was used to match the
  #     {::Google::Cloud::DiscoveryEngine::V1::Document Document}.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::DiscoveryEngine::V1::BatchGetDocumentsMetadataResponse::State]
  #     The state of the document.
  # @!attribute [rw] last_refreshed_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The timestamp of the last time the
  #     {::Google::Cloud::DiscoveryEngine::V1::Document Document} was last indexed.
  # @!attribute [rw] data_ingestion_source
  #   @return [::String]
  #     The data ingestion source of the
  #     {::Google::Cloud::DiscoveryEngine::V1::Document Document}.
  #
  #     Allowed values are:
  #
  #     * `batch`: Data ingested via Batch API, e.g., ImportDocuments.
  #     * `streaming` Data ingested via Streaming API, e.g., FHIR streaming.
  class DocumentMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The value of the matcher that was used to match the
    # {::Google::Cloud::DiscoveryEngine::V1::Document Document}.
    # @!attribute [rw] uri
    #   @return [::String]
    #     If match by URI, the URI of the
    #     {::Google::Cloud::DiscoveryEngine::V1::Document Document}.
    # @!attribute [rw] fhir_resource
    #   @return [::String]
    #     Format:
    #     projects/\\{project}/locations/\\{location}/datasets/\\{dataset}/fhirStores/\\{fhir_store}/fhir/\\{resource_type}/\\{fhir_resource_id}
    class MatcherValue
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The state of the {::Google::Cloud::DiscoveryEngine::V1::Document Document}.
  module State
    # Should never be set.
    STATE_UNSPECIFIED = 0

    # The {::Google::Cloud::DiscoveryEngine::V1::Document Document} is indexed.
    INDEXED = 1

    # The {::Google::Cloud::DiscoveryEngine::V1::Document Document} is not indexed
    # because its URI is not in the
    # {::Google::Cloud::DiscoveryEngine::V1::TargetSite TargetSite}.
    NOT_IN_TARGET_SITE = 2

    # The {::Google::Cloud::DiscoveryEngine::V1::Document Document} is not indexed.
    NOT_IN_INDEX = 3
  end
end