Class: OCI::LogAnalytics::Models::Rule

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

Overview

A generic rule 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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Rule

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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
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
 
# File 'lib/oci/log_analytics/models/rule.rb', line 162

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']
end

Instance Attribute Details

#compartment_id ⇒ String

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

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/log_analytics/models/rule.rb', line 44

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>>) 


66
67
68
 
# File 'lib/oci/log_analytics/models/rule.rb', line 66

def defined_tags
  @defined_tags
end

#description ⇒ String

Description for this resource.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/log_analytics/models/rule.rb', line 40

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

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>) 


60
61
62
 
# File 'lib/oci/log_analytics/models/rule.rb', line 60

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) 


35
36
37
 
# File 'lib/oci/log_analytics/models/rule.rb', line 35

def id
  @id
end

#is_enabled ⇒ BOOLEAN

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

Returns:

  • (BOOLEAN) 


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

def is_enabled
  @is_enabled
end

#kind ⇒ String

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

Returns:

  • (String) 


76
77
78
 
# File 'lib/oci/log_analytics/models/rule.rb', line 76

def kind
  @kind
end

#last_execution_status ⇒ String

The most recent task execution status.

Returns:

  • (String) 


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

def last_execution_status
  @last_execution_status
end

#lifecycle_state ⇒ String

The current state of the logging analytics rule.

Returns:

  • (String) 


71
72
73
 
# File 'lib/oci/log_analytics/models/rule.rb', line 71

def lifecycle_state
  @lifecycle_state
end

#target_service ⇒ String

The target service.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/log_analytics/models/rule.rb', line 80

def target_service
  @target_service
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


49
50
51
 
# File 'lib/oci/log_analytics/models/rule.rb', line 49

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) 


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

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) 


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

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/oci/log_analytics/models/rule.rb', line 99

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'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/oci/log_analytics/models/rule.rb', line 121

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'
    # 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



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/oci/log_analytics/models/rule.rb', line 287

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
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



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/oci/log_analytics/models/rule.rb', line 330

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


310
311
312
 
# File 'lib/oci/log_analytics/models/rule.rb', line 310

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



319
320
321
 
# File 'lib/oci/log_analytics/models/rule.rb', line 319

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].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



363
364
365
366
367
368
369
370
371
372
 
# File 'lib/oci/log_analytics/models/rule.rb', line 363

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



357
358
359
 
# File 'lib/oci/log_analytics/models/rule.rb', line 357

def to_s
  to_hash.to_s
end