Class: OCI::Dns::Models::CreateResolverEndpointDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/dns/models/create_resolver_endpoint_details.rb

Overview

The body for defining a new resolver endpoint.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Direct Known Subclasses

CreateResolverVnicEndpointDetails

Constant Summary collapse

ENDPOINT_TYPE_ENUM = 
[
  ENDPOINT_TYPE_VNIC = 'VNIC'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateResolverEndpointDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name property

  • :endpoint_type (String) —

    The value to assign to the #endpoint_type property

  • :forwarding_address (String) —

    The value to assign to the #forwarding_address property

  • :is_forwarding (BOOLEAN) —

    The value to assign to the #is_forwarding property

  • :is_listening (BOOLEAN) —

    The value to assign to the #is_listening property

  • :listening_address (String) —

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



118
119
120
121
122
123
124
125
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
 
# File 'lib/oci/dns/models/create_resolver_endpoint_details.rb', line 118

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

  self.endpoint_type = attributes[:'endpointType'] if attributes[:'endpointType']
  self.endpoint_type = "VNIC" if endpoint_type.nil? && !attributes.key?(:'endpointType') # rubocop:disable Style/StringLiterals

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

  self.endpoint_type = attributes[:'endpoint_type'] if attributes[:'endpoint_type']
  self.endpoint_type = "VNIC" if endpoint_type.nil? && !attributes.key?(:'endpointType') && !attributes.key?(:'endpoint_type') # rubocop:disable Style/StringLiterals

  self.forwarding_address = attributes[:'forwardingAddress'] if attributes[:'forwardingAddress']

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

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

  self.is_forwarding = attributes[:'isForwarding'] unless attributes[:'isForwarding'].nil?

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

  self.is_forwarding = attributes[:'is_forwarding'] unless attributes[:'is_forwarding'].nil?

  self.is_listening = attributes[:'isListening'] unless attributes[:'isListening'].nil?

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

  self.is_listening = attributes[:'is_listening'] unless attributes[:'is_listening'].nil?

  self.listening_address = attributes[:'listeningAddress'] if attributes[:'listeningAddress']

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

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

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

Instance Attribute Details

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

Returns:

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


55
56
57
 
# File 'lib/oci/dns/models/create_resolver_endpoint_details.rb', line 55

def defined_tags
  @defined_tags
end

#endpoint_type ⇒ String

The type of resolver endpoint. VNIC is currently the only supported type.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/dns/models/create_resolver_endpoint_details.rb', line 27

def endpoint_type
  @endpoint_type
end

#forwarding_address ⇒ String

An IP address from which forwarded queries may be sent. For VNIC endpoints, this IP address must be part of the subnet and will be assigned by the system if unspecified when isForwarding is true.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/dns/models/create_resolver_endpoint_details.rb', line 33

def forwarding_address
  @forwarding_address
end

#freeform_tags ⇒ Hash<String, String>

Returns:

  • (Hash<String, String>) 


52
53
54
 
# File 'lib/oci/dns/models/create_resolver_endpoint_details.rb', line 52

def freeform_tags
  @freeform_tags
end

#is_forwarding ⇒ BOOLEAN

[Required] A Boolean flag indicating whether or not the resolver endpoint is for forwarding.

Returns:

  • (BOOLEAN) 


38
39
40
 
# File 'lib/oci/dns/models/create_resolver_endpoint_details.rb', line 38

def is_forwarding
  @is_forwarding
end

#is_listening ⇒ BOOLEAN

[Required] A Boolean flag indicating whether or not the resolver endpoint is for listening.

Returns:

  • (BOOLEAN) 


43
44
45
 
# File 'lib/oci/dns/models/create_resolver_endpoint_details.rb', line 43

def is_listening
  @is_listening
end

#listening_address ⇒ String

An IP address to listen to queries on. For VNIC endpoints this IP address must be part of the subnet and will be assigned by the system if unspecified when isListening is true.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/dns/models/create_resolver_endpoint_details.rb', line 49

def listening_address
  @listening_address
end

#name ⇒ String

[Required] The name of the resolver endpoint. Must be unique, case-insensitive, within the resolver.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/dns/models/create_resolver_endpoint_details.rb', line 22

def name
  @name
end

Class Method Details

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/oci/dns/models/create_resolver_endpoint_details.rb', line 58

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'endpoint_type': :'endpointType',
    'forwarding_address': :'forwardingAddress',
    'is_forwarding': :'isForwarding',
    'is_listening': :'isListening',
    'listening_address': :'listeningAddress',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



94
95
96
97
98
99
100
101
 
# File 'lib/oci/dns/models/create_resolver_endpoint_details.rb', line 94

def self.get_subtype(object_hash)
  type = object_hash[:'endpointType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::Dns::Models::CreateResolverVnicEndpointDetails' if type == 'VNIC'

  # TODO: Log a warning when the subtype is not found.
  'OCI::Dns::Models::CreateResolverEndpointDetails'
end

.swagger_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/oci/dns/models/create_resolver_endpoint_details.rb', line 74

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'endpoint_type': :'String',
    'forwarding_address': :'String',
    'is_forwarding': :'BOOLEAN',
    'is_listening': :'BOOLEAN',
    'listening_address': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_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



186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/oci/dns/models/create_resolver_endpoint_details.rb', line 186

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

  self.class == other.class &&
    name == other.name &&
    endpoint_type == other.endpoint_type &&
    forwarding_address == other.forwarding_address &&
    is_forwarding == other.is_forwarding &&
    is_listening == other.is_listening &&
    listening_address == other.listening_address &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/oci/dns/models/create_resolver_endpoint_details.rb', line 223

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


203
204
205
 
# File 'lib/oci/dns/models/create_resolver_endpoint_details.rb', line 203

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



212
213
214
 
# File 'lib/oci/dns/models/create_resolver_endpoint_details.rb', line 212

def hash
  [name, endpoint_type, forwarding_address, is_forwarding, is_listening, listening_address, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



256
257
258
259
260
261
262
263
264
265
 
# File 'lib/oci/dns/models/create_resolver_endpoint_details.rb', line 256

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



250
251
252
 
# File 'lib/oci/dns/models/create_resolver_endpoint_details.rb', line 250

def to_s
  to_hash.to_s
end