Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchemaEntityType

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

EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1DocumentSchemaEntityType

Returns a new instance of GoogleCloudDocumentaiV1DocumentSchemaEntityType.



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

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

Instance Attribute Details

#base_types ⇒ Array<String>

The entity type that this type is derived from. For now, one and only one should be set. Corresponds to the JSON property baseTypes

Returns:

  • (Array<String>) 


2859
2860
2861
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2859

def base_types
  @base_types
end

#display_name ⇒ String

User defined name for the type. Corresponds to the JSON property displayName

Returns:

  • (String) 


2864
2865
2866
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2864

def display_name
  @display_name
end

#entity_type_metadata ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EntityTypeMetadata

Metadata about an entity type. Corresponds to the JSON property entityTypeMetadata

Returns:



2869
2870
2871
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2869

def entity_type_metadata
  @entity_type_metadata
end

#enum_values ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues

Defines the a list of enum values. Corresponds to the JSON property enumValues

Returns:



2874
2875
2876
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2874

def enum_values
  @enum_values
end

#name ⇒ String

Name of the type. It must be unique within the schema file and cannot be a ' Common Type'. Besides that we use the following naming conventions: - use snake_casing - name matching is case-insensitive - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters [a-z0-9_-]. ( For backward compatibility internal infrastructure and tooling can handle any ascii character) - The '/' is sometimes used to denote a property of a type. For example line_item/amount. This convention is deprecated, but will still be honored for backward compatibility. Corresponds to the JSON property name

Returns:

  • (String) 


2886
2887
2888
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2886

def name
  @name
end

#properties ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty>

Describing the nested structure, or composition of an entity. Corresponds to the JSON property properties

Returns:



2891
2892
2893
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2891

def properties
  @properties
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



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

def update!(**args)
  @base_types = args[:base_types] if args.key?(:base_types)
  @display_name = args[:display_name] if args.key?(:display_name)
  @entity_type_metadata = args[:entity_type_metadata] if args.key?(:entity_type_metadata)
  @enum_values = args[:enum_values] if args.key?(:enum_values)
  @name = args[:name] if args.key?(:name)
  @properties = args[:properties] if args.key?(:properties)
end