Class: OCI::VnMonitoring::Models::PathAnalyzerTestSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/vn_monitoring/models/path_analyzer_test_summary.rb

Overview

Defines the summary of a PathAnalyzerTest resource.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PathAnalyzerTestSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
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
 
# File 'lib/oci/vn_monitoring/models/path_analyzer_test_summary.rb', line 141

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

  self.source_endpoint = attributes[:'sourceEndpoint'] if attributes[:'sourceEndpoint']

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

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

  self.destination_endpoint = attributes[:'destinationEndpoint'] if attributes[:'destinationEndpoint']

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

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

  self.protocol_parameters = attributes[:'protocolParameters'] if attributes[:'protocolParameters']

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

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

  self.query_options = attributes[:'queryOptions'] if attributes[:'queryOptions']

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

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

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

#compartment_id ⇒ String

[Required] The OCID of the PathAnalyzerTest resource's compartment.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/vn_monitoring/models/path_analyzer_test_summary.rb', line 24

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


69
70
71
 
# File 'lib/oci/vn_monitoring/models/path_analyzer_test_summary.rb', line 69

def defined_tags
  @defined_tags
end

#destination_endpoint ⇒ OCI::VnMonitoring::Models::Endpoint

This attribute is required.

Returns:



36
37
38
 
# File 'lib/oci/vn_monitoring/models/path_analyzer_test_summary.rb', line 36

def destination_endpoint
  @destination_endpoint
end

#display_name ⇒ String

[Required] A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/vn_monitoring/models/path_analyzer_test_summary.rb', line 20

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


63
64
65
 
# File 'lib/oci/vn_monitoring/models/path_analyzer_test_summary.rb', line 63

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] A unique identifier established when the resource is created. The identifier can't be changed later.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/vn_monitoring/models/path_analyzer_test_summary.rb', line 14

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of the PathAnalyzerTest resource.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/vn_monitoring/models/path_analyzer_test_summary.rb', line 57

def lifecycle_state
  @lifecycle_state
end

#protocol ⇒ Integer

[Required] The IP protocol to use for the PathAnalyzerTest resource.

Returns:

  • (Integer) 


28
29
30
 
# File 'lib/oci/vn_monitoring/models/path_analyzer_test_summary.rb', line 28

def protocol
  @protocol
end

#protocol_parameters ⇒ OCI::VnMonitoring::Models::ProtocolParameters

Returns:



39
40
41
 
# File 'lib/oci/vn_monitoring/models/path_analyzer_test_summary.rb', line 39

def protocol_parameters
  @protocol_parameters
end

#query_options ⇒ OCI::VnMonitoring::Models::QueryOptions

This attribute is required.

Returns:



43
44
45
 
# File 'lib/oci/vn_monitoring/models/path_analyzer_test_summary.rb', line 43

def query_options
  @query_options
end

#source_endpoint ⇒ OCI::VnMonitoring::Models::Endpoint

This attribute is required.

Returns:



32
33
34
 
# File 'lib/oci/vn_monitoring/models/path_analyzer_test_summary.rb', line 32

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


75
76
77
 
# File 'lib/oci/vn_monitoring/models/path_analyzer_test_summary.rb', line 75

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the PathAnalyzerTest resource was created, in the format defined by RFC3339.

Returns:

  • (DateTime) 


48
49
50
 
# File 'lib/oci/vn_monitoring/models/path_analyzer_test_summary.rb', line 48

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


53
54
55
 
# File 'lib/oci/vn_monitoring/models/path_analyzer_test_summary.rb', line 53

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/oci/vn_monitoring/models/path_analyzer_test_summary.rb', line 78

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'protocol': :'protocol',
    'source_endpoint': :'sourceEndpoint',
    'destination_endpoint': :'destinationEndpoint',
    'protocol_parameters': :'protocolParameters',
    'query_options': :'queryOptions',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'protocol': :'Integer',
    'source_endpoint': :'OCI::VnMonitoring::Models::Endpoint',
    'destination_endpoint': :'OCI::VnMonitoring::Models::Endpoint',
    'protocol_parameters': :'OCI::VnMonitoring::Models::ProtocolParameters',
    'query_options': :'OCI::VnMonitoring::Models::QueryOptions',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    '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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/oci/vn_monitoring/models/path_analyzer_test_summary.rb', line 231

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    protocol == other.protocol &&
    source_endpoint == other.source_endpoint &&
    destination_endpoint == other.destination_endpoint &&
    protocol_parameters == other.protocol_parameters &&
    query_options == other.query_options &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    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



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/oci/vn_monitoring/models/path_analyzer_test_summary.rb', line 274

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


254
255
256
 
# File 'lib/oci/vn_monitoring/models/path_analyzer_test_summary.rb', line 254

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



263
264
265
 
# File 'lib/oci/vn_monitoring/models/path_analyzer_test_summary.rb', line 263

def hash
  [id, display_name, compartment_id, protocol, source_endpoint, destination_endpoint, protocol_parameters, query_options, time_created, time_updated, 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



307
308
309
310
311
312
313
314
315
316
 
# File 'lib/oci/vn_monitoring/models/path_analyzer_test_summary.rb', line 307

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



301
302
303
 
# File 'lib/oci/vn_monitoring/models/path_analyzer_test_summary.rb', line 301

def to_s
  to_hash.to_s
end