Class: OCI::LogAnalytics::Models::QueryWorkRequestSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/log_analytics/models/query_work_request_summary.rb

Overview

High level summary of query job work request.

Constant Summary collapse

MODE_ENUM = 
[
  MODE_FOREGROUND = 'FOREGROUND'.freeze,
  MODE_BACKGROUND = 'BACKGROUND'.freeze,
  MODE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
STATUS_ENUM = 
[
  STATUS_ACCEPTED = 'ACCEPTED'.freeze,
  STATUS_CANCELED = 'CANCELED'.freeze,
  STATUS_FAILED = 'FAILED'.freeze,
  STATUS_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  STATUS_SUCCEEDED = 'SUCCEEDED'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
OPERATION_TYPE_ENUM = 
[
  OPERATION_TYPE_EXECUTE_QUERY_JOB = 'EXECUTE_QUERY_JOB'.freeze,
  OPERATION_TYPE_EXECUTE_PURGE_JOB = 'EXECUTE_PURGE_JOB'.freeze,
  OPERATION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ QueryWorkRequestSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :time_started (DateTime) —

    The value to assign to the #time_started property

  • :time_accepted (DateTime) —

    The value to assign to the #time_accepted property

  • :time_finished (DateTime) —

    The value to assign to the #time_finished property

  • :time_expires (DateTime) —

    The value to assign to the #time_expires property

  • :mode (String) —

    The value to assign to the #mode property

  • :percent_complete (Integer) —

    The value to assign to the #percent_complete property

  • :status (String) —

    The value to assign to the #status property

  • :operation_type (String) —

    The value to assign to the #operation_type property



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/oci/log_analytics/models/query_work_request_summary.rb', line 131

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  self.time_started = attributes[:'timeStarted'] if attributes[:'timeStarted']

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

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

  self.time_accepted = attributes[:'timeAccepted'] if attributes[:'timeAccepted']

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

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

  self.time_finished = attributes[:'timeFinished'] if attributes[:'timeFinished']

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

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

  self.time_expires = attributes[:'timeExpires'] if attributes[:'timeExpires']

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

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

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

  self.percent_complete = attributes[:'percentComplete'] if attributes[:'percentComplete']

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

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

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

  self.operation_type = attributes[:'operationType'] if attributes[:'operationType']

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

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

Instance Attribute Details

#compartment_id ⇒ String

Compartment Identifier [OCID] (docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/log_analytics/models/query_work_request_summary.rb', line 41

def compartment_id
  @compartment_id
end

#id ⇒ String

[Required] Unique OCID identifier to reference this query job work Request with.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/log_analytics/models/query_work_request_summary.rb', line 37

def id
  @id
end

#mode ⇒ String

[Required] Current execution mode for the job.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/log_analytics/models/query_work_request_summary.rb', line 62

def mode
  @mode
end

#operation_type ⇒ String

Asynchronous action name.

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/log_analytics/models/query_work_request_summary.rb', line 77

def operation_type
  @operation_type
end

#percent_complete ⇒ Integer

Percentage progress completion of the query.

Returns:

  • (Integer) 


67
68
69
 
# File 'lib/oci/log_analytics/models/query_work_request_summary.rb', line 67

def percent_complete
  @percent_complete
end

#status ⇒ String

Work request status.

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/log_analytics/models/query_work_request_summary.rb', line 72

def status
  @status
end

#time_accepted ⇒ DateTime

When the work request was accepted. Should match timeStarted in all cases.

Returns:

  • (DateTime) 


50
51
52
 
# File 'lib/oci/log_analytics/models/query_work_request_summary.rb', line 50

def time_accepted
  @time_accepted
end

#time_expires ⇒ DateTime

When the work request will expire.

Returns:

  • (DateTime) 


58
59
60
 
# File 'lib/oci/log_analytics/models/query_work_request_summary.rb', line 58

def time_expires
  @time_expires
end

#time_finished ⇒ DateTime

When the work request finished execution.

Returns:

  • (DateTime) 


54
55
56
 
# File 'lib/oci/log_analytics/models/query_work_request_summary.rb', line 54

def time_finished
  @time_finished
end

#time_started ⇒ DateTime

[Required] When the work request started.

Returns:

  • (DateTime) 


45
46
47
 
# File 'lib/oci/log_analytics/models/query_work_request_summary.rb', line 45

def time_started
  @time_started
end

Class Method Details

.attribute_map ⇒ Object

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/oci/log_analytics/models/query_work_request_summary.rb', line 80

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'time_started': :'timeStarted',
    'time_accepted': :'timeAccepted',
    'time_finished': :'timeFinished',
    'time_expires': :'timeExpires',
    'mode': :'mode',
    'percent_complete': :'percentComplete',
    'status': :'status',
    'operation_type': :'operationType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/oci/log_analytics/models/query_work_request_summary.rb', line 98

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'time_started': :'DateTime',
    'time_accepted': :'DateTime',
    'time_finished': :'DateTime',
    'time_expires': :'DateTime',
    'mode': :'String',
    'percent_complete': :'Integer',
    'status': :'String',
    'operation_type': :'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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/oci/log_analytics/models/query_work_request_summary.rb', line 232

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    time_started == other.time_started &&
    time_accepted == other.time_accepted &&
    time_finished == other.time_finished &&
    time_expires == other.time_expires &&
    mode == other.mode &&
    percent_complete == other.percent_complete &&
    status == other.status &&
    operation_type == other.operation_type
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



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/oci/log_analytics/models/query_work_request_summary.rb', line 271

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


251
252
253
 
# File 'lib/oci/log_analytics/models/query_work_request_summary.rb', line 251

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



260
261
262
 
# File 'lib/oci/log_analytics/models/query_work_request_summary.rb', line 260

def hash
  [id, compartment_id, time_started, time_accepted, time_finished, time_expires, mode, percent_complete, status, operation_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



304
305
306
307
308
309
310
311
312
313
 
# File 'lib/oci/log_analytics/models/query_work_request_summary.rb', line 304

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



298
299
300
 
# File 'lib/oci/log_analytics/models/query_work_request_summary.rb', line 298

def to_s
  to_hash.to_s
end