Class: OCI::Analytics::Models::PublicEndpointDetails

Inherits:
NetworkEndpointDetails show all
Defined in:
lib/oci/analytics/models/public_endpoint_details.rb

Overview

Public endpoint configuration details.

Constant Summary collapse

WHITELISTED_SERVICES_ENUM =
[
  WHITELISTED_SERVICES_ALL = 'ALL'.freeze,
  WHITELISTED_SERVICES_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Constants inherited from NetworkEndpointDetails

NetworkEndpointDetails::NETWORK_ENDPOINT_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from NetworkEndpointDetails

#network_endpoint_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from NetworkEndpointDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ PublicEndpointDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
# File 'lib/oci/analytics/models/public_endpoint_details.rb', line 67

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

  attributes['networkEndpointType'] = 'PUBLIC'

  super(attributes)

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

  self.whitelisted_ips = attributes[:'whitelistedIps'] if attributes[:'whitelistedIps']

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

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

  self.whitelisted_vcns = attributes[:'whitelistedVcns'] if attributes[:'whitelistedVcns']

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

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

  self.whitelisted_services = attributes[:'whitelistedServices'] if attributes[:'whitelistedServices']

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

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

Instance Attribute Details

#whitelisted_ipsArray<String>

Source IP addresses or IP address ranges in ingress rules.

Returns:

  • (Array<String>)


22
23
24
# File 'lib/oci/analytics/models/public_endpoint_details.rb', line 22

def whitelisted_ips
  @whitelisted_ips
end

#whitelisted_servicesArray<String>

Oracle Cloud Services that are allowed to access this Analytics instance.

Returns:

  • (Array<String>)


32
33
34
# File 'lib/oci/analytics/models/public_endpoint_details.rb', line 32

def whitelisted_services
  @whitelisted_services
end

#whitelisted_vcnsArray<OCI::Analytics::Models::VirtualCloudNetwork>

Virtual Cloud Networks allowed to access this network endpoint.



27
28
29
# File 'lib/oci/analytics/models/public_endpoint_details.rb', line 27

def whitelisted_vcns
  @whitelisted_vcns
end

Class Method Details

.attribute_mapObject

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



35
36
37
38
39
40
41
42
43
44
# File 'lib/oci/analytics/models/public_endpoint_details.rb', line 35

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'network_endpoint_type': :'networkEndpointType',
    'whitelisted_ips': :'whitelistedIps',
    'whitelisted_vcns': :'whitelistedVcns',
    'whitelisted_services': :'whitelistedServices'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



47
48
49
50
51
52
53
54
55
56
# File 'lib/oci/analytics/models/public_endpoint_details.rb', line 47

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'network_endpoint_type': :'String',
    'whitelisted_ips': :'Array<String>',
    'whitelisted_vcns': :'Array<OCI::Analytics::Models::VirtualCloudNetwork>',
    'whitelisted_services': :'Array<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



123
124
125
126
127
128
129
130
131
# File 'lib/oci/analytics/models/public_endpoint_details.rb', line 123

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

  self.class == other.class &&
    network_endpoint_type == other.network_endpoint_type &&
    whitelisted_ips == other.whitelisted_ips &&
    whitelisted_vcns == other.whitelisted_vcns &&
    whitelisted_services == other.whitelisted_services
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



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
# File 'lib/oci/analytics/models/public_endpoint_details.rb', line 156

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


136
137
138
# File 'lib/oci/analytics/models/public_endpoint_details.rb', line 136

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



145
146
147
# File 'lib/oci/analytics/models/public_endpoint_details.rb', line 145

def hash
  [network_endpoint_type, whitelisted_ips, whitelisted_vcns, whitelisted_services].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



189
190
191
192
193
194
195
196
197
198
# File 'lib/oci/analytics/models/public_endpoint_details.rb', line 189

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



183
184
185
# File 'lib/oci/analytics/models/public_endpoint_details.rb', line 183

def to_s
  to_hash.to_s
end