Class: OCI::Streaming::Models::PrivateEndpointSettings

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/streaming/models/private_endpoint_settings.rb

Overview

Optional settings if the stream pool is private.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PrivateEndpointSettings

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :subnet_id (String)

    The value to assign to the #subnet_id property

  • :private_endpoint_ip (String)

    The value to assign to the #private_endpoint_ip property

  • :nsg_ids (Array<String>)

    The value to assign to the #nsg_ids property



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
# File 'lib/oci/streaming/models/private_endpoint_settings.rb', line 57

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

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

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

  self.nsg_ids = attributes[:'nsgIds'] if attributes[:'nsgIds']

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

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

Instance Attribute Details

#nsg_idsArray<String>

The optional list of network security groups that are associated with the private endpoint of the stream pool.

Returns:

  • (Array<String>)


24
25
26
# File 'lib/oci/streaming/models/private_endpoint_settings.rb', line 24

def nsg_ids
  @nsg_ids
end

#private_endpoint_ipString

The private IP associated with the stream pool in the associated subnetId. The stream pool's FQDN resolves to that IP and should be used - instead of the private IP - in order to not trigger any TLS issues.

Returns:

  • (String)


20
21
22
# File 'lib/oci/streaming/models/private_endpoint_settings.rb', line 20

def private_endpoint_ip
  @private_endpoint_ip
end

#subnet_idString

The subnet id from which the private stream pool can be accessed. Trying to access the streams from another network location will result in an error.

Returns:

  • (String)


14
15
16
# File 'lib/oci/streaming/models/private_endpoint_settings.rb', line 14

def subnet_id
  @subnet_id
end

Class Method Details

.attribute_mapObject

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



27
28
29
30
31
32
33
34
35
# File 'lib/oci/streaming/models/private_endpoint_settings.rb', line 27

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'subnet_id': :'subnetId',
    'private_endpoint_ip': :'privateEndpointIp',
    'nsg_ids': :'nsgIds'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



38
39
40
41
42
43
44
45
46
# File 'lib/oci/streaming/models/private_endpoint_settings.rb', line 38

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



89
90
91
92
93
94
95
96
# File 'lib/oci/streaming/models/private_endpoint_settings.rb', line 89

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

  self.class == other.class &&
    subnet_id == other.subnet_id &&
    private_endpoint_ip == other.private_endpoint_ip &&
    nsg_ids == other.nsg_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



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
# File 'lib/oci/streaming/models/private_endpoint_settings.rb', line 121

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


101
102
103
# File 'lib/oci/streaming/models/private_endpoint_settings.rb', line 101

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



110
111
112
# File 'lib/oci/streaming/models/private_endpoint_settings.rb', line 110

def hash
  [subnet_id, private_endpoint_ip, nsg_ids].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



154
155
156
157
158
159
160
161
162
163
# File 'lib/oci/streaming/models/private_endpoint_settings.rb', line 154

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



148
149
150
# File 'lib/oci/streaming/models/private_endpoint_settings.rb', line 148

def to_s
  to_hash.to_s
end