Class: OCI::Analytics::Models::PrivateEndpointDetails

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

Overview

Private endpoint configuration details.

Constant Summary

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 = {}) ⇒ PrivateEndpointDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :vcn_id (String)

    The value to assign to the #vcn_id property

  • :subnet_id (String)

    The value to assign to the #subnet_id property

  • :network_security_group_ids (Array<String>)

    The value to assign to the #network_security_group_ids property



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
# File 'lib/oci/analytics/models/private_endpoint_details.rb', line 61

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

  attributes['networkEndpointType'] = 'PRIVATE'

  super(attributes)

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

  self.vcn_id = attributes[:'vcnId'] if attributes[:'vcnId']

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

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

  self.subnet_id = attributes[:'subnetId'] if attributes[:'subnetId']

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

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

  self.network_security_group_ids = attributes[:'networkSecurityGroupIds'] if attributes[:'networkSecurityGroupIds']

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

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

Instance Attribute Details

#network_security_group_idsArray<String>

Network Security Group OCIDs for an Analytics instance.

Returns:

  • (Array<String>)


26
27
28
# File 'lib/oci/analytics/models/private_endpoint_details.rb', line 26

def network_security_group_ids
  @network_security_group_ids
end

#subnet_idString

[Required] The subnet OCID for the private endpoint.

Returns:

  • (String)


21
22
23
# File 'lib/oci/analytics/models/private_endpoint_details.rb', line 21

def subnet_id
  @subnet_id
end

#vcn_idString

[Required] The VCN OCID for the private endpoint.

Returns:

  • (String)


16
17
18
# File 'lib/oci/analytics/models/private_endpoint_details.rb', line 16

def vcn_id
  @vcn_id
end

Class Method Details

.attribute_mapObject

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



29
30
31
32
33
34
35
36
37
38
# File 'lib/oci/analytics/models/private_endpoint_details.rb', line 29

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'network_endpoint_type': :'networkEndpointType',
    'vcn_id': :'vcnId',
    'subnet_id': :'subnetId',
    'network_security_group_ids': :'networkSecurityGroupIds'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



41
42
43
44
45
46
47
48
49
50
# File 'lib/oci/analytics/models/private_endpoint_details.rb', line 41

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'network_endpoint_type': :'String',
    'vcn_id': :'String',
    'subnet_id': :'String',
    'network_security_group_ids': :'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



97
98
99
100
101
102
103
104
105
# File 'lib/oci/analytics/models/private_endpoint_details.rb', line 97

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

  self.class == other.class &&
    network_endpoint_type == other.network_endpoint_type &&
    vcn_id == other.vcn_id &&
    subnet_id == other.subnet_id &&
    network_security_group_ids == other.network_security_group_ids
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



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
# File 'lib/oci/analytics/models/private_endpoint_details.rb', line 130

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


110
111
112
# File 'lib/oci/analytics/models/private_endpoint_details.rb', line 110

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



119
120
121
# File 'lib/oci/analytics/models/private_endpoint_details.rb', line 119

def hash
  [network_endpoint_type, vcn_id, subnet_id, network_security_group_ids].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



163
164
165
166
167
168
169
170
171
172
# File 'lib/oci/analytics/models/private_endpoint_details.rb', line 163

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



157
158
159
# File 'lib/oci/analytics/models/private_endpoint_details.rb', line 157

def to_s
  to_hash.to_s
end