Class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef

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

Overview

Represents a weak reference to a page element within a document.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef

Returns a new instance of GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef.



3156
3157
3158
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3156

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

Instance Attribute Details

#bounding_poly ⇒ Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2BoundingPoly

A bounding polygon for the detected image annotation. Corresponds to the JSON property boundingPoly

Returns:



3131
3132
3133
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3131

def bounding_poly
  @bounding_poly
end

#confidence ⇒ Float

Optional. Confidence of detected page element, if applicable. Range [0, 1]. Corresponds to the JSON property confidence

Returns:

  • (Float) 


3136
3137
3138
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3136

def confidence
  @confidence
end

#layout_id ⇒ String

Optional. Deprecated. Use PageRef.bounding_poly instead. Corresponds to the JSON property layoutId

Returns:

  • (String) 


3141
3142
3143
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3141

def layout_id
  @layout_id
end

#layout_type ⇒ String

Optional. The type of the layout element that is being referenced if any. Corresponds to the JSON property layoutType

Returns:

  • (String) 


3146
3147
3148
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3146

def layout_type
  @layout_type
end

#page ⇒ Fixnum

Required. Index into the Document.pages element, for example using Document. pages to locate the related page element. This field is skipped when its value is the default 0. See https://developers.google.com/protocol-buffers/docs/ proto3#json. Corresponds to the JSON property page

Returns:

  • (Fixnum) 


3154
3155
3156
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3154

def page
  @page
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3161
3162
3163
3164
3165
3166
3167
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3161

def update!(**args)
  @bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly)
  @confidence = args[:confidence] if args.key?(:confidence)
  @layout_id = args[:layout_id] if args.key?(:layout_id)
  @layout_type = args[:layout_type] if args.key?(:layout_type)
  @page = args[:page] if args.key?(:page)
end