class PureCloud::FlowVersion

Attributes

commit_version[RW]
configuration_uri[RW]
configuration_version[RW]
created_by[RW]
created_by_client[RW]
date_created[RW]
debug[RW]
generation_id[RW]
id[RW]

The flow version identifier

input_schema[RW]
name[RW]
output_schema[RW]
publish_result_uri[RW]
secure[RW]
self_uri[RW]

The URI for this object

type[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/flow_version.rb, line 56
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'commit_version' => :'commitVersion',
    
    :'configuration_version' => :'configurationVersion',
    
    :'type' => :'type',
    
    :'secure' => :'secure',
    
    :'debug' => :'debug',
    
    :'created_by' => :'createdBy',
    
    :'created_by_client' => :'createdByClient',
    
    :'configuration_uri' => :'configurationUri',
    
    :'date_created' => :'dateCreated',
    
    :'generation_id' => :'generationId',
    
    :'publish_result_uri' => :'publishResultUri',
    
    :'input_schema' => :'inputSchema',
    
    :'output_schema' => :'outputSchema',
    
    :'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_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?(:'name')
    
    
    self.name = attributes[:'name']
    
  
  end

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

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

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

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

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

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

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

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

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

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

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

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

  
  if attributes.has_key?(:'outputSchema')
    
    
    self.output_schema = attributes[:'outputSchema']
    
  
  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_version.rb, line 95
def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'commit_version' => :'String',
    
    :'configuration_version' => :'String',
    
    :'type' => :'String',
    
    :'secure' => :'BOOLEAN',
    
    :'debug' => :'BOOLEAN',
    
    :'created_by' => :'User',
    
    :'created_by_client' => :'DomainEntityRef',
    
    :'configuration_uri' => :'String',
    
    :'date_created' => :'Integer',
    
    :'generation_id' => :'String',
    
    :'publish_result_uri' => :'String',
    
    :'input_schema' => :'JsonSchemaDocument',
    
    :'output_schema' => :'JsonSchemaDocument',
    
    :'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_version.rb, line 464
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      commit_version == o.commit_version &&
      configuration_version == o.configuration_version &&
      type == o.type &&
      secure == o.secure &&
      debug == o.debug &&
      created_by == o.created_by &&
      created_by_client == o.created_by_client &&
      configuration_uri == o.configuration_uri &&
      date_created == o.date_created &&
      generation_id == o.generation_id &&
      publish_result_uri == o.publish_result_uri &&
      input_schema == o.input_schema &&
      output_schema == o.output_schema &&
      self_uri == o.self_uri
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/flow_version.rb, line 517
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_version.rb, line 577
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_version.rb, line 498
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_version.rb, line 487
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_version.rb, line 493
def hash
  [id, name, commit_version, configuration_version, type, secure, debug, created_by, created_by_client, configuration_uri, date_created, generation_id, publish_result_uri, input_schema, output_schema, 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_version.rb, line 290
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/flow_version.rb, line 560
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_version.rb, line 565
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_version.rb, line 555
def to_s
  to_hash.to_s
end
type=(type) click to toggle source

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

# File lib/purecloudplatformclientv2/models/flow_version.rb, line 396
def type=(type)
  allowed_values = ["PUBLISH", "CHECKIN", "SAVE"]
  if type && !allowed_values.include?(type)
    fail ArgumentError, "invalid value for 'type', must be one of #{allowed_values}."
  end
  @type = type
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_version.rb, line 299
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["PUBLISH", "CHECKIN", "SAVE"]
  if @type && !allowed_values.include?(@type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end