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



105
106
107
108
109
110
111
112
113
114
115
116
117
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
# File 'lib/oci/dns/models/create_resolver_endpoint_details.rb', line 105

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

Instance Attribute Details

#endpoint_typeString

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

Returns:

  • (String)


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

def endpoint_type
  @endpoint_type
end

#forwarding_addressString

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)


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

def forwarding_address
  @forwarding_address
end

#is_forwardingBOOLEAN

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

Returns:

  • (BOOLEAN)


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

def is_forwarding
  @is_forwarding
end

#is_listeningBOOLEAN

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

Returns:

  • (BOOLEAN)


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

def is_listening
  @is_listening
end

#listening_addressString

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.

Returns:

  • (String)


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

def listening_address
  @listening_address
end

#nameString

[Required] The name of the resolver endpoint. Must be unique within the resolver.

Returns:

  • (String)


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

def name
  @name
end

Class Method Details

.attribute_mapObject

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



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

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



83
84
85
86
87
88
89
90
# File 'lib/oci/dns/models/create_resolver_endpoint_details.rb', line 83

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_typesObject

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
# File 'lib/oci/dns/models/create_resolver_endpoint_details.rb', line 65

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'
    # 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



161
162
163
164
165
166
167
168
169
170
171
# File 'lib/oci/dns/models/create_resolver_endpoint_details.rb', line 161

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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
# File 'lib/oci/dns/models/create_resolver_endpoint_details.rb', line 196

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


176
177
178
# File 'lib/oci/dns/models/create_resolver_endpoint_details.rb', line 176

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



185
186
187
# File 'lib/oci/dns/models/create_resolver_endpoint_details.rb', line 185

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

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



229
230
231
232
233
234
235
236
237
238
# File 'lib/oci/dns/models/create_resolver_endpoint_details.rb', line 229

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



223
224
225
# File 'lib/oci/dns/models/create_resolver_endpoint_details.rb', line 223

def to_s
  to_hash.to_s
end