Class: OCI::ApmTraces::Models::ScheduledQuerySummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/apm_traces/models/scheduled_query_summary.rb

Overview

Scheduled Query object.

Constant Summary collapse

SCHEDULED_QUERY_PROCESSING_TYPE_ENUM = 
[
  SCHEDULED_QUERY_PROCESSING_TYPE_EXPORT = 'EXPORT'.freeze,
  SCHEDULED_QUERY_PROCESSING_TYPE_QUERY = 'QUERY'.freeze,
  SCHEDULED_QUERY_PROCESSING_TYPE_ALERT = 'ALERT'.freeze,
  SCHEDULED_QUERY_PROCESSING_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
SCHEDULED_QUERY_PROCESSING_SUB_TYPE_ENUM = 
[
  SCHEDULED_QUERY_PROCESSING_SUB_TYPE_OBJECT_STORAGE = 'OBJECT_STORAGE'.freeze,
  SCHEDULED_QUERY_PROCESSING_SUB_TYPE_STREAMING = 'STREAMING'.freeze,
  SCHEDULED_QUERY_PROCESSING_SUB_TYPE_CUSTOM_METRIC = 'CUSTOM_METRIC'.freeze,
  SCHEDULED_QUERY_PROCESSING_SUB_TYPE_NONE = 'NONE'.freeze,
  SCHEDULED_QUERY_PROCESSING_SUB_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
SCHEDULED_QUERY_RETENTION_CRITERIA_ENUM = 
[
  SCHEDULED_QUERY_RETENTION_CRITERIA_KEEP_DATA_UNTIL_RETENTION_PERIOD = 'KEEP_DATA_UNTIL_RETENTION_PERIOD'.freeze,
  SCHEDULED_QUERY_RETENTION_CRITERIA_UPDATE = 'UPDATE'.freeze,
  SCHEDULED_QUERY_RETENTION_CRITERIA_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ScheduledQuerySummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
261
262
263
264
 
# File 'lib/oci/apm_traces/models/scheduled_query_summary.rb', line 179

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

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

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

  self.scheduled_query_processing_type = attributes[:'scheduledQueryProcessingType'] if attributes[:'scheduledQueryProcessingType']

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

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

  self.scheduled_query_text = attributes[:'scheduledQueryText'] if attributes[:'scheduledQueryText']

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

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

  self.scheduled_query_schedule = attributes[:'scheduledQuerySchedule'] if attributes[:'scheduledQuerySchedule']

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

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

  self.scheduled_query_processing_sub_type = attributes[:'scheduledQueryProcessingSubType'] if attributes[:'scheduledQueryProcessingSubType']

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

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

  self.scheduled_query_processing_configuration = attributes[:'scheduledQueryProcessingConfiguration'] if attributes[:'scheduledQueryProcessingConfiguration']

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

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

  self.scheduled_query_instances = attributes[:'scheduledQueryInstances'] if attributes[:'scheduledQueryInstances']

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

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

  self.scheduled_query_next_run_in_ms = attributes[:'scheduledQueryNextRunInMs'] if attributes[:'scheduledQueryNextRunInMs']

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

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

  self.scheduled_query_retention_criteria = attributes[:'scheduledQueryRetentionCriteria'] if attributes[:'scheduledQueryRetentionCriteria']

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

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

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

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

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

Instance Attribute Details

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


107
108
109
 
# File 'lib/oci/apm_traces/models/scheduled_query_summary.rb', line 107

def defined_tags
  @defined_tags
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>) 


101
102
103
 
# File 'lib/oci/apm_traces/models/scheduled_query_summary.rb', line 101

def freeform_tags
  @freeform_tags
end

#id ⇒ String

The OCID of the scheduled query . An OCID is generated when the scheduled query is created.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/apm_traces/models/scheduled_query_summary.rb', line 48

def id
  @id
end

#lifecycle_state ⇒ String

The current lifecycle state of the Scheduled Query.

Returns:

  • (String) 


95
96
97
 
# File 'lib/oci/apm_traces/models/scheduled_query_summary.rb', line 95

def lifecycle_state
  @lifecycle_state
end

#scheduled_query_instances ⇒ String

Scheduled query instances.

Returns:

  • (String) 


81
82
83
 
# File 'lib/oci/apm_traces/models/scheduled_query_summary.rb', line 81

def scheduled_query_instances
  @scheduled_query_instances
end

#scheduled_query_name ⇒ String

Name of the scheduled query.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/apm_traces/models/scheduled_query_summary.rb', line 53

def scheduled_query_name
  @scheduled_query_name
end

#scheduled_query_next_run_in_ms ⇒ Integer

Next run for the scheduled query.

Returns:

  • (Integer) 


86
87
88
 
# File 'lib/oci/apm_traces/models/scheduled_query_summary.rb', line 86

def scheduled_query_next_run_in_ms
  @scheduled_query_next_run_in_ms
end

#scheduled_query_processing_configuration ⇒ OCI::ApmTraces::Models::ScheduledQueryProcessingConfig

Returns:



76
77
78
 
# File 'lib/oci/apm_traces/models/scheduled_query_summary.rb', line 76

def scheduled_query_processing_configuration
  @scheduled_query_processing_configuration
end

#scheduled_query_processing_sub_type ⇒ String

Processing sub type of the scheduled query.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/apm_traces/models/scheduled_query_summary.rb', line 73

def scheduled_query_processing_sub_type
  @scheduled_query_processing_sub_type
end

#scheduled_query_processing_type ⇒ String

Processing type of the scheduled query.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/apm_traces/models/scheduled_query_summary.rb', line 58

def scheduled_query_processing_type
  @scheduled_query_processing_type
end

#scheduled_query_retention_criteria ⇒ String

Retention criteria for the scheduled query.

Returns:

  • (String) 


91
92
93
 
# File 'lib/oci/apm_traces/models/scheduled_query_summary.rb', line 91

def scheduled_query_retention_criteria
  @scheduled_query_retention_criteria
end

#scheduled_query_schedule ⇒ String

Schedule for the scheduled query.

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/apm_traces/models/scheduled_query_summary.rb', line 68

def scheduled_query_schedule
  @scheduled_query_schedule
end

#scheduled_query_text ⇒ String

Scheduled query to be run.

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/apm_traces/models/scheduled_query_summary.rb', line 63

def scheduled_query_text
  @scheduled_query_text
end

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

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


113
114
115
 
# File 'lib/oci/apm_traces/models/scheduled_query_summary.rb', line 113

def system_tags
  @system_tags
end

Class Method Details

.attribute_map ⇒ Object

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



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/oci/apm_traces/models/scheduled_query_summary.rb', line 116

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'scheduled_query_name': :'scheduledQueryName',
    'scheduled_query_processing_type': :'scheduledQueryProcessingType',
    'scheduled_query_text': :'scheduledQueryText',
    'scheduled_query_schedule': :'scheduledQuerySchedule',
    'scheduled_query_processing_sub_type': :'scheduledQueryProcessingSubType',
    'scheduled_query_processing_configuration': :'scheduledQueryProcessingConfiguration',
    'scheduled_query_instances': :'scheduledQueryInstances',
    'scheduled_query_next_run_in_ms': :'scheduledQueryNextRunInMs',
    'scheduled_query_retention_criteria': :'scheduledQueryRetentionCriteria',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/oci/apm_traces/models/scheduled_query_summary.rb', line 138

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'scheduled_query_name': :'String',
    'scheduled_query_processing_type': :'String',
    'scheduled_query_text': :'String',
    'scheduled_query_schedule': :'String',
    'scheduled_query_processing_sub_type': :'String',
    'scheduled_query_processing_configuration': :'OCI::ApmTraces::Models::ScheduledQueryProcessingConfig',
    'scheduled_query_instances': :'String',
    'scheduled_query_next_run_in_ms': :'Integer',
    'scheduled_query_retention_criteria': :'String',
    'lifecycle_state': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, 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



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/oci/apm_traces/models/scheduled_query_summary.rb', line 325

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

  self.class == other.class &&
    id == other.id &&
    scheduled_query_name == other.scheduled_query_name &&
    scheduled_query_processing_type == other.scheduled_query_processing_type &&
    scheduled_query_text == other.scheduled_query_text &&
    scheduled_query_schedule == other.scheduled_query_schedule &&
    scheduled_query_processing_sub_type == other.scheduled_query_processing_sub_type &&
    scheduled_query_processing_configuration == other.scheduled_query_processing_configuration &&
    scheduled_query_instances == other.scheduled_query_instances &&
    scheduled_query_next_run_in_ms == other.scheduled_query_next_run_in_ms &&
    scheduled_query_retention_criteria == other.scheduled_query_retention_criteria &&
    lifecycle_state == other.lifecycle_state &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/oci/apm_traces/models/scheduled_query_summary.rb', line 368

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


348
349
350
 
# File 'lib/oci/apm_traces/models/scheduled_query_summary.rb', line 348

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



357
358
359
 
# File 'lib/oci/apm_traces/models/scheduled_query_summary.rb', line 357

def hash
  [id, scheduled_query_name, scheduled_query_processing_type, scheduled_query_text, scheduled_query_schedule, scheduled_query_processing_sub_type, scheduled_query_processing_configuration, scheduled_query_instances, scheduled_query_next_run_in_ms, scheduled_query_retention_criteria, lifecycle_state, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



401
402
403
404
405
406
407
408
409
410
 
# File 'lib/oci/apm_traces/models/scheduled_query_summary.rb', line 401

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



395
396
397
 
# File 'lib/oci/apm_traces/models/scheduled_query_summary.rb', line 395

def to_s
  to_hash.to_s
end