Class: OCI::LogAnalytics::Models::RuleSummary

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

Overview

A generic rule summary object - represents an ingest time rule or a scheduled task.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
KIND_ENUM = 
[
  KIND_INGEST_TIME = 'INGEST_TIME'.freeze,
  KIND_SAVED_SEARCH = 'SAVED_SEARCH'.freeze,
  KIND_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LAST_EXECUTION_STATUS_ENUM = 
[
  LAST_EXECUTION_STATUS_FAILED = 'FAILED'.freeze,
  LAST_EXECUTION_STATUS_SUCCEEDED = 'SUCCEEDED'.freeze,
  LAST_EXECUTION_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
TASK_STATUS_ENUM = 
[
  TASK_STATUS_READY = 'READY'.freeze,
  TASK_STATUS_PAUSED = 'PAUSED'.freeze,
  TASK_STATUS_COMPLETED = 'COMPLETED'.freeze,
  TASK_STATUS_BLOCKED = 'BLOCKED'.freeze,
  TASK_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RuleSummary

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

  • :description (String) —

    The value to assign to the #description property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

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

    The value to assign to the #defined_tags property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :kind (String) —

    The value to assign to the #kind property

  • :target_service (String) —

    The value to assign to the #target_service property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :is_enabled (BOOLEAN) —

    The value to assign to the #is_enabled property

  • :last_execution_status (String) —

    The value to assign to the #last_execution_status property

  • :time_last_executed (DateTime) —

    The value to assign to the #time_last_executed property

  • :task_status (String) —

    The value to assign to the #task_status property



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/oci/log_analytics/models/rule_summary.rb', line 177

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

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

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

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

  self.target_service = attributes[:'targetService'] if attributes[:'targetService']

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

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

  self.is_enabled = attributes[:'isEnabled'] unless attributes[:'isEnabled'].nil?

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

  self.is_enabled = attributes[:'is_enabled'] unless attributes[:'is_enabled'].nil?

  self.last_execution_status = attributes[:'lastExecutionStatus'] if attributes[:'lastExecutionStatus']

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

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

  self.time_last_executed = attributes[:'timeLastExecuted'] if attributes[:'timeLastExecuted']

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

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

  self.task_status = attributes[:'taskStatus'] if attributes[:'taskStatus']

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

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

Instance Attribute Details

#compartment_id ⇒ String

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

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/log_analytics/models/rule_summary.rb', line 52

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


74
75
76
 
# File 'lib/oci/log_analytics/models/rule_summary.rb', line 74

def defined_tags
  @defined_tags
end

#description ⇒ String

Description for this resource.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/log_analytics/models/rule_summary.rb', line 48

def description
  @description
end

#display_name ⇒ String

[Required] The ingest time rule or scheduled task display name.

Returns:

  • (String) 


92
93
94
 
# File 'lib/oci/log_analytics/models/rule_summary.rb', line 92

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


68
69
70
 
# File 'lib/oci/log_analytics/models/rule_summary.rb', line 68

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The log analytics entity OCID. This ID is a reference used by log analytics features and it represents a resource that is provisioned and managed by the customer on their premises or on the cloud.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/log_analytics/models/rule_summary.rb', line 43

def id
  @id
end

#is_enabled ⇒ BOOLEAN

A flag indicating whether or not the ingest time rule or scheduled task is enabled.

Returns:

  • (BOOLEAN) 


96
97
98
 
# File 'lib/oci/log_analytics/models/rule_summary.rb', line 96

def is_enabled
  @is_enabled
end

#kind ⇒ String

[Required] The kind of rule - either an ingest time rule or a scheduled task.

Returns:

  • (String) 


84
85
86
 
# File 'lib/oci/log_analytics/models/rule_summary.rb', line 84

def kind
  @kind
end

#last_execution_status ⇒ String

The most recent task execution status.

Returns:

  • (String) 


100
101
102
 
# File 'lib/oci/log_analytics/models/rule_summary.rb', line 100

def last_execution_status
  @last_execution_status
end

#lifecycle_state ⇒ String

The current state of the Log Analytics rule.

Returns:

  • (String) 


79
80
81
 
# File 'lib/oci/log_analytics/models/rule_summary.rb', line 79

def lifecycle_state
  @lifecycle_state
end

#target_service ⇒ String

The target service.

Returns:

  • (String) 


88
89
90
 
# File 'lib/oci/log_analytics/models/rule_summary.rb', line 88

def target_service
  @target_service
end

#task_status ⇒ String

The task status of the rule.

Returns:

  • (String) 


108
109
110
 
# File 'lib/oci/log_analytics/models/rule_summary.rb', line 108

def task_status
  @task_status
end

#time_created ⇒ DateTime

The date and time the resource was created, in the format defined by RFC3339.

Returns:

  • (DateTime) 


57
58
59
 
# File 'lib/oci/log_analytics/models/rule_summary.rb', line 57

def time_created
  @time_created
end

#time_last_executed ⇒ DateTime

The date and time the scheduled task last executed, in the format defined by RFC3339.

Returns:

  • (DateTime) 


104
105
106
 
# File 'lib/oci/log_analytics/models/rule_summary.rb', line 104

def time_last_executed
  @time_last_executed
end

#time_updated ⇒ DateTime

The date and time the resource was last updated, in the format defined by RFC3339.

Returns:

  • (DateTime) 


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

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/oci/log_analytics/models/rule_summary.rb', line 111

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'lifecycle_state': :'lifecycleState',
    'kind': :'kind',
    'target_service': :'targetService',
    'display_name': :'displayName',
    'is_enabled': :'isEnabled',
    'last_execution_status': :'lastExecutionStatus',
    'time_last_executed': :'timeLastExecuted',
    'task_status': :'taskStatus'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'lifecycle_state': :'String',
    'kind': :'String',
    'target_service': :'String',
    'display_name': :'String',
    'is_enabled': :'BOOLEAN',
    'last_execution_status': :'String',
    'time_last_executed': :'DateTime',
    'task_status': :'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



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/oci/log_analytics/models/rule_summary.rb', line 321

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

  self.class == other.class &&
    id == other.id &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    lifecycle_state == other.lifecycle_state &&
    kind == other.kind &&
    target_service == other.target_service &&
    display_name == other.display_name &&
    is_enabled == other.is_enabled &&
    last_execution_status == other.last_execution_status &&
    time_last_executed == other.time_last_executed &&
    task_status == other.task_status
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



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/oci/log_analytics/models/rule_summary.rb', line 365

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


345
346
347
 
# File 'lib/oci/log_analytics/models/rule_summary.rb', line 345

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



354
355
356
 
# File 'lib/oci/log_analytics/models/rule_summary.rb', line 354

def hash
  [id, description, compartment_id, time_created, time_updated, freeform_tags, defined_tags, lifecycle_state, kind, target_service, display_name, is_enabled, last_execution_status, time_last_executed, task_status].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



398
399
400
401
402
403
404
405
406
407
 
# File 'lib/oci/log_analytics/models/rule_summary.rb', line 398

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



392
393
394
 
# File 'lib/oci/log_analytics/models/rule_summary.rb', line 392

def to_s
  to_hash.to_s
end