Class: Carbon::UserConfiguration

Inherits:
Object
  • Object
show all
Defined in:
lib/carbon_ruby_sdk/models/user_configuration.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserConfiguration

Initializes the object

Parameters:

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

    Model attributes in the form of hash



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/carbon_ruby_sdk/models/user_configuration.rb', line 80

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

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

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

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

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

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

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

Instance Attribute Details

#auto_sync_enabled_sources ⇒ Object

Returns the value of attribute auto_sync_enabled_sources.



14
15
16
 
# File 'lib/carbon_ruby_sdk/models/user_configuration.rb', line 14

def auto_sync_enabled_sources
  @auto_sync_enabled_sources
end

#auto_sync_interval ⇒ Object

The interval in hours at which the user’s data sources should be synced. If not set or set to -1, the user will be synced at the organization level interval or default interval if that is also not set. Must be one of [3, 6, 12, 24]



32
33
34
 
# File 'lib/carbon_ruby_sdk/models/user_configuration.rb', line 32

def auto_sync_interval
  @auto_sync_interval
end

#max_characters ⇒ Object

Custom character upload limit for the user over all user’s files across all uploads. If set, then the user will not be allowed to upload more characters than this limit. If not set, or if set to -1, then the user will have no limit.



23
24
25
 
# File 'lib/carbon_ruby_sdk/models/user_configuration.rb', line 23

def max_characters
  @max_characters
end

#max_characters_per_file ⇒ Object

A single file upload from the user can not exceed this character limit. If set, then the file will not be synced if it exceeds this limit. If not set, or if set to -1, then the user will have no limit.



26
27
28
 
# File 'lib/carbon_ruby_sdk/models/user_configuration.rb', line 26

def max_characters_per_file
  @max_characters_per_file
end

#max_characters_per_upload ⇒ Object

Custom character upload limit for the user across a single upload. If set, then the user won’t be able to sync more than this many characters in one upload. If not set, or if set to -1, then the user will have no limit.



29
30
31
 
# File 'lib/carbon_ruby_sdk/models/user_configuration.rb', line 29

def max_characters_per_upload
  @max_characters_per_upload
end

#max_files ⇒ Object

Custom file upload limit for the user over all user’s files across all uploads. If set, then the user will not be allowed to upload more files than this limit. If not set, or if set to -1, then the user will have no limit.



17
18
19
 
# File 'lib/carbon_ruby_sdk/models/user_configuration.rb', line 17

def max_files
  @max_files
end

#max_files_per_upload ⇒ Object

Custom file upload limit for the user across a single upload. If set, then the user will not be allowed to upload more files than this limit in a single upload. If not set, or if set to -1, then the user will have no limit.



20
21
22
 
# File 'lib/carbon_ruby_sdk/models/user_configuration.rb', line 20

def max_files_per_upload
  @max_files_per_upload
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



48
49
50
 
# File 'lib/carbon_ruby_sdk/models/user_configuration.rb', line 48

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/carbon_ruby_sdk/models/user_configuration.rb', line 35

def self.attribute_map
  {
    :'auto_sync_enabled_sources' => :'auto_sync_enabled_sources',
    :'max_files' => :'max_files',
    :'max_files_per_upload' => :'max_files_per_upload',
    :'max_characters' => :'max_characters',
    :'max_characters_per_file' => :'max_characters_per_file',
    :'max_characters_per_upload' => :'max_characters_per_upload',
    :'auto_sync_interval' => :'auto_sync_interval'
  }
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



254
255
256
 
# File 'lib/carbon_ruby_sdk/models/user_configuration.rb', line 254

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/carbon_ruby_sdk/models/user_configuration.rb', line 66

def self.openapi_nullable
  Set.new([
    :'auto_sync_enabled_sources',
    :'max_files',
    :'max_files_per_upload',
    :'max_characters',
    :'max_characters_per_file',
    :'max_characters_per_upload',
    :'auto_sync_interval'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/carbon_ruby_sdk/models/user_configuration.rb', line 53

def self.openapi_types
  {
    :'auto_sync_enabled_sources' => :'AutoSyncEnabledSourcesProperty',
    :'max_files' => :'Integer',
    :'max_files_per_upload' => :'Integer',
    :'max_characters' => :'Integer',
    :'max_characters_per_file' => :'Integer',
    :'max_characters_per_upload' => :'Integer',
    :'auto_sync_interval' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/carbon_ruby_sdk/models/user_configuration.rb', line 227

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      auto_sync_enabled_sources == o.auto_sync_enabled_sources &&
      max_files == o.max_files &&
      max_files_per_upload == o.max_files_per_upload &&
      max_characters == o.max_characters &&
      max_characters_per_file == o.max_characters_per_file &&
      max_characters_per_upload == o.max_characters_per_upload &&
      auto_sync_interval == o.auto_sync_interval
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



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/carbon_ruby_sdk/models/user_configuration.rb', line 285

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



356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/carbon_ruby_sdk/models/user_configuration.rb', line 356

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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/carbon_ruby_sdk/models/user_configuration.rb', line 261

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


241
242
243
 
# File 'lib/carbon_ruby_sdk/models/user_configuration.rb', line 241

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



247
248
249
 
# File 'lib/carbon_ruby_sdk/models/user_configuration.rb', line 247

def hash
  [auto_sync_enabled_sources, max_files, max_files_per_upload, max_characters, max_characters_per_file, max_characters_per_upload, auto_sync_interval].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



124
125
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
 
# File 'lib/carbon_ruby_sdk/models/user_configuration.rb', line 124

def list_invalid_properties
  invalid_properties = Array.new
  if !@max_files.nil? && @max_files < -1
    invalid_properties.push('invalid value for "max_files", must be greater than or equal to -1.')
  end

  if !@max_files_per_upload.nil? && @max_files_per_upload < -1
    invalid_properties.push('invalid value for "max_files_per_upload", must be greater than or equal to -1.')
  end

  if !@max_characters.nil? && @max_characters < -1
    invalid_properties.push('invalid value for "max_characters", must be greater than or equal to -1.')
  end

  if !@max_characters_per_file.nil? && @max_characters_per_file < -1
    invalid_properties.push('invalid value for "max_characters_per_file", must be greater than or equal to -1.')
  end

  if !@max_characters_per_upload.nil? && @max_characters_per_upload < -1
    invalid_properties.push('invalid value for "max_characters_per_upload", must be greater than or equal to -1.')
  end

  if !@auto_sync_interval.nil? && @auto_sync_interval < -1
    invalid_properties.push('invalid value for "auto_sync_interval", must be greater than or equal to -1.')
  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



332
333
334
 
# File 'lib/carbon_ruby_sdk/models/user_configuration.rb', line 332

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



338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/carbon_ruby_sdk/models/user_configuration.rb', line 338

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



326
327
328
 
# File 'lib/carbon_ruby_sdk/models/user_configuration.rb', line 326

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



155
156
157
158
159
160
161
162
163
 
# File 'lib/carbon_ruby_sdk/models/user_configuration.rb', line 155

def valid?
  return false if !@max_files.nil? && @max_files < -1
  return false if !@max_files_per_upload.nil? && @max_files_per_upload < -1
  return false if !@max_characters.nil? && @max_characters < -1
  return false if !@max_characters_per_file.nil? && @max_characters_per_file < -1
  return false if !@max_characters_per_upload.nil? && @max_characters_per_upload < -1
  return false if !@auto_sync_interval.nil? && @auto_sync_interval < -1
  true
end