class stcloud::Subscription

Attributes

addresses[RW]
created_by[RW]
dashboard_id[RW]
dashboard_name[RW]
enabled[RW]
filters[RW]
frequency[RW]
id[RW]
next_send_date[RW]
subject[RW]
system_id[RW]
system_name[RW]
text[RW]
time_range[RW]
user_permissions[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/stcloud/models/subscription.rb, line 69
def self.attribute_map
  {
    :'addresses' => :'addresses',
    :'created_by' => :'createdBy',
    :'dashboard_id' => :'dashboardId',
    :'dashboard_name' => :'dashboardName',
    :'enabled' => :'enabled',
    :'filters' => :'filters',
    :'frequency' => :'frequency',
    :'id' => :'id',
    :'next_send_date' => :'nextSendDate',
    :'subject' => :'subject',
    :'system_id' => :'systemId',
    :'system_name' => :'systemName',
    :'text' => :'text',
    :'time_range' => :'timeRange',
    :'user_permissions' => :'userPermissions'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/stcloud/models/subscription.rb, line 266
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/stcloud/models/subscription.rb, line 118
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `stcloud::Subscription` 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 `stcloud::Subscription`. 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?(:'addresses')
    self.addresses = attributes[:'addresses']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'user_permissions')
    self.user_permissions = attributes[:'user_permissions']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/stcloud/models/subscription.rb, line 111
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/stcloud/models/subscription.rb, line 90
def self.openapi_types
  {
    :'addresses' => :'Object',
    :'created_by' => :'Object',
    :'dashboard_id' => :'Object',
    :'dashboard_name' => :'Object',
    :'enabled' => :'Object',
    :'filters' => :'Object',
    :'frequency' => :'Object',
    :'id' => :'Object',
    :'next_send_date' => :'Object',
    :'subject' => :'Object',
    :'system_id' => :'Object',
    :'system_name' => :'Object',
    :'text' => :'Object',
    :'time_range' => :'Object',
    :'user_permissions' => :'Object'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/stcloud/models/subscription.rb, line 231
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      addresses == o.addresses &&
      created_by == o.created_by &&
      dashboard_id == o.dashboard_id &&
      dashboard_name == o.dashboard_name &&
      enabled == o.enabled &&
      filters == o.filters &&
      frequency == o.frequency &&
      id == o.id &&
      next_send_date == o.next_send_date &&
      subject == o.subject &&
      system_id == o.system_id &&
      system_name == o.system_name &&
      text == o.text &&
      time_range == o.time_range &&
      user_permissions == o.user_permissions
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/stcloud/models/subscription.rb, line 296
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
    stcloud.const_get(type).build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/stcloud/models/subscription.rb, line 365
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/stcloud/models/subscription.rb, line 273
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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/stcloud/models/subscription.rb, line 253
def eql?(o)
  self == o
end
frequency=(frequency) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] frequency Object to be assigned

# File lib/stcloud/models/subscription.rb, line 211
def frequency=(frequency)
  validator = EnumAttributeValidator.new('Object', ['EVERY_FIVE_MINUTES', 'DAILY', 'WEEKLY', 'MONTHLY', 'QUARTERLY'])
  unless validator.valid?(frequency)
    fail ArgumentError, "invalid value for \"frequency\", must be one of #{validator.allowable_values}."
  end
  @frequency = frequency
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/stcloud/models/subscription.rb, line 259
def hash
  [addresses, created_by, dashboard_id, dashboard_name, enabled, filters, frequency, id, next_send_date, subject, system_id, system_name, text, time_range, user_permissions].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/stcloud/models/subscription.rb, line 194
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
time_range=(time_range) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] time_range Object to be assigned

# File lib/stcloud/models/subscription.rb, line 221
def time_range=(time_range)
  validator = EnumAttributeValidator.new('Object', ['ONE_DAY', 'ONE_WEEK', 'ONE_MONTH', 'TWO_MONTH', 'SIX_MONTH', 'ONE_YEAR'])
  unless validator.valid?(time_range)
    fail ArgumentError, "invalid value for \"time_range\", must be one of #{validator.allowable_values}."
  end
  @time_range = time_range
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/stcloud/models/subscription.rb, line 341
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/stcloud/models/subscription.rb, line 347
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/stcloud/models/subscription.rb, line 335
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/stcloud/models/subscription.rb, line 201
def valid?
  frequency_validator = EnumAttributeValidator.new('Object', ['EVERY_FIVE_MINUTES', 'DAILY', 'WEEKLY', 'MONTHLY', 'QUARTERLY'])
  return false unless frequency_validator.valid?(@frequency)
  time_range_validator = EnumAttributeValidator.new('Object', ['ONE_DAY', 'ONE_WEEK', 'ONE_MONTH', 'TWO_MONTH', 'SIX_MONTH', 'ONE_YEAR'])
  return false unless time_range_validator.valid?(@time_range)
  true
end