Class: Hubspot::Cms::Hubdb::Column

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/cms/hubdb/models/column.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Column

Initializes the object

Parameters:

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

    Model attributes in the form of hash



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
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
 
# File 'lib/hubspot/codegen/cms/hubdb/models/column.rb', line 126

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Cms::Hubdb::Column` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Hubspot::Cms::Hubdb::Column`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

  if attributes.key?(:'foreign_ids')
    if (value = attributes[:'foreign_ids']).is_a?(Array)
      self.foreign_ids = value
    end
  end

  if attributes.key?(:'foreign_ids_by_name')
    if (value = attributes[:'foreign_ids_by_name']).is_a?(Hash)
      self.foreign_ids_by_name = value
    end
  end

  if attributes.key?(:'foreign_ids_by_id')
    if (value = attributes[:'foreign_ids_by_id']).is_a?(Hash)
      self.foreign_ids_by_id = value
    end
  end

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

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

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

  if attributes.key?(:'options')
    if (value = attributes[:'options']).is_a?(Array)
      self.options = value
    end
  end
end

Instance Attribute Details

#archived ⇒ Object

Specifies whether the column is archived



53
54
55
 
# File 'lib/hubspot/codegen/cms/hubdb/models/column.rb', line 53

def archived
  @archived
end

#foreign_column_id ⇒ Object

Foreign Column id



35
36
37
 
# File 'lib/hubspot/codegen/cms/hubdb/models/column.rb', line 35

def foreign_column_id
  @foreign_column_id
end

#foreign_ids ⇒ Object

Foreign Ids



38
39
40
 
# File 'lib/hubspot/codegen/cms/hubdb/models/column.rb', line 38

def foreign_ids
  @foreign_ids
end

#foreign_ids_by_id ⇒ Object

Foreign ids



44
45
46
 
# File 'lib/hubspot/codegen/cms/hubdb/models/column.rb', line 44

def foreign_ids_by_id
  @foreign_ids_by_id
end

#foreign_ids_by_name ⇒ Object

Foreign ids by name



41
42
43
 
# File 'lib/hubspot/codegen/cms/hubdb/models/column.rb', line 41

def foreign_ids_by_name
  @foreign_ids_by_name
end

#foreign_table_id ⇒ Object

Foreign table id referenced



32
33
34
 
# File 'lib/hubspot/codegen/cms/hubdb/models/column.rb', line 32

def foreign_table_id
  @foreign_table_id
end

#id ⇒ Object

Column Id



26
27
28
 
# File 'lib/hubspot/codegen/cms/hubdb/models/column.rb', line 26

def id
  @id
end

#label ⇒ Object

Label of the column



23
24
25
 
# File 'lib/hubspot/codegen/cms/hubdb/models/column.rb', line 23

def label
  @label
end

#name ⇒ Object

Name of the column



20
21
22
 
# File 'lib/hubspot/codegen/cms/hubdb/models/column.rb', line 20

def name
  @name
end

#option_count ⇒ Object

Number of options available



50
51
52
 
# File 'lib/hubspot/codegen/cms/hubdb/models/column.rb', line 50

def option_count
  @option_count
end

#options ⇒ Object

Options to choose for select and multi-select columns



56
57
58
 
# File 'lib/hubspot/codegen/cms/hubdb/models/column.rb', line 56

def options
  @options
end

#type ⇒ Object

Type of the column



47
48
49
 
# File 'lib/hubspot/codegen/cms/hubdb/models/column.rb', line 47

def type
  @type
end

#width ⇒ Object

Column width for HubDB UI



29
30
31
 
# File 'lib/hubspot/codegen/cms/hubdb/models/column.rb', line 29

def width
  @width
end

Class Method Details

.attribute_map ⇒ Object

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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/hubspot/codegen/cms/hubdb/models/column.rb', line 81

def self.attribute_map
  {
    :'name' => :'name',
    :'label' => :'label',
    :'id' => :'id',
    :'width' => :'width',
    :'foreign_table_id' => :'foreignTableId',
    :'foreign_column_id' => :'foreignColumnId',
    :'foreign_ids' => :'foreignIds',
    :'foreign_ids_by_name' => :'foreignIdsByName',
    :'foreign_ids_by_id' => :'foreignIdsById',
    :'type' => :'type',
    :'option_count' => :'optionCount',
    :'archived' => :'archived',
    :'options' => :'options'
  }
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



275
276
277
 
# File 'lib/hubspot/codegen/cms/hubdb/models/column.rb', line 275

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



119
120
121
122
 
# File 'lib/hubspot/codegen/cms/hubdb/models/column.rb', line 119

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/hubspot/codegen/cms/hubdb/models/column.rb', line 100

def self.openapi_types
  {
    :'name' => :'String',
    :'label' => :'String',
    :'id' => :'String',
    :'width' => :'Integer',
    :'foreign_table_id' => :'Integer',
    :'foreign_column_id' => :'Integer',
    :'foreign_ids' => :'Array<ForeignId>',
    :'foreign_ids_by_name' => :'Hash<String, ForeignId>',
    :'foreign_ids_by_id' => :'Hash<String, ForeignId>',
    :'type' => :'String',
    :'option_count' => :'Integer',
    :'archived' => :'Boolean',
    :'options' => :'Array<Option>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/hubspot/codegen/cms/hubdb/models/column.rb', line 242

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      label == o.label &&
      id == o.id &&
      width == o.width &&
      foreign_table_id == o.foreign_table_id &&
      foreign_column_id == o.foreign_column_id &&
      foreign_ids == o.foreign_ids &&
      foreign_ids_by_name == o.foreign_ids_by_name &&
      foreign_ids_by_id == o.foreign_ids_by_id &&
      type == o.type &&
      option_count == o.option_count &&
      archived == o.archived &&
      options == o.options
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



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/hubspot/codegen/cms/hubdb/models/column.rb', line 303

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    Hubspot::Cms::Hubdb.const_get(type).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



372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/hubspot/codegen/cms/hubdb/models/column.rb', line 372

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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/hubspot/codegen/cms/hubdb/models/column.rb', line 282

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


262
263
264
 
# File 'lib/hubspot/codegen/cms/hubdb/models/column.rb', line 262

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



268
269
270
 
# File 'lib/hubspot/codegen/cms/hubdb/models/column.rb', line 268

def hash
  [name, label, id, width, foreign_table_id, foreign_column_id, foreign_ids, foreign_ids_by_name, foreign_ids_by_id, type, option_count, archived, options].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/hubspot/codegen/cms/hubdb/models/column.rb', line 202

def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @label.nil?
    invalid_properties.push('invalid value for "label", label cannot be nil.')
  end

  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  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



348
349
350
 
# File 'lib/hubspot/codegen/cms/hubdb/models/column.rb', line 348

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



354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/hubspot/codegen/cms/hubdb/models/column.rb', line 354

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    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



342
343
344
 
# File 'lib/hubspot/codegen/cms/hubdb/models/column.rb', line 342

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



221
222
223
224
225
226
227
228
 
# File 'lib/hubspot/codegen/cms/hubdb/models/column.rb', line 221

def valid?
  return false if @name.nil?
  return false if @label.nil?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["NULL", "TEXT", "NUMBER", "URL", "IMAGE", "SELECT", "MULTISELECT", "BOOLEAN", "LOCATION", "DATE", "DATETIME", "CURRENCY", "RICHTEXT", "FOREIGN_ID", "VIDEO", "CTA"])
  return false unless type_validator.valid?(@type)
  true
end