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



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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3.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::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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'archived')
    self.archived = attributes[:'archived']
  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?(:'enable_child_table_pages')
    self.enable_child_table_pages = attributes[:'enable_child_table_pages']
  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?(:'updated_at')
    self.updated_at = attributes[:'updated_at']
  end
end

Instance Attribute Details

#allow_child_tables ⇒ Object

Specifies whether child tables can be created



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

def allow_child_tables
  @allow_child_tables
end

#allow_public_api_access ⇒ Object

Specifies whether the table can be read by public without authorization



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

def allow_public_api_access
  @allow_public_api_access
end

#archived ⇒ Object

Specifies whether table is archived or not



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

def archived
  @archived
end

#column_count ⇒ Object

Number of columns including deleted



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

def column_count
  @column_count
end

#columns ⇒ Object

List of columns in the table



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

def columns
  @columns
end

#created_at ⇒ Object

Timestamp at which the table is created



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

def created_at
  @created_at
end

#created_by ⇒ Object

Returns the value of attribute created_by.



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

def created_by
  @created_by
end

#dynamic_meta_tags ⇒ Object

Specifies the key value pairs of the metadata fields with the associated column ids



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

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



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

def id
  @id
end

#label ⇒ Object

Label of the table



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

def label
  @label
end

#name ⇒ Object

Name of the table



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

def name
  @name
end

#published ⇒ Object

Returns the value of attribute published.



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

def published
  @published
end

#published_at ⇒ Object

Timestamp at which the table is published recently



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

def published_at
  @published_at
end

#row_count ⇒ Object

Number of rows in the table



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

def row_count
  @row_count
end

#updated_at ⇒ Object

Timestamp at which the table is updated recently



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

def updated_at
  @updated_at
end

#updated_by ⇒ Object

Returns the value of attribute updated_by.



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

def updated_by
  @updated_by
end

#use_for_pages ⇒ Object

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



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

def use_for_pages
  @use_for_pages
end

Class Method Details

.attribute_map ⇒ Object

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



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

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



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

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/hub_db_table_v3.rb', line 119

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

.openapi_types ⇒ Object

Attribute type mapping.



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

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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



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
339
340
341
342
 
# File 'lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3.rb', line 307

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



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

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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3.rb', line 286

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


266
267
268
 
# File 'lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3.rb', line 266

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



272
273
274
 
# File 'lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3.rb', line 272

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



218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3.rb', line 218

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

  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



352
353
354
 
# File 'lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3.rb', line 352

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



358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3.rb', line 358

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



346
347
348
 
# File 'lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3.rb', line 346

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



233
234
235
236
237
 
# File 'lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3.rb', line 233

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