Class: Google::Cloud::DocumentAI::V1beta3::DocumentId

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

Overview

Document Identifier.

Defined Under Namespace

Classes: GCSManagedDocumentId, UnmanagedDocumentId

Instance Attribute Summary collapse

Instance Attribute Details

#gcs_managed_doc_id ⇒ ::Google::Cloud::DocumentAI::V1beta3::DocumentId::GCSManagedDocumentId

Returns A document id within user-managed Cloud Storage.

Note: The following fields are mutually exclusive: gcs_managed_doc_id, unmanaged_doc_id. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'proto_docs/google/cloud/documentai/v1beta3/dataset.rb', line 137

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

  # Identifies a document uniquely within the scope of a dataset in the
  # user-managed Cloud Storage option.
  # @!attribute [rw] gcs_uri
  #   @return [::String]
  #     Required. The Cloud Storage URI where the actual document is stored.
  # @!attribute [rw] cw_doc_id
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::String]
  #     Id of the document (indexed) managed by Content Warehouse.
  class GCSManagedDocumentId
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a document uniquely within the scope of a dataset in unmanaged
  # option.
  # @!attribute [rw] doc_id
  #   @return [::String]
  #     Required. The id of the document.
  class UnmanagedDocumentId
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#revision_ref ⇒ ::Google::Cloud::DocumentAI::V1beta3::RevisionRef

Returns Points to a specific revision of the document if set.

Returns:



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'proto_docs/google/cloud/documentai/v1beta3/dataset.rb', line 137

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

  # Identifies a document uniquely within the scope of a dataset in the
  # user-managed Cloud Storage option.
  # @!attribute [rw] gcs_uri
  #   @return [::String]
  #     Required. The Cloud Storage URI where the actual document is stored.
  # @!attribute [rw] cw_doc_id
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::String]
  #     Id of the document (indexed) managed by Content Warehouse.
  class GCSManagedDocumentId
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a document uniquely within the scope of a dataset in unmanaged
  # option.
  # @!attribute [rw] doc_id
  #   @return [::String]
  #     Required. The id of the document.
  class UnmanagedDocumentId
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#unmanaged_doc_id ⇒ ::Google::Cloud::DocumentAI::V1beta3::DocumentId::UnmanagedDocumentId

Returns A document id within unmanaged dataset.

Note: The following fields are mutually exclusive: unmanaged_doc_id, gcs_managed_doc_id. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'proto_docs/google/cloud/documentai/v1beta3/dataset.rb', line 137

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

  # Identifies a document uniquely within the scope of a dataset in the
  # user-managed Cloud Storage option.
  # @!attribute [rw] gcs_uri
  #   @return [::String]
  #     Required. The Cloud Storage URI where the actual document is stored.
  # @!attribute [rw] cw_doc_id
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::String]
  #     Id of the document (indexed) managed by Content Warehouse.
  class GCSManagedDocumentId
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a document uniquely within the scope of a dataset in unmanaged
  # option.
  # @!attribute [rw] doc_id
  #   @return [::String]
  #     Required. The id of the document.
  class UnmanagedDocumentId
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end