class PureCloud::FlowRuntimeExecution

Details about the current state of a Flow execution

Attributes

completion_reason[RW]

The completion reason set at the flow completion time, if applicable.

conversation[RW]

The conversation to which this Flow execution is related

date_completed[RW]

The time the flow completed, if applicable. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

date_launched[RW]

The time the flow was launched. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

flow_error_info[RW]

Additional information if the flow is in error

flow_version[RW]

The Version of the flow definition of the flow execution.

id[RW]

The flow execution ID

name[RW]

The flow execution name.

output_data[RW]

List of the flow's output variables, if any. Output variables are only supplied for Completed flows.

self_uri[RW]

The URI for this object

status[RW]

The flow's running status, which indicates whether the flow is running normally or completed, etc.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/flow_runtime_execution.rb, line 56
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'flow_version' => :'flowVersion',
    
    :'date_launched' => :'dateLaunched',
    
    :'status' => :'status',
    
    :'date_completed' => :'dateCompleted',
    
    :'completion_reason' => :'completionReason',
    
    :'flow_error_info' => :'flowErrorInfo',
    
    :'output_data' => :'outputData',
    
    :'conversation' => :'conversation',
    
    :'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/flow_runtime_execution.rb, line 115
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?(:'flowVersion')
    
    
    self.flow_version = attributes[:'flowVersion']
    
  
  end

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

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

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

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

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

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

  
  if attributes.has_key?(:'conversation')
    
    
    self.conversation = attributes[:'conversation']
    
  
  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/flow_runtime_execution.rb, line 85
def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'flow_version' => :'FlowVersion',
    
    :'date_launched' => :'DateTime',
    
    :'status' => :'String',
    
    :'date_completed' => :'DateTime',
    
    :'completion_reason' => :'String',
    
    :'flow_error_info' => :'ErrorBody',
    
    :'output_data' => :'Hash<String, Object>',
    
    :'conversation' => :'DomainEntityRef',
    
    :'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/flow_runtime_execution.rb, line 371
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      flow_version == o.flow_version &&
      date_launched == o.date_launched &&
      status == o.status &&
      date_completed == o.date_completed &&
      completion_reason == o.completion_reason &&
      flow_error_info == o.flow_error_info &&
      output_data == o.output_data &&
      conversation == o.conversation &&
      self_uri == o.self_uri
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/flow_runtime_execution.rb, line 419
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/flow_runtime_execution.rb, line 479
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/flow_runtime_execution.rb, line 400
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/flow_runtime_execution.rb, line 389
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/flow_runtime_execution.rb, line 395
def hash
  [id, name, flow_version, date_launched, status, date_completed, completion_reason, flow_error_info, output_data, conversation, 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/flow_runtime_execution.rb, line 227
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/flow_runtime_execution.rb, line 328
def status=(status)
  allowed_values = ["UNKNOWN", "RUNNING", "ERROR", "TERMINATED", "COMPLETED", "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/flow_runtime_execution.rb, line 462
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/flow_runtime_execution.rb, line 467
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/flow_runtime_execution.rb, line 457
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/flow_runtime_execution.rb, line 236
def valid?
  
  
  
  
  
  
  
  
  
  
  if @flow_version.nil?
    return false
  end

  
  
  
  
  
  if @date_launched.nil?
    return false
  end

  
  
  
  
  
  if @status.nil?
    return false
  end

  
  
  allowed_values = ["UNKNOWN", "RUNNING", "ERROR", "TERMINATED", "COMPLETED", "FAILED"]
  if @status && !allowed_values.include?(@status)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end