Class: OCI::DataCatalog::Models::JobLog

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_catalog/models/job_log.rb

Overview

Job log details. A job log is an audit log record inserted during the lifecycle of a job execution instance.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ JobLog

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :key (String)

    The value to assign to the #key property

  • :job_execution_key (String)

    The value to assign to the #job_execution_key property

  • :created_by_id (String)

    The value to assign to the #created_by_id property

  • :updated_by_id (String)

    The value to assign to the #updated_by_id property

  • :time_updated (DateTime)

    The value to assign to the #time_updated property

  • :time_created (DateTime)

    The value to assign to the #time_created property

  • :severity (String)

    The value to assign to the #severity property

  • :log_message (String)

    The value to assign to the #log_message property

  • :uri (String)

    The value to assign to the #uri property



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
# File 'lib/oci/data_catalog/models/job_log.rb', line 100

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.key = attributes[:'key'] if attributes[:'key']

  self.job_execution_key = attributes[:'jobExecutionKey'] if attributes[:'jobExecutionKey']

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

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

  self.created_by_id = attributes[:'createdById'] if attributes[:'createdById']

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

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

  self.updated_by_id = attributes[:'updatedById'] if attributes[:'updatedById']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

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

  self.log_message = attributes[:'logMessage'] if attributes[:'logMessage']

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

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

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

Instance Attribute Details

#created_by_idString

OCID of the user who created the log record for this job. Usually the executor of the job instance.

Returns:

  • (String)


22
23
24
# File 'lib/oci/data_catalog/models/job_log.rb', line 22

def created_by_id
  @created_by_id
end

#job_execution_keyString

The unique key of the parent job execution for which the log resource was created.

Returns:

  • (String)


17
18
19
# File 'lib/oci/data_catalog/models/job_log.rb', line 17

def job_execution_key
  @job_execution_key
end

#keyString

[Required] Unique key of the job log that is immutable.

Returns:

  • (String)


13
14
15
# File 'lib/oci/data_catalog/models/job_log.rb', line 13

def key
  @key
end

#log_messageString

Message for this job log.

Returns:

  • (String)


45
46
47
# File 'lib/oci/data_catalog/models/job_log.rb', line 45

def log_message
  @log_message
end

#severityString

Severity level for this log.

Returns:

  • (String)


41
42
43
# File 'lib/oci/data_catalog/models/job_log.rb', line 41

def severity
  @severity
end

#time_createdDateTime

The date and time the job log was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z

Returns:

  • (DateTime)


37
38
39
# File 'lib/oci/data_catalog/models/job_log.rb', line 37

def time_created
  @time_created
end

#time_updatedDateTime

Job log update time. An RFC3339 formatted datetime string.

Returns:

  • (DateTime)


31
32
33
# File 'lib/oci/data_catalog/models/job_log.rb', line 31

def time_updated
  @time_updated
end

#updated_by_idString

OCID of the user who created the log record for this job. Usually the executor of the job instance.

Returns:

  • (String)


27
28
29
# File 'lib/oci/data_catalog/models/job_log.rb', line 27

def updated_by_id
  @updated_by_id
end

#uriString

URI to the job log instance in the API.

Returns:

  • (String)


49
50
51
# File 'lib/oci/data_catalog/models/job_log.rb', line 49

def uri
  @uri
end

Class Method Details

.attribute_mapObject

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# File 'lib/oci/data_catalog/models/job_log.rb', line 52

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'job_execution_key': :'jobExecutionKey',
    'created_by_id': :'createdById',
    'updated_by_id': :'updatedById',
    'time_updated': :'timeUpdated',
    'time_created': :'timeCreated',
    'severity': :'severity',
    'log_message': :'logMessage',
    'uri': :'uri'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
# File 'lib/oci/data_catalog/models/job_log.rb', line 69

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'job_execution_key': :'String',
    'created_by_id': :'String',
    'updated_by_id': :'String',
    'time_updated': :'DateTime',
    'time_created': :'DateTime',
    'severity': :'String',
    'log_message': :'String',
    'uri': :'String'
    # 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



156
157
158
159
160
161
162
163
164
165
166
167
168
169
# File 'lib/oci/data_catalog/models/job_log.rb', line 156

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

  self.class == other.class &&
    key == other.key &&
    job_execution_key == other.job_execution_key &&
    created_by_id == other.created_by_id &&
    updated_by_id == other.updated_by_id &&
    time_updated == other.time_updated &&
    time_created == other.time_created &&
    severity == other.severity &&
    log_message == other.log_message &&
    uri == other.uri
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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
# File 'lib/oci/data_catalog/models/job_log.rb', line 194

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


174
175
176
# File 'lib/oci/data_catalog/models/job_log.rb', line 174

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



183
184
185
# File 'lib/oci/data_catalog/models/job_log.rb', line 183

def hash
  [key, job_execution_key, created_by_id, updated_by_id, time_updated, time_created, severity, log_message, uri].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



227
228
229
230
231
232
233
234
235
236
# File 'lib/oci/data_catalog/models/job_log.rb', line 227

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



221
222
223
# File 'lib/oci/data_catalog/models/job_log.rb', line 221

def to_s
  to_hash.to_s
end