class PureCloud::NluDomainVersion

Attributes

date_created[RW]

The date when the NLU domain version was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

date_modified[RW]

The date when the NLU domain version was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

date_published[RW]

The date when the NLU domain version was published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

date_trained[RW]

The date when the NLU domain version was trained. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

description[RW]

The description of the NLU domain version.

domain[RW]

The NLU domain of the version.

entity_types[RW]

The entity types defined for this NLU domain version.

evaluation_status[RW]

The evaluation status of the NLU domain version.

id[RW]

The globally unique identifier for the object.

intents[RW]

The intents defined for this NLU domain version.

language[RW]

The language that the NLU domain version supports.

published[RW]

Whether this NLU domain version has been published.

self_uri[RW]

The URI for this object

training_status[RW]

The training status of the NLU domain version.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/nlu_domain_version.rb, line 64
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'domain' => :'domain',
    
    :'description' => :'description',
    
    :'language' => :'language',
    
    :'published' => :'published',
    
    :'date_created' => :'dateCreated',
    
    :'date_modified' => :'dateModified',
    
    :'date_trained' => :'dateTrained',
    
    :'date_published' => :'datePublished',
    
    :'training_status' => :'trainingStatus',
    
    :'evaluation_status' => :'evaluationStatus',
    
    :'intents' => :'intents',
    
    :'entity_types' => :'entityTypes',
    
    :'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/nlu_domain_version.rb, line 135
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?(:'domain')
    
    
    self.domain = attributes[:'domain']
    
  
  end

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

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

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

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

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

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

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

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

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

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

  
  if attributes.has_key?(:'entityTypes')
    
    if (value = attributes[:'entityTypes']).is_a?(Array)
      self.entity_types = value
    end
    
    
  
  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/nlu_domain_version.rb, line 99
def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'domain' => :'NluDomain',
    
    :'description' => :'String',
    
    :'language' => :'String',
    
    :'published' => :'BOOLEAN',
    
    :'date_created' => :'DateTime',
    
    :'date_modified' => :'DateTime',
    
    :'date_trained' => :'DateTime',
    
    :'date_published' => :'DateTime',
    
    :'training_status' => :'String',
    
    :'evaluation_status' => :'String',
    
    :'intents' => :'Array<IntentDefinition>',
    
    :'entity_types' => :'Array<NamedEntityTypeDefinition>',
    
    :'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/nlu_domain_version.rb, line 451
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      domain == o.domain &&
      description == o.description &&
      language == o.language &&
      published == o.published &&
      date_created == o.date_created &&
      date_modified == o.date_modified &&
      date_trained == o.date_trained &&
      date_published == o.date_published &&
      training_status == o.training_status &&
      evaluation_status == o.evaluation_status &&
      intents == o.intents &&
      entity_types == o.entity_types &&
      self_uri == o.self_uri
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/nlu_domain_version.rb, line 502
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/nlu_domain_version.rb, line 562
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/nlu_domain_version.rb, line 483
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/nlu_domain_version.rb, line 472
def eql?(o)
  self == o
end
evaluation_status=(evaluation_status) click to toggle source

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

# File lib/purecloudplatformclientv2/models/nlu_domain_version.rb, line 423
def evaluation_status=(evaluation_status)
  allowed_values = ["Unevaluated", "Evaluating", "Evaluated", "Error"]
  if evaluation_status && !allowed_values.include?(evaluation_status)
    fail ArgumentError, "invalid value for 'evaluation_status', must be one of #{allowed_values}."
  end
  @evaluation_status = evaluation_status
end
hash() click to toggle source

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

# File lib/purecloudplatformclientv2/models/nlu_domain_version.rb, line 478
def hash
  [id, domain, description, language, published, date_created, date_modified, date_trained, date_published, training_status, evaluation_status, intents, entity_types, self_uri].hash
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/nlu_domain_version.rb, line 276
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

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

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/nlu_domain_version.rb, line 550
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/nlu_domain_version.rb, line 540
def to_s
  to_hash.to_s
end
training_status=(training_status) click to toggle source

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

# File lib/purecloudplatformclientv2/models/nlu_domain_version.rb, line 409
def training_status=(training_status)
  allowed_values = ["Untrained", "Training", "Trained", "Error", "Unknown"]
  if training_status && !allowed_values.include?(training_status)
    fail ArgumentError, "invalid value for 'training_status', must be one of #{allowed_values}."
  end
  @training_status = training_status
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/nlu_domain_version.rb, line 285
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if @language.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["Untrained", "Training", "Trained", "Error", "Unknown"]
  if @training_status && !allowed_values.include?(@training_status)
    return false
  end
  
  
  
  
  
  allowed_values = ["Unevaluated", "Evaluating", "Evaluated", "Error"]
  if @evaluation_status && !allowed_values.include?(@evaluation_status)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end