Class: GroupDocsParserCloud::BarcodesOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_parser_cloud/models/barcodes_options.rb

Overview

Barcode options.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BarcodesOptions

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/groupdocs_parser_cloud/models/barcodes_options.rb', line 73

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.key?(:'FileInfo')
    self.file_info = attributes[:'FileInfo']
  end

  if attributes.key?(:'ContainerItemInfo')
    self.container_item_info = attributes[:'ContainerItemInfo']
  end

  if attributes.key?(:'OutputPath')
    self.output_path = attributes[:'OutputPath']
  end

  if attributes.key?(:'StartPageNumber')
    self.start_page_number = attributes[:'StartPageNumber']
  end

  if attributes.key?(:'CountPagesToExtract')
    self.count_pages_to_extract = attributes[:'CountPagesToExtract']
  end

end

Instance Attribute Details

#container_item_info ⇒ Object

Gets or sets the container item information.



38
39
40
 
# File 'lib/groupdocs_parser_cloud/models/barcodes_options.rb', line 38

def container_item_info
  @container_item_info
end

#count_pages_to_extract ⇒ Object

Gets or sets the number of pages to extract.



47
48
49
 
# File 'lib/groupdocs_parser_cloud/models/barcodes_options.rb', line 47

def count_pages_to_extract
  @count_pages_to_extract
end

#file_info ⇒ Object

Gets or sets the file information.



35
36
37
 
# File 'lib/groupdocs_parser_cloud/models/barcodes_options.rb', line 35

def file_info
  @file_info
end

#output_path ⇒ Object

Gets or sets the output path for extracted barcodes.



41
42
43
 
# File 'lib/groupdocs_parser_cloud/models/barcodes_options.rb', line 41

def output_path
  @output_path
end

#start_page_number ⇒ Object

Gets or sets the zero-based start page index.



44
45
46
 
# File 'lib/groupdocs_parser_cloud/models/barcodes_options.rb', line 44

def start_page_number
  @start_page_number
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



50
51
52
53
54
55
56
57
58
 
# File 'lib/groupdocs_parser_cloud/models/barcodes_options.rb', line 50

def self.attribute_map
  {
    :'file_info' => :'FileInfo',
    :'container_item_info' => :'ContainerItemInfo',
    :'output_path' => :'OutputPath',
    :'start_page_number' => :'StartPageNumber',
    :'count_pages_to_extract' => :'CountPagesToExtract'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
 
# File 'lib/groupdocs_parser_cloud/models/barcodes_options.rb', line 61

def self.swagger_types
  {
    :'file_info' => :'FileInfo',
    :'container_item_info' => :'ContainerItemInfo',
    :'output_path' => :'String',
    :'start_page_number' => :'Integer',
    :'count_pages_to_extract' => :'Integer'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



116
117
118
119
120
121
122
123
124
 
# File 'lib/groupdocs_parser_cloud/models/barcodes_options.rb', line 116

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      file_info == other.file_info &&
      container_item_info == other.container_item_info &&
      output_path == other.output_path &&
      start_page_number == other.start_page_number &&
      count_pages_to_extract == other.count_pages_to_extract
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/groupdocs_parser_cloud/models/barcodes_options.rb', line 171

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    Date.parse value
  when :Date
    Date.parse value
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else
  # model
    temp_model = GroupDocsParserCloud.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/groupdocs_parser_cloud/models/barcodes_options.rb', line 238

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/groupdocs_parser_cloud/models/barcodes_options.rb', line 147

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    pname = uncap(self.class.attribute_map[key]).intern
    value = attributes[pname]
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not                    
      if value.is_a?(Array)
        self.send("#{key}=", value.map { |v| _deserialize($1, v) })
      end
    elsif !value.nil?
      self.send("#{key}=", _deserialize(type, value))
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


128
129
130
 
# File 'lib/groupdocs_parser_cloud/models/barcodes_options.rb', line 128

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



134
135
136
 
# File 'lib/groupdocs_parser_cloud/models/barcodes_options.rb', line 134

def hash
  [file_info, container_item_info, output_path, start_page_number, count_pages_to_extract].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



103
104
105
106
 
# File 'lib/groupdocs_parser_cloud/models/barcodes_options.rb', line 103

def list_invalid_properties
  invalid_properties = []
  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



218
219
220
 
# File 'lib/groupdocs_parser_cloud/models/barcodes_options.rb', line 218

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



224
225
226
227
228
229
230
231
232
 
# File 'lib/groupdocs_parser_cloud/models/barcodes_options.rb', line 224

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



212
213
214
 
# File 'lib/groupdocs_parser_cloud/models/barcodes_options.rb', line 212

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



140
141
142
 
# File 'lib/groupdocs_parser_cloud/models/barcodes_options.rb', line 140

def uncap(str)
  str[0, 1].downcase + str[1..-1]
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



110
111
112
 
# File 'lib/groupdocs_parser_cloud/models/barcodes_options.rb', line 110

def valid?
  return true
end