Class: OCI::CloudGuard::Models::AdhocQueryResultSummary

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

Overview

Adhoc query result resource from running on a resource.

Constant Summary collapse

STATE_ENUM = 
[
  STATE_ACCEPTED = 'ACCEPTED'.freeze,
  STATE_CREATED = 'CREATED'.freeze,
  STATE_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  STATE_COMPLETED = 'COMPLETED'.freeze,
  STATE_PARTIALLY_COMPLETED = 'PARTIALLY_COMPLETED'.freeze,
  STATE_FAILED = 'FAILED'.freeze,
  STATE_EXPIRED = 'EXPIRED'.freeze,
  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 = {}) ⇒ AdhocQueryResultSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :host_id (String) —

    The value to assign to the #host_id property

  • :state (String) —

    The value to assign to the #state property

  • :region (String) —

    The value to assign to the #region property

  • :time_submitted (DateTime) —

    The value to assign to the #time_submitted property

  • :error_message (String) —

    The value to assign to the #error_message property

  • :result_count (Integer) —

    The value to assign to the #result_count property

  • :result (Array<Hash<String, String>>) —

    The value to assign to the #result 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

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

    The value to assign to the #system_tags property



126
127
128
129
130
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
 
# File 'lib/oci/cloud_guard/models/adhoc_query_result_summary.rb', line 126

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

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

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

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

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

  self.time_submitted = attributes[:'timeSubmitted'] if attributes[:'timeSubmitted']

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

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

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

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

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

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

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


63
64
65
 
# File 'lib/oci/cloud_guard/models/adhoc_query_result_summary.rb', line 63

def defined_tags
  @defined_tags
end

#error_message ⇒ String

Optional error message

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/cloud_guard/models/adhoc_query_result_summary.rb', line 41

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


57
58
59
 
# File 'lib/oci/cloud_guard/models/adhoc_query_result_summary.rb', line 57

def freeform_tags
  @freeform_tags
end

#host_id ⇒ String

[Required] Resource this result belongs to

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/cloud_guard/models/adhoc_query_result_summary.rb', line 25

def host_id
  @host_id
end

#region ⇒ String

[Required] The region this adhoc work request is running in, needed for tracking when work request is synced to reporting region

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/cloud_guard/models/adhoc_query_result_summary.rb', line 33

def region
  @region
end

#result ⇒ Array<Hash<String, String>>

Result of the adhoc query this result resource is associated with

Returns:

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


49
50
51
 
# File 'lib/oci/cloud_guard/models/adhoc_query_result_summary.rb', line 49

def result
  @result
end

#result_count ⇒ Integer

Number of records returned for the query results on this host

Returns:

  • (Integer) 


45
46
47
 
# File 'lib/oci/cloud_guard/models/adhoc_query_result_summary.rb', line 45

def result_count
  @result_count
end

#state ⇒ String

[Required] Status of the query

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/cloud_guard/models/adhoc_query_result_summary.rb', line 29

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


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

def system_tags
  @system_tags
end

#time_submitted ⇒ DateTime

The time the adhoc result was submitted. An RFC3339 formatted datetime string

Returns:

  • (DateTime) 


37
38
39
 
# File 'lib/oci/cloud_guard/models/adhoc_query_result_summary.rb', line 37

def time_submitted
  @time_submitted
end

Class Method Details

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/oci/cloud_guard/models/adhoc_query_result_summary.rb', line 75

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'host_id': :'hostId',
    'state': :'state',
    'region': :'region',
    'time_submitted': :'timeSubmitted',
    'error_message': :'errorMessage',
    'result_count': :'resultCount',
    'result': :'result',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/oci/cloud_guard/models/adhoc_query_result_summary.rb', line 93

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'host_id': :'String',
    'state': :'String',
    'region': :'String',
    'time_submitted': :'DateTime',
    'error_message': :'String',
    'result_count': :'Integer',
    'result': :'Array<Hash<String, 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



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/oci/cloud_guard/models/adhoc_query_result_summary.rb', line 201

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

  self.class == other.class &&
    host_id == other.host_id &&
    state == other.state &&
    region == other.region &&
    time_submitted == other.time_submitted &&
    error_message == other.error_message &&
    result_count == other.result_count &&
    result == other.result &&
    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



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/oci/cloud_guard/models/adhoc_query_result_summary.rb', line 240

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


220
221
222
 
# File 'lib/oci/cloud_guard/models/adhoc_query_result_summary.rb', line 220

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



229
230
231
 
# File 'lib/oci/cloud_guard/models/adhoc_query_result_summary.rb', line 229

def hash
  [host_id, state, region, time_submitted, error_message, result_count, result, 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



273
274
275
276
277
278
279
280
281
282
 
# File 'lib/oci/cloud_guard/models/adhoc_query_result_summary.rb', line 273

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



267
268
269
 
# File 'lib/oci/cloud_guard/models/adhoc_query_result_summary.rb', line 267

def to_s
  to_hash.to_s
end