Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchema

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/documentai_v1/classes.rb,
lib/google/apis/documentai_v1/representations.rb,
lib/google/apis/documentai_v1/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) ⇒ GoogleCloudDocumentaiV1DocumentSchema

Returns a new instance of GoogleCloudDocumentaiV1DocumentSchema.



2896
2897
2898
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2896

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

Instance Attribute Details

#description ⇒ String

Description of the schema. Corresponds to the JSON property description

Returns:

  • (String) 


2879
2880
2881
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2879

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


2884
2885
2886
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2884

def display_name
  @display_name
end

#entity_types ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchemaEntityType>

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

Returns:



2889
2890
2891
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2889

def entity_types
  @entity_types
end

#metadata ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchemaMetadata

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

Returns:



2894
2895
2896
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2894

def metadata
  @metadata
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2901
2902
2903
2904
2905
2906
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2901

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