Class: Hubspot::Cms::Hubdb::HubDbTableV3

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HubDbTableV3

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3.rb', line 135

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Cms::Hubdb::HubDbTableV3` 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::HubDbTableV3`. 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?(:'dynamic_meta_tags')
    if (value = attributes[:'dynamic_meta_tags']).is_a?(Hash)
      self.dynamic_meta_tags = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#allow_child_tables ⇒ Object

Specifies whether child tables can be created



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

def allow_child_tables
  @allow_child_tables
end

#allow_public_api_access ⇒ Object

Specifies whether the table can be read by public without authorization



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

def allow_public_api_access
  @allow_public_api_access
end

#column_count ⇒ Object

Number of columns including deleted



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

def column_count
  @column_count
end

#columns ⇒ Object

List of columns in the table



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

def columns
  @columns
end

#created_at ⇒ Object

Timestamp at which the table is created



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

def created_at
  @created_at
end

#created_by ⇒ Object

Returns the value of attribute created_by.



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

def created_by
  @created_by
end

#deleted ⇒ Object

Returns the value of attribute deleted.



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

def deleted
  @deleted
end

#dynamic_meta_tags ⇒ Object

Specifies the key value pairs of the [metadata fields](developers.hubspot.com/docs/cms/guides/dynamic-pages/hubdb#dynamic-pages) with the associated column IDs.



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

def dynamic_meta_tags
  @dynamic_meta_tags
end

#enable_child_table_pages ⇒ Object

Specifies creation of multi-level dynamic pages using child tables



59
60
61
 
# File 'lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3.rb', line 59

def enable_child_table_pages
  @enable_child_table_pages
end

#id ⇒ Object

Id of the table



62
63
64
 
# File 'lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3.rb', line 62

def id
  @id
end

#is_ordered_manually ⇒ Object

Returns the value of attribute is_ordered_manually.



67
68
69
 
# File 'lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3.rb', line 67

def is_ordered_manually
  @is_ordered_manually
end

#label ⇒ Object

Label of the table



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

def label
  @label
end

#name ⇒ Object

Name of the table



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

def name
  @name
end

#published ⇒ Object

Returns the value of attribute published.



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

def published
  @published
end

#published_at ⇒ Object

Timestamp at which the table is published recently



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

def published_at
  @published_at
end

#row_count ⇒ Object

Number of rows in the table



65
66
67
 
# File 'lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3.rb', line 65

def row_count
  @row_count
end

#updated_at ⇒ Object

Timestamp at which the table is updated recently



70
71
72
 
# File 'lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3.rb', line 70

def updated_at
  @updated_at
end

#updated_by ⇒ Object

Returns the value of attribute updated_by.



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

def updated_by
  @updated_by
end

#use_for_pages ⇒ Object

Specifies whether the table can be used for creation of dynamic pages



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

def use_for_pages
  @use_for_pages
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



98
99
100
 
# File 'lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3.rb', line 98

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3.rb', line 73

def self.attribute_map
  {
    :'dynamic_meta_tags' => :'dynamicMetaTags',
    :'updated_by' => :'updatedBy',
    :'allow_public_api_access' => :'allowPublicApiAccess',
    :'use_for_pages' => :'useForPages',
    :'published_at' => :'publishedAt',
    :'columns' => :'columns',
    :'label' => :'label',
    :'published' => :'published',
    :'column_count' => :'columnCount',
    :'allow_child_tables' => :'allowChildTables',
    :'created_at' => :'createdAt',
    :'deleted' => :'deleted',
    :'created_by' => :'createdBy',
    :'name' => :'name',
    :'enable_child_table_pages' => :'enableChildTablePages',
    :'id' => :'id',
    :'row_count' => :'rowCount',
    :'is_ordered_manually' => :'isOrderedManually',
    :'updated_at' => :'updatedAt'
  }
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



293
294
295
 
# File 'lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3.rb', line 293

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



128
129
130
131
 
# File 'lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3.rb', line 128

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

.openapi_types ⇒ Object

Attribute type mapping.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3.rb', line 103

def self.openapi_types
  {
    :'dynamic_meta_tags' => :'Hash<String, Integer>',
    :'updated_by' => :'SimpleUser',
    :'allow_public_api_access' => :'Boolean',
    :'use_for_pages' => :'Boolean',
    :'published_at' => :'Time',
    :'columns' => :'Array<Column>',
    :'label' => :'String',
    :'published' => :'Boolean',
    :'column_count' => :'Integer',
    :'allow_child_tables' => :'Boolean',
    :'created_at' => :'Time',
    :'deleted' => :'Boolean',
    :'created_by' => :'SimpleUser',
    :'name' => :'String',
    :'enable_child_table_pages' => :'Boolean',
    :'id' => :'String',
    :'row_count' => :'Integer',
    :'is_ordered_manually' => :'Boolean',
    :'updated_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3.rb', line 254

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      dynamic_meta_tags == o.dynamic_meta_tags &&
      updated_by == o.updated_by &&
      allow_public_api_access == o.allow_public_api_access &&
      use_for_pages == o.use_for_pages &&
      published_at == o.published_at &&
      columns == o.columns &&
      label == o.label &&
      published == o.published &&
      column_count == o.column_count &&
      allow_child_tables == o.allow_child_tables &&
      created_at == o.created_at &&
      deleted == o.deleted &&
      created_by == o.created_by &&
      name == o.name &&
      enable_child_table_pages == o.enable_child_table_pages &&
      id == o.id &&
      row_count == o.row_count &&
      is_ordered_manually == o.is_ordered_manually &&
      updated_at == o.updated_at
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



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3.rb', line 324

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Hubspot::Cms::Hubdb.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3.rb', line 395

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



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3.rb', line 300

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


280
281
282
 
# File 'lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3.rb', line 280

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



286
287
288
 
# File 'lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3.rb', line 286

def hash
  [dynamic_meta_tags, updated_by, allow_public_api_access, use_for_pages, published_at, columns, label, published, column_count, allow_child_tables, created_at, deleted, created_by, name, enable_child_table_pages, id, row_count, is_ordered_manually, updated_at].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



231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3.rb', line 231

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

  if @name.nil?
    invalid_properties.push('invalid value for "name", name 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



371
372
373
 
# File 'lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3.rb', line 371

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



377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3.rb', line 377

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



365
366
367
 
# File 'lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3.rb', line 365

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



246
247
248
249
250
 
# File 'lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3.rb', line 246

def valid?
  return false if @label.nil?
  return false if @name.nil?
  true
end