Class: Google::Cloud::DocumentAI::V1beta3::ImportDocumentsMetadata

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

Overview

Metadata of the import document operation.

Defined Under Namespace

Classes: ImportConfigValidationResult, IndividualImportStatus

Instance Attribute Summary collapse

Instance Attribute Details

#common_metadata ⇒ ::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata

Returns The basic metadata of the long-running operation.

Returns:



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_service.rb', line 103

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

  # The status of each individual document in the import process.
  # @!attribute [rw] input_gcs_source
  #   @return [::String]
  #     The source Cloud Storage URI of the document.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the importing of the document.
  # @!attribute [rw] output_document_id
  #   @return [::Google::Cloud::DocumentAI::V1beta3::DocumentId]
  #     The document id of imported document if it was successful, otherwise
  #     empty.
  class IndividualImportStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The validation status of each import config. Status is set to an error if
  # there are no documents to import in the `import_config`, or `OK` if the
  # operation will try to proceed with at least one document.
  # @!attribute [rw] input_gcs_source
  #   @return [::String]
  #     The source Cloud Storage URI specified in the import config.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The validation status of import config.
  class ImportConfigValidationResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#import_config_validation_results ⇒ ::Array<::Google::Cloud::DocumentAI::V1beta3::ImportDocumentsMetadata::ImportConfigValidationResult>

Returns Validation statuses of the batch documents import config.

Returns:



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_service.rb', line 103

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

  # The status of each individual document in the import process.
  # @!attribute [rw] input_gcs_source
  #   @return [::String]
  #     The source Cloud Storage URI of the document.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the importing of the document.
  # @!attribute [rw] output_document_id
  #   @return [::Google::Cloud::DocumentAI::V1beta3::DocumentId]
  #     The document id of imported document if it was successful, otherwise
  #     empty.
  class IndividualImportStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The validation status of each import config. Status is set to an error if
  # there are no documents to import in the `import_config`, or `OK` if the
  # operation will try to proceed with at least one document.
  # @!attribute [rw] input_gcs_source
  #   @return [::String]
  #     The source Cloud Storage URI specified in the import config.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The validation status of import config.
  class ImportConfigValidationResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#individual_import_statuses ⇒ ::Array<::Google::Cloud::DocumentAI::V1beta3::ImportDocumentsMetadata::IndividualImportStatus>

Returns The list of response details of each document.

Returns:



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_service.rb', line 103

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

  # The status of each individual document in the import process.
  # @!attribute [rw] input_gcs_source
  #   @return [::String]
  #     The source Cloud Storage URI of the document.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the importing of the document.
  # @!attribute [rw] output_document_id
  #   @return [::Google::Cloud::DocumentAI::V1beta3::DocumentId]
  #     The document id of imported document if it was successful, otherwise
  #     empty.
  class IndividualImportStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The validation status of each import config. Status is set to an error if
  # there are no documents to import in the `import_config`, or `OK` if the
  # operation will try to proceed with at least one document.
  # @!attribute [rw] input_gcs_source
  #   @return [::String]
  #     The source Cloud Storage URI specified in the import config.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The validation status of import config.
  class ImportConfigValidationResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#total_document_count ⇒ ::Integer

Returns Total number of the documents that are qualified for importing.

Returns:

  • (::Integer) —

    Total number of the documents that are qualified for importing.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_service.rb', line 103

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

  # The status of each individual document in the import process.
  # @!attribute [rw] input_gcs_source
  #   @return [::String]
  #     The source Cloud Storage URI of the document.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the importing of the document.
  # @!attribute [rw] output_document_id
  #   @return [::Google::Cloud::DocumentAI::V1beta3::DocumentId]
  #     The document id of imported document if it was successful, otherwise
  #     empty.
  class IndividualImportStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The validation status of each import config. Status is set to an error if
  # there are no documents to import in the `import_config`, or `OK` if the
  # operation will try to proceed with at least one document.
  # @!attribute [rw] input_gcs_source
  #   @return [::String]
  #     The source Cloud Storage URI specified in the import config.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The validation status of import config.
  class ImportConfigValidationResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end