class PureCloud::KnowledgeTraining

Attributes

date_completed[RW]

Training completed date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

date_promoted[RW]

Trained Documents Promoted date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

date_triggered[RW]

Trigger date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

error_message[RW]

Any error message during the Training or Promote action.

id[RW]

The globally unique identifier for the object.

knowledge_base[RW]

Knowledge base which Training does belong to

knowledge_documents_state[RW]

State of the Trained Documents, which can be one of these Draft, Active, Discarded, Archived.

language_code[RW]

Actual language of the Training

name[RW]
self_uri[RW]

The URI for this object

status[RW]

Training status

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/knowledge_training.rb, line 54
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'date_triggered' => :'dateTriggered',
    
    :'date_completed' => :'dateCompleted',
    
    :'status' => :'status',
    
    :'language_code' => :'languageCode',
    
    :'knowledge_base' => :'knowledgeBase',
    
    :'error_message' => :'errorMessage',
    
    :'knowledge_documents_state' => :'knowledgeDocumentsState',
    
    :'date_promoted' => :'datePromoted',
    
    :'self_uri' => :'selfUri'
    
  }
end
new(attributes = {}) click to toggle source

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

# File lib/purecloudplatformclientv2/models/knowledge_training.rb, line 113
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

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

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

  
  if attributes.has_key?(:'dateTriggered')
    
    
    self.date_triggered = attributes[:'dateTriggered']
    
  
  end

  
  if attributes.has_key?(:'dateCompleted')
    
    
    self.date_completed = attributes[:'dateCompleted']
    
  
  end

  
  if attributes.has_key?(:'status')
    
    
    self.status = attributes[:'status']
    
  
  end

  
  if attributes.has_key?(:'languageCode')
    
    
    self.language_code = attributes[:'languageCode']
    
  
  end

  
  if attributes.has_key?(:'knowledgeBase')
    
    
    self.knowledge_base = attributes[:'knowledgeBase']
    
  
  end

  
  if attributes.has_key?(:'errorMessage')
    
    
    self.error_message = attributes[:'errorMessage']
    
  
  end

  
  if attributes.has_key?(:'knowledgeDocumentsState')
    
    
    self.knowledge_documents_state = attributes[:'knowledgeDocumentsState']
    
  
  end

  
  if attributes.has_key?(:'datePromoted')
    
    
    self.date_promoted = attributes[:'datePromoted']
    
  
  end

  
  if attributes.has_key?(:'selfUri')
    
    
    self.self_uri = attributes[:'selfUri']
    
  
  end

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/knowledge_training.rb, line 83
def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'date_triggered' => :'DateTime',
    
    :'date_completed' => :'DateTime',
    
    :'status' => :'String',
    
    :'language_code' => :'String',
    
    :'knowledge_base' => :'KnowledgeBase',
    
    :'error_message' => :'String',
    
    :'knowledge_documents_state' => :'String',
    
    :'date_promoted' => :'DateTime',
    
    :'self_uri' => :'String'
    
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/purecloudplatformclientv2/models/knowledge_training.rb, line 366
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      date_triggered == o.date_triggered &&
      date_completed == o.date_completed &&
      status == o.status &&
      language_code == o.language_code &&
      knowledge_base == o.knowledge_base &&
      error_message == o.error_message &&
      knowledge_documents_state == o.knowledge_documents_state &&
      date_promoted == o.date_promoted &&
      self_uri == o.self_uri
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/knowledge_training.rb, line 414
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 =~ /^(true|t|yes|y|1)$/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
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

# File lib/purecloudplatformclientv2/models/knowledge_training.rb, line 474
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

build the object from hash

# File lib/purecloudplatformclientv2/models/knowledge_training.rb, line 395
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end
eql?(o) click to toggle source

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

# File lib/purecloudplatformclientv2/models/knowledge_training.rb, line 384
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/purecloudplatformclientv2/models/knowledge_training.rb, line 390
def hash
  [id, name, date_triggered, date_completed, status, language_code, knowledge_base, error_message, knowledge_documents_state, date_promoted, self_uri].hash
end
knowledge_documents_state=(knowledge_documents_state) click to toggle source

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

# File lib/purecloudplatformclientv2/models/knowledge_training.rb, line 343
def knowledge_documents_state=(knowledge_documents_state)
  allowed_values = ["Draft", "Active", "Discarded", "Archived"]
  if knowledge_documents_state && !allowed_values.include?(knowledge_documents_state)
    fail ArgumentError, "invalid value for 'knowledge_documents_state', must be one of #{allowed_values}."
  end
  @knowledge_documents_state = knowledge_documents_state
end
list_invalid_properties() click to toggle source

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

# File lib/purecloudplatformclientv2/models/knowledge_training.rb, line 223
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
status=(status) click to toggle source

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

# File lib/purecloudplatformclientv2/models/knowledge_training.rb, line 314
def status=(status)
  allowed_values = ["Queued", "InProgress", "Succeeded", "Failed"]
  if status && !allowed_values.include?(status)
    fail ArgumentError, "invalid value for 'status', must be one of #{allowed_values}."
  end
  @status = status
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloudplatformclientv2/models/knowledge_training.rb, line 457
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/knowledge_training.rb, line 462
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source
# File lib/purecloudplatformclientv2/models/knowledge_training.rb, line 452
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/purecloudplatformclientv2/models/knowledge_training.rb, line 232
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["Queued", "InProgress", "Succeeded", "Failed"]
  if @status && !allowed_values.include?(@status)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["Draft", "Active", "Discarded", "Archived"]
  if @knowledge_documents_state && !allowed_values.include?(@knowledge_documents_state)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
end