Class: OCI::Core::Models::CpeDeviceShapeDetail

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/models/cpe_device_shape_detail.rb

Overview

The detailed information about a particular CPE device type. Compare with CpeDeviceShapeSummary.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CpeDeviceShapeDetail

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
# File 'lib/oci/core/models/cpe_device_shape_detail.rb', line 76

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

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

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

  self.cpe_device_info = attributes[:'cpeDeviceInfo'] if attributes[:'cpeDeviceInfo']

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

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

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

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

Instance Attribute Details

#cpe_device_infoOCI::Core::Models::CpeDeviceInfo

Basic information about this particular CPE device type.



20
21
22
# File 'lib/oci/core/models/cpe_device_shape_detail.rb', line 20

def cpe_device_info
  @cpe_device_info
end

#cpe_device_shape_idString

The OCID of the CPE device shape. This value uniquely identifies the type of CPE device.

Returns:

  • (String)


16
17
18
# File 'lib/oci/core/models/cpe_device_shape_detail.rb', line 16

def cpe_device_shape_id
  @cpe_device_shape_id
end

#parametersArray<OCI::Core::Models::CpeDeviceConfigQuestion>

For certain CPE devices types, the customer can provide answers to questions that are specific to the device type. This attribute contains a list of those questions. The Networking service merges the answers with other information and renders a set of CPE configuration content. To provide the answers, use update_tunnel_cpe_device_config.



30
31
32
# File 'lib/oci/core/models/cpe_device_shape_detail.rb', line 30

def parameters
  @parameters
end

#templateString

A template of CPE device configuration information that will be merged with the customer's answers to the questions to render the final CPE device configuration content. Also see:

  • get_cpe_device_config_content

  • get_ipsec_cpe_device_config_content

  • get_tunnel_cpe_device_config_content

Returns:

  • (String)


40
41
42
# File 'lib/oci/core/models/cpe_device_shape_detail.rb', line 40

def template
  @template
end

Class Method Details

.attribute_mapObject

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



43
44
45
46
47
48
49
50
51
52
# File 'lib/oci/core/models/cpe_device_shape_detail.rb', line 43

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'cpe_device_shape_id': :'cpeDeviceShapeId',
    'cpe_device_info': :'cpeDeviceInfo',
    'parameters': :'parameters',
    'template': :'template'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
# File 'lib/oci/core/models/cpe_device_shape_detail.rb', line 55

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'cpe_device_shape_id': :'String',
    'cpe_device_info': :'OCI::Core::Models::CpeDeviceInfo',
    'parameters': :'Array<OCI::Core::Models::CpeDeviceConfigQuestion>',
    'template': :'String'
    # 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



106
107
108
109
110
111
112
113
114
# File 'lib/oci/core/models/cpe_device_shape_detail.rb', line 106

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

  self.class == other.class &&
    cpe_device_shape_id == other.cpe_device_shape_id &&
    cpe_device_info == other.cpe_device_info &&
    parameters == other.parameters &&
    template == other.template
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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
# File 'lib/oci/core/models/cpe_device_shape_detail.rb', line 139

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


119
120
121
# File 'lib/oci/core/models/cpe_device_shape_detail.rb', line 119

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



128
129
130
# File 'lib/oci/core/models/cpe_device_shape_detail.rb', line 128

def hash
  [cpe_device_shape_id, cpe_device_info, parameters, template].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



172
173
174
175
176
177
178
179
180
181
# File 'lib/oci/core/models/cpe_device_shape_detail.rb', line 172

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



166
167
168
# File 'lib/oci/core/models/cpe_device_shape_detail.rb', line 166

def to_s
  to_hash.to_s
end