class OCI::Analytics::Models::PrivateAccessChannel

Analytics Instance Private Access Channel model.

Attributes

display_name[RW]

[Required] Display Name of the Private Access Channel.

@return [String]

egress_source_ip_addresses[RW]

[Required] The list of IP addresses from the customer subnet connected to private access channel, used as a source Ip by Private Access Channel for network traffic from the AnalyticsInstance to Private Sources.

@return [Array<String>]

ip_address[RW]

[Required] IP Address of the Private Access channel.

@return [String]

key[RW]

[Required] Private Access Channel unique identifier key.

@return [String]

private_source_dns_zones[RW]

List of Private Source DNS zones registered with Private Access Channel, where datasource hostnames from these dns zones / domains will be resolved in the peered VCN for access from Analytics Instance. Min of 1 is required and Max of 30 Private Source DNS zones can be registered.

@return [Array<OCI::Analytics::Models::PrivateSourceDnsZone>]

subnet_id[RW]

[Required] OCID of the customer subnet connected to private access channel.

@return [String]

vcn_id[RW]

[Required] OCID of the customer VCN peered with private access channel.

@return [String]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/analytics/models/private_access_channel.rb, line 50
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'display_name': :'displayName',
    'vcn_id': :'vcnId',
    'subnet_id': :'subnetId',
    'ip_address': :'ipAddress',
    'egress_source_ip_addresses': :'egressSourceIpAddresses',
    'private_source_dns_zones': :'privateSourceDnsZones'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :key The value to assign to the {#key} property @option attributes [String] :display_name The value to assign to the {#display_name} property @option attributes [String] :vcn_id The value to assign to the {#vcn_id} property @option attributes [String] :subnet_id The value to assign to the {#subnet_id} property @option attributes [String] :ip_address The value to assign to the {#ip_address} property @option attributes [Array<String>] :egress_source_ip_addresses The value to assign to the {#egress_source_ip_addresses} property @option attributes [Array<OCI::Analytics::Models::PrivateSourceDnsZone>] :private_source_dns_zones The value to assign to the {#private_source_dns_zones} property

# File lib/oci/analytics/models/private_access_channel.rb, line 92
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.key = attributes[:'key'] if attributes[:'key']

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

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

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

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

  self.egress_source_ip_addresses = attributes[:'egressSourceIpAddresses'] if attributes[:'egressSourceIpAddresses']

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

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

  self.private_source_dns_zones = attributes[:'privateSourceDnsZones'] if attributes[:'privateSourceDnsZones']

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

  self.private_source_dns_zones = attributes[:'private_source_dns_zones'] if attributes[:'private_source_dns_zones']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/analytics/models/private_access_channel.rb, line 65
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'display_name': :'String',
    'vcn_id': :'String',
    'subnet_id': :'String',
    'ip_address': :'String',
    'egress_source_ip_addresses': :'Array<String>',
    'private_source_dns_zones': :'Array<OCI::Analytics::Models::PrivateSourceDnsZone>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/analytics/models/private_access_channel.rb, line 144
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    key == other.key &&
    display_name == other.display_name &&
    vcn_id == other.vcn_id &&
    subnet_id == other.subnet_id &&
    ip_address == other.ip_address &&
    egress_source_ip_addresses == other.egress_source_ip_addresses &&
    private_source_dns_zones == other.private_source_dns_zones
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/analytics/models/private_access_channel.rb, line 180
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/analytics/models/private_access_channel.rb, line 160
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/analytics/models/private_access_channel.rb, line 169
def hash
  [key, display_name, vcn_id, subnet_id, ip_address, egress_source_ip_addresses, private_source_dns_zones].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/analytics/models/private_access_channel.rb, line 213
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/analytics/models/private_access_channel.rb, line 207
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/analytics/models/private_access_channel.rb, line 230
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end