class ApprovalApiClient::Request

Approval request. It may have child requests. Only a leaf node request can have workflow_id

Attributes

created_at[RW]

Timestamp of creation

decision[RW]

Approval decision. Possible value: undecided, approved, canceled, denied, or error

description[RW]

Request description

finished_at[RW]

Timestamp of finishing (skipped, canceled, or completed)

group_name[RW]

Name of approver group(s) assigned to approve this request

id[RW]
metadata[RW]

JSON Metadata about the request

name[RW]

Request name

notified_at[RW]

Timestamp of notification sent to approvers

number_of_children[RW]

Number of child requests

number_of_finished_children[RW]

Number of finished child requests

owner[RW]

Requester's id

parent_id[RW]

Parent request id

reason[RW]

Reason for the decision. Optional. Present normally when the decision is denied

requester_name[RW]

Requester's full name

state[RW]

The state of the request. Possible value: canceled, completed, failed, notified, skipped, or started

workflow_id[RW]

Associate workflow id. Available only if the request is a leaf node

Public Class Methods

attribute_map() click to toggle source

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

# File lib/insights-approval-api-client/models/request.rb, line 91
def self.attribute_map
  {
    :'id' => :'id',
    :'state' => :'state',
    :'decision' => :'decision',
    :'reason' => :'reason',
    :'workflow_id' => :'workflow_id',
    :'created_at' => :'created_at',
    :'notified_at' => :'notified_at',
    :'finished_at' => :'finished_at',
    :'number_of_children' => :'number_of_children',
    :'number_of_finished_children' => :'number_of_finished_children',
    :'owner' => :'owner',
    :'requester_name' => :'requester_name',
    :'name' => :'name',
    :'description' => :'description',
    :'group_name' => :'group_name',
    :'parent_id' => :'parent_id',
    :'metadata' => :'metadata'
  }
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/insights-approval-api-client/models/request.rb, line 306
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/insights-approval-api-client/models/request.rb, line 148
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `ApprovalApiClient::Request` 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 `ApprovalApiClient::Request`. 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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

List of attributes with nullable: true

# File lib/insights-approval-api-client/models/request.rb, line 137
def self.openapi_nullable
  Set.new([
    :'reason',
    :'workflow_id',
    :'notified_at',
    :'finished_at',
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/insights-approval-api-client/models/request.rb, line 114
def self.openapi_types
  {
    :'id' => :'String',
    :'state' => :'String',
    :'decision' => :'String',
    :'reason' => :'String',
    :'workflow_id' => :'String',
    :'created_at' => :'DateTime',
    :'notified_at' => :'DateTime',
    :'finished_at' => :'DateTime',
    :'number_of_children' => :'Integer',
    :'number_of_finished_children' => :'Integer',
    :'owner' => :'String',
    :'requester_name' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'group_name' => :'String',
    :'parent_id' => :'String',
    :'metadata' => :'Object'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/insights-approval-api-client/models/request.rb, line 269
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      state == o.state &&
      decision == o.decision &&
      reason == o.reason &&
      workflow_id == o.workflow_id &&
      created_at == o.created_at &&
      notified_at == o.notified_at &&
      finished_at == o.finished_at &&
      number_of_children == o.number_of_children &&
      number_of_finished_children == o.number_of_finished_children &&
      owner == o.owner &&
      requester_name == o.requester_name &&
      name == o.name &&
      description == o.description &&
      group_name == o.group_name &&
      parent_id == o.parent_id &&
      metadata == o.metadata
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/insights-approval-api-client/models/request.rb, line 334
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
    ApprovalApiClient.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/insights-approval-api-client/models/request.rb, line 403
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/insights-approval-api-client/models/request.rb, line 313
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
decision=(decision) click to toggle source

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

# File lib/insights-approval-api-client/models/request.rb, line 259
def decision=(decision)
  validator = EnumAttributeValidator.new('String', ["undecided", "approved", "canceled", "denied", "error"])
  unless validator.valid?(decision)
    fail ArgumentError, "invalid value for \"decision\", must be one of #{validator.allowable_values}."
  end
  @decision = decision
end
eql?(o) click to toggle source

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

# File lib/insights-approval-api-client/models/request.rb, line 293
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/insights-approval-api-client/models/request.rb, line 299
def hash
  [id, state, decision, reason, workflow_id, created_at, notified_at, finished_at, number_of_children, number_of_finished_children, owner, requester_name, name, description, group_name, parent_id, metadata].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/insights-approval-api-client/models/request.rb, line 232
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
state=(state) click to toggle source

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

# File lib/insights-approval-api-client/models/request.rb, line 249
def state=(state)
  validator = EnumAttributeValidator.new('String', ["canceled", "completed", "failed", "notified", "pending", "skipped", "started"])
  unless validator.valid?(state)
    fail ArgumentError, "invalid value for \"state\", must be one of #{validator.allowable_values}."
  end
  @state = state
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/insights-approval-api-client/models/request.rb, line 379
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/insights-approval-api-client/models/request.rb, line 385
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/insights-approval-api-client/models/request.rb, line 373
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/insights-approval-api-client/models/request.rb, line 239
def valid?
  state_validator = EnumAttributeValidator.new('String', ["canceled", "completed", "failed", "notified", "pending", "skipped", "started"])
  return false unless state_validator.valid?(@state)
  decision_validator = EnumAttributeValidator.new('String', ["undecided", "approved", "canceled", "denied", "error"])
  return false unless decision_validator.valid?(@decision)
  true
end