class DependencyTracker::NotificationPublisher

Attributes

default_publisher[RW]
description[RW]
name[RW]
publisher_class[RW]
template[RW]
template_mime_type[RW]
uuid[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/dependency-tracker-client/models/notification_publisher.rb, line 32
def self.attribute_map
  {
    :'name' => :'name',
    :'description' => :'description',
    :'publisher_class' => :'publisherClass',
    :'template' => :'template',
    :'template_mime_type' => :'templateMimeType',
    :'default_publisher' => :'defaultPublisher',
    :'uuid' => :'uuid'
  }
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/dependency-tracker-client/models/notification_publisher.rb, line 277
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/dependency-tracker-client/models/notification_publisher.rb, line 65
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DependencyTracker::NotificationPublisher` 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 `DependencyTracker::NotificationPublisher`. 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?(:'description')
    self.description = attributes[:'description']
  end

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

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

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

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

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

List of attributes with nullable: true

# File lib/dependency-tracker-client/models/notification_publisher.rb, line 58
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/dependency-tracker-client/models/notification_publisher.rb, line 45
def self.openapi_types
  {
    :'name' => :'String',
    :'description' => :'String',
    :'publisher_class' => :'String',
    :'template' => :'String',
    :'template_mime_type' => :'String',
    :'default_publisher' => :'Boolean',
    :'uuid' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/dependency-tracker-client/models/notification_publisher.rb, line 250
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      description == o.description &&
      publisher_class == o.publisher_class &&
      template == o.template &&
      template_mime_type == o.template_mime_type &&
      default_publisher == o.default_publisher &&
      uuid == o.uuid
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/dependency-tracker-client/models/notification_publisher.rb, line 305
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
    DependencyTracker.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/dependency-tracker-client/models/notification_publisher.rb, line 374
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/dependency-tracker-client/models/notification_publisher.rb, line 284
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
description=(description) click to toggle source

Custom attribute writer method with validation @param [Object] description Value to be assigned

# File lib/dependency-tracker-client/models/notification_publisher.rb, line 200
def description=(description)
  if !description.nil? && description.to_s.length > 1024
    fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 1024.'
  end

  if !description.nil? && description.to_s.length < 0
    fail ArgumentError, 'invalid value for "description", the character length must be great than or equal to 0.'
  end

  @description = description
end
eql?(o) click to toggle source

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

# File lib/dependency-tracker-client/models/notification_publisher.rb, line 264
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/dependency-tracker-client/models/notification_publisher.rb, line 270
def hash
  [name, description, publisher_class, template, template_mime_type, default_publisher, uuid].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/dependency-tracker-client/models/notification_publisher.rb, line 109
def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @name.to_s.length > 255
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 255.')
  end

  if @name.to_s.length < 1
    invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
  end

  if !@description.nil? && @description.to_s.length > 1024
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 1024.')
  end

  if !@description.nil? && @description.to_s.length < 0
    invalid_properties.push('invalid value for "description", the character length must be great than or equal to 0.')
  end

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

  if @publisher_class.to_s.length > 1024
    invalid_properties.push('invalid value for "publisher_class", the character length must be smaller than or equal to 1024.')
  end

  if @publisher_class.to_s.length < 1
    invalid_properties.push('invalid value for "publisher_class", the character length must be great than or equal to 1.')
  end

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

  if @template_mime_type.to_s.length > 255
    invalid_properties.push('invalid value for "template_mime_type", the character length must be smaller than or equal to 255.')
  end

  if @template_mime_type.to_s.length < 1
    invalid_properties.push('invalid value for "template_mime_type", the character length must be great than or equal to 1.')
  end

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

  invalid_properties
end
name=(name) click to toggle source

Custom attribute writer method with validation @param [Object] name Value to be assigned

# File lib/dependency-tracker-client/models/notification_publisher.rb, line 182
def name=(name)
  if name.nil?
    fail ArgumentError, 'name cannot be nil'
  end

  if name.to_s.length > 255
    fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 255.'
  end

  if name.to_s.length < 1
    fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
  end

  @name = name
end
publisher_class=(publisher_class) click to toggle source

Custom attribute writer method with validation @param [Object] publisher_class Value to be assigned

# File lib/dependency-tracker-client/models/notification_publisher.rb, line 214
def publisher_class=(publisher_class)
  if publisher_class.nil?
    fail ArgumentError, 'publisher_class cannot be nil'
  end

  if publisher_class.to_s.length > 1024
    fail ArgumentError, 'invalid value for "publisher_class", the character length must be smaller than or equal to 1024.'
  end

  if publisher_class.to_s.length < 1
    fail ArgumentError, 'invalid value for "publisher_class", the character length must be great than or equal to 1.'
  end

  @publisher_class = publisher_class
end
template_mime_type=(template_mime_type) click to toggle source

Custom attribute writer method with validation @param [Object] template_mime_type Value to be assigned

# File lib/dependency-tracker-client/models/notification_publisher.rb, line 232
def template_mime_type=(template_mime_type)
  if template_mime_type.nil?
    fail ArgumentError, 'template_mime_type cannot be nil'
  end

  if template_mime_type.to_s.length > 255
    fail ArgumentError, 'invalid value for "template_mime_type", the character length must be smaller than or equal to 255.'
  end

  if template_mime_type.to_s.length < 1
    fail ArgumentError, 'invalid value for "template_mime_type", the character length must be great than or equal to 1.'
  end

  @template_mime_type = template_mime_type
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/dependency-tracker-client/models/notification_publisher.rb, line 350
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/dependency-tracker-client/models/notification_publisher.rb, line 356
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/dependency-tracker-client/models/notification_publisher.rb, line 344
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/dependency-tracker-client/models/notification_publisher.rb, line 164
def valid?
  return false if @name.nil?
  return false if @name.to_s.length > 255
  return false if @name.to_s.length < 1
  return false if !@description.nil? && @description.to_s.length > 1024
  return false if !@description.nil? && @description.to_s.length < 0
  return false if @publisher_class.nil?
  return false if @publisher_class.to_s.length > 1024
  return false if @publisher_class.to_s.length < 1
  return false if @template_mime_type.nil?
  return false if @template_mime_type.to_s.length > 255
  return false if @template_mime_type.to_s.length < 1
  return false if @uuid.nil?
  true
end