Class: OCI::MediaServices::Models::MediaWorkflowJobFact

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/media_services/models/media_workflow_job_fact.rb

Overview

One fact of a list of facts associated to a MediaWorkflowJob that presents a point-in-time snapshot of the resources, data and events that were composed to generate a runnable job. This information will be used internally to trouble-shoot problematic workflows or jobs.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MediaWorkflowJobFact

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :media_workflow_job_id (String) —

    The value to assign to the #media_workflow_job_id property

  • :key (Integer) —

    The value to assign to the #key property

  • :name (String) —

    The value to assign to the #name property

  • :type (String) —

    The value to assign to the #type property

  • :detail (Hash<String, Object>) —

    The value to assign to the #detail property



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/oci/media_services/models/media_workflow_job_fact.rb', line 71

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 }

  self.media_workflow_job_id = attributes[:'mediaWorkflowJobId'] if attributes[:'mediaWorkflowJobId']

  raise 'You cannot provide both :mediaWorkflowJobId and :media_workflow_job_id' if attributes.key?(:'mediaWorkflowJobId') && attributes.key?(:'media_workflow_job_id')

  self.media_workflow_job_id = attributes[:'media_workflow_job_id'] if attributes[:'media_workflow_job_id']

  self.key = attributes[:'key'] if attributes[:'key']

  self.name = attributes[:'name'] if attributes[:'name']

  self.type = attributes[:'type'] if attributes[:'type']

  self.detail = attributes[:'detail'] if attributes[:'detail']
end

Instance Attribute Details

#detail ⇒ Hash<String, Object>

[Required] The body of the detail captured as JSON.

Returns:

  • (Hash<String, Object>) 


32
33
34
 
# File 'lib/oci/media_services/models/media_workflow_job_fact.rb', line 32

def detail
  @detail
end

#key ⇒ Integer

[Required] System generated serial number to uniquely identify a detail in order within a MediaWorkflowJob.

Returns:

  • (Integer) 


20
21
22
 
# File 'lib/oci/media_services/models/media_workflow_job_fact.rb', line 20

def key
  @key
end

#media_workflow_job_id ⇒ String

[Required] Reference to the parent job.

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/media_services/models/media_workflow_job_fact.rb', line 16

def media_workflow_job_id
  @media_workflow_job_id
end

#name ⇒ String

[Required] Unique name. It is read-only and generated for the fact.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/media_services/models/media_workflow_job_fact.rb', line 24

def name
  @name
end

#type ⇒ String

[Required] The type of information contained in this detail.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/media_services/models/media_workflow_job_fact.rb', line 28

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/oci/media_services/models/media_workflow_job_fact.rb', line 35

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'media_workflow_job_id': :'mediaWorkflowJobId',
    'key': :'key',
    'name': :'name',
    'type': :'type',
    'detail': :'detail'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/oci/media_services/models/media_workflow_job_fact.rb', line 48

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'media_workflow_job_id': :'String',
    'key': :'Integer',
    'name': :'String',
    'type': :'String',
    'detail': :'Hash<String, Object>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



99
100
101
102
103
104
105
106
107
108
 
# File 'lib/oci/media_services/models/media_workflow_job_fact.rb', line 99

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    media_workflow_job_id == other.media_workflow_job_id &&
    key == other.key &&
    name == other.name &&
    type == other.type &&
    detail == other.detail
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/oci/media_services/models/media_workflow_job_fact.rb', line 133

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
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(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

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


113
114
115
 
# File 'lib/oci/media_services/models/media_workflow_job_fact.rb', line 113

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



122
123
124
 
# File 'lib/oci/media_services/models/media_workflow_job_fact.rb', line 122

def hash
  [media_workflow_job_id, key, name, type, detail].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



166
167
168
169
170
171
172
173
174
175
 
# File 'lib/oci/media_services/models/media_workflow_job_fact.rb', line 166

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



160
161
162
 
# File 'lib/oci/media_services/models/media_workflow_job_fact.rb', line 160

def to_s
  to_hash.to_s
end