Class: OCI::CloudGuard::Models::AdhocQuery

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/cloud_guard/models/adhoc_query.rb

Overview

Details of a adhoc query.

Constant Summary collapse

STATUS_ENUM = 
[
  STATUS_CREATING = 'CREATING'.freeze,
  STATUS_CREATED = 'CREATED'.freeze,
  STATUS_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  STATUS_PARTIALLY_COMPLETED = 'PARTIALLY_COMPLETED'.freeze,
  STATUS_EXPIRED = 'EXPIRED'.freeze,
  STATUS_COMPLETED = 'COMPLETED'.freeze,
  STATUS_FAILED = 'FAILED'.freeze,
  STATUS_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_INACTIVE = 'INACTIVE'.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 = {}) ⇒ AdhocQuery

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
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
 
# File 'lib/oci/cloud_guard/models/adhoc_query.rb', line 158

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

  self.adhoc_query_regional_details = attributes[:'adhocQueryRegionalDetails'] if attributes[:'adhocQueryRegionalDetails']

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

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

  self.adhoc_query_details = attributes[:'adhocQueryDetails'] if attributes[:'adhocQueryDetails']

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

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

  self.error_message = attributes[:'errorMessage'] if attributes[:'errorMessage']

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

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

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

  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

#adhoc_query_details ⇒ OCI::CloudGuard::Models::AdhocQueryDetails

This attribute is required.

Returns:



60
61
62
 
# File 'lib/oci/cloud_guard/models/adhoc_query.rb', line 60

def adhoc_query_details
  @adhoc_query_details
end

#adhoc_query_regional_details ⇒ Array<OCI::CloudGuard::Models::AdhocQueryRegionalDetails>

Instance level status for each region

Returns:



56
57
58
 
# File 'lib/oci/cloud_guard/models/adhoc_query.rb', line 56

def adhoc_query_regional_details
  @adhoc_query_regional_details
end

#compartment_id ⇒ String

[Required] Compartment OCID of the adhoc query

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/cloud_guard/models/adhoc_query.rb', line 40

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


86
87
88
 
# File 'lib/oci/cloud_guard/models/adhoc_query.rb', line 86

def defined_tags
  @defined_tags
end

#error_message ⇒ String

Error message to show on UI in case of failure

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/cloud_guard/models/adhoc_query.rb', line 64

def error_message
  @error_message
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\"}

Avoid entering confidential information.

Returns:

  • (Hash<String, String>) 


80
81
82
 
# File 'lib/oci/cloud_guard/models/adhoc_query.rb', line 80

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] OCID for the adhoc query

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/cloud_guard/models/adhoc_query.rb', line 36

def id
  @id
end

#lifecycle_state ⇒ String

The current lifecycle state of the resource.

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/cloud_guard/models/adhoc_query.rb', line 72

def lifecycle_state
  @lifecycle_state
end

#locks ⇒ Array<OCI::CloudGuard::Models::ResourceLock>

Locks associated with this resource.

Returns:



68
69
70
 
# File 'lib/oci/cloud_guard/models/adhoc_query.rb', line 68

def locks
  @locks
end

#status ⇒ String

[Required] Status of the adhoc query

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/cloud_guard/models/adhoc_query.rb', line 52

def status
  @status
end

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

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.

Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


95
96
97
 
# File 'lib/oci/cloud_guard/models/adhoc_query.rb', line 95

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

The date and time the adhoc query was created. Format defined by RFC3339.

Returns:

  • (DateTime) 


44
45
46
 
# File 'lib/oci/cloud_guard/models/adhoc_query.rb', line 44

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time the adhoc query was updated. Format defined by RFC3339.

Returns:

  • (DateTime) 


48
49
50
 
# File 'lib/oci/cloud_guard/models/adhoc_query.rb', line 48

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'status': :'status',
    'adhoc_query_regional_details': :'adhocQueryRegionalDetails',
    'adhoc_query_details': :'adhocQueryDetails',
    'error_message': :'errorMessage',
    'locks': :'locks',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/oci/cloud_guard/models/adhoc_query.rb', line 119

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'status': :'String',
    'adhoc_query_regional_details': :'Array<OCI::CloudGuard::Models::AdhocQueryRegionalDetails>',
    'adhoc_query_details': :'OCI::CloudGuard::Models::AdhocQueryDetails',
    'error_message': :'String',
    'locks': :'Array<OCI::CloudGuard::Models::ResourceLock>',
    '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



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/oci/cloud_guard/models/adhoc_query.rb', line 264

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    status == other.status &&
    adhoc_query_regional_details == other.adhoc_query_regional_details &&
    adhoc_query_details == other.adhoc_query_details &&
    error_message == other.error_message &&
    locks == other.locks &&
    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



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/oci/cloud_guard/models/adhoc_query.rb', line 306

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


286
287
288
 
# File 'lib/oci/cloud_guard/models/adhoc_query.rb', line 286

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



295
296
297
 
# File 'lib/oci/cloud_guard/models/adhoc_query.rb', line 295

def hash
  [id, compartment_id, time_created, time_updated, status, adhoc_query_regional_details, adhoc_query_details, error_message, locks, 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



339
340
341
342
343
344
345
346
347
348
 
# File 'lib/oci/cloud_guard/models/adhoc_query.rb', line 339

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



333
334
335
 
# File 'lib/oci/cloud_guard/models/adhoc_query.rb', line 333

def to_s
  to_hash.to_s
end