Class: GroupDocsConversionCloud::FieldLabel

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_conversion_cloud/models/field_label.rb

Overview

Represents field label

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FieldLabel

Initializes the object

Parameters:

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

    Model attributes in the form of hash



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/groupdocs_conversion_cloud/models/field_label.rb', line 79

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?(:'Field')
    self.field = attributes[:'Field']
  end

  if attributes.key?(:'Label')
    self.label = attributes[:'Label']
  end

end

Instance Attribute Details

#field ⇒ Object

The field name



35
36
37
 
# File 'lib/groupdocs_conversion_cloud/models/field_label.rb', line 35

def field
  @field
end

#label ⇒ Object

The label e.g. "Sender"



38
39
40
 
# File 'lib/groupdocs_conversion_cloud/models/field_label.rb', line 38

def label
  @label
end

Class Method Details

.attribute_map ⇒ Object

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



62
63
64
65
66
67
 
# File 'lib/groupdocs_conversion_cloud/models/field_label.rb', line 62

def self.attribute_map
  {
    :'field' => :'Field',
    :'label' => :'Label'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
 
# File 'lib/groupdocs_conversion_cloud/models/field_label.rb', line 70

def self.swagger_types
  {
    :'field' => :'String',
    :'label' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



131
132
133
134
135
136
 
# File 'lib/groupdocs_conversion_cloud/models/field_label.rb', line 131

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      field == other.field &&
      label == other.label
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



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
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/groupdocs_conversion_cloud/models/field_label.rb', line 183

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 = GroupDocsConversionCloud.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



250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/groupdocs_conversion_cloud/models/field_label.rb', line 250

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



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/groupdocs_conversion_cloud/models/field_label.rb', line 159

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


140
141
142
 
# File 'lib/groupdocs_conversion_cloud/models/field_label.rb', line 140

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



146
147
148
 
# File 'lib/groupdocs_conversion_cloud/models/field_label.rb', line 146

def hash
  [field, label].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



97
98
99
100
101
102
103
104
 
# File 'lib/groupdocs_conversion_cloud/models/field_label.rb', line 97

def list_invalid_properties
  invalid_properties = []
  if @field.nil?
    invalid_properties.push("invalid value for 'field', field cannot be nil.")
  end

  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



230
231
232
 
# File 'lib/groupdocs_conversion_cloud/models/field_label.rb', line 230

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



236
237
238
239
240
241
242
243
244
 
# File 'lib/groupdocs_conversion_cloud/models/field_label.rb', line 236

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



224
225
226
 
# File 'lib/groupdocs_conversion_cloud/models/field_label.rb', line 224

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



152
153
154
 
# File 'lib/groupdocs_conversion_cloud/models/field_label.rb', line 152

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



108
109
110
111
112
113
 
# File 'lib/groupdocs_conversion_cloud/models/field_label.rb', line 108

def valid?
  return false if @field.nil?
  field_validator = EnumAttributeValidator.new('String', ["Start", "TabField", "Subject", "ShowTimeAs", "Sent", "RequiredAttendees", "RecurrencePattern", "Recurrence", "PageHeader", "Organizer", "Location", "Importance", "From", "End", "Bcc", "Attachments", "To"])
  return false unless field_validator.valid?(@field)
  return true
end