Class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentSchema

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/documentai_v1beta3/classes.rb,
lib/google/apis/documentai_v1beta3/representations.rb,
lib/google/apis/documentai_v1beta3/representations.rb

Overview

The schema defines the output of the processed document by a processor.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1beta3DocumentSchema

Returns a new instance of GoogleCloudDocumentaiV1beta3DocumentSchema.



6774
6775
6776
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 6774

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#description ⇒ String

Description of the schema. Corresponds to the JSON property description

Returns:

  • (String) 


6757
6758
6759
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 6757

def description
  @description
end

#display_name ⇒ String

Display name to show to users. Corresponds to the JSON property displayName

Returns:

  • (String) 


6762
6763
6764
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 6762

def display_name
  @display_name
end

#entity_types ⇒ Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType>

Entity types of the schema. Corresponds to the JSON property entityTypes

Returns:



6767
6768
6769
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 6767

def entity_types
  @entity_types
end

#metadata ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata

Metadata for global schema behavior. Corresponds to the JSON property metadata

Returns:



6772
6773
6774
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 6772

def metadata
  @metadata
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6779
6780
6781
6782
6783
6784
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 6779

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @entity_types = args[:entity_types] if args.key?(:entity_types)
  @metadata = args[:metadata] if args.key?(:metadata)
end