Class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef

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) ⇒ GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef

Returns a new instance of GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef.



1892
1893
1894
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1892

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

Instance Attribute Details

#bounding_poly ⇒ Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1BoundingPoly

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

Returns:



1867
1868
1869
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1867

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) 


1872
1873
1874
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1872

def confidence
  @confidence
end

#layout_id ⇒ String

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

Returns:

  • (String) 


1877
1878
1879
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1877

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) 


1882
1883
1884
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1882

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) 


1890
1891
1892
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1890

def page
  @page
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1897

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