Class: OCI::VnMonitoring::Models::AdhocGetPathAnalysisDetails

Inherits:
GetPathAnalysisDetails show all
Defined in:
lib/oci/vn_monitoring/models/adhoc_get_path_analysis_details.rb

Overview

Defines the configuration for getting an ad-hoc path analysis.

Constant Summary

Constants inherited from GetPathAnalysisDetails

GetPathAnalysisDetails::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from GetPathAnalysisDetails

#type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from GetPathAnalysisDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ AdhocGetPathAnalysisDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/vn_monitoring/models/adhoc_get_path_analysis_details.rb', line 76

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['type'] = 'ADHOC_QUERY'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID for the compartment.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

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

This attribute is required.

Returns:



26
27
28
 
# File 'lib/oci/vn_monitoring/models/adhoc_get_path_analysis_details.rb', line 26

def destination_endpoint
  @destination_endpoint
end

#protocol ⇒ Integer

[Required] The IP protocol to used for the path analysis.

Returns:

  • (Integer) 


18
19
20
 
# File 'lib/oci/vn_monitoring/models/adhoc_get_path_analysis_details.rb', line 18

def protocol
  @protocol
end

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

Returns:



29
30
31
 
# File 'lib/oci/vn_monitoring/models/adhoc_get_path_analysis_details.rb', line 29

def protocol_parameters
  @protocol_parameters
end

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

Returns:



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

def query_options
  @query_options
end

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

This attribute is required.

Returns:



22
23
24
 
# File 'lib/oci/vn_monitoring/models/adhoc_get_path_analysis_details.rb', line 22

def source_endpoint
  @source_endpoint
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/oci/vn_monitoring/models/adhoc_get_path_analysis_details.rb', line 35

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'compartment_id': :'compartmentId',
    'protocol': :'protocol',
    'source_endpoint': :'sourceEndpoint',
    'destination_endpoint': :'destinationEndpoint',
    'protocol_parameters': :'protocolParameters',
    'query_options': :'queryOptions'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/oci/vn_monitoring/models/adhoc_get_path_analysis_details.rb', line 50

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'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'
    # 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



126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/oci/vn_monitoring/models/adhoc_get_path_analysis_details.rb', line 126

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

  self.class == other.class &&
    type == other.type &&
    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
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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/oci/vn_monitoring/models/adhoc_get_path_analysis_details.rb', line 162

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


142
143
144
 
# File 'lib/oci/vn_monitoring/models/adhoc_get_path_analysis_details.rb', line 142

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



151
152
153
 
# File 'lib/oci/vn_monitoring/models/adhoc_get_path_analysis_details.rb', line 151

def hash
  [type, compartment_id, protocol, source_endpoint, destination_endpoint, protocol_parameters, query_options].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



195
196
197
198
199
200
201
202
203
204
 
# File 'lib/oci/vn_monitoring/models/adhoc_get_path_analysis_details.rb', line 195

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



189
190
191
 
# File 'lib/oci/vn_monitoring/models/adhoc_get_path_analysis_details.rb', line 189

def to_s
  to_hash.to_s
end