Class: OCI::Analytics::Models::CreatePrivateAccessChannelDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/analytics/models/create_private_access_channel_details.rb

Overview

Input payload to create a Private Access Channel.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreatePrivateAccessChannelDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/oci/analytics/models/create_private_access_channel_details.rb', line 84

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

  self.private_source_scan_hosts = attributes[:'privateSourceScanHosts'] if attributes[:'privateSourceScanHosts']

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

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

  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

#display_name ⇒ String

[Required] Display Name of the Private Access Channel.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/analytics/models/create_private_access_channel_details.rb', line 15

def display_name
  @display_name
end

#network_security_group_ids ⇒ Array<String>

Network Security Group OCIDs for an Analytics instance.

Returns:

  • (Array<String>) 


42
43
44
 
# File 'lib/oci/analytics/models/create_private_access_channel_details.rb', line 42

def network_security_group_ids
  @network_security_group_ids
end

#private_source_dns_zones ⇒ Array<OCI::Analytics::Models::PrivateSourceDnsZone>

[Required] 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.

Returns:



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

def private_source_dns_zones
  @private_source_dns_zones
end

#private_source_scan_hosts ⇒ Array<OCI::Analytics::Models::PrivateSourceScanHost>

List of Private Source DB SCAN hosts registered with Private Access Channel for access from Analytics Instance.

Returns:



37
38
39
 
# File 'lib/oci/analytics/models/create_private_access_channel_details.rb', line 37

def private_source_scan_hosts
  @private_source_scan_hosts
end

#subnet_id ⇒ String

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

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/analytics/models/create_private_access_channel_details.rb', line 25

def subnet_id
  @subnet_id
end

#vcn_id ⇒ String

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

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/analytics/models/create_private_access_channel_details.rb', line 20

def vcn_id
  @vcn_id
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'vcn_id': :'vcnId',
    'subnet_id': :'subnetId',
    'private_source_dns_zones': :'privateSourceDnsZones',
    'private_source_scan_hosts': :'privateSourceScanHosts',
    'network_security_group_ids': :'networkSecurityGroupIds'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/oci/analytics/models/create_private_access_channel_details.rb', line 59

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'vcn_id': :'String',
    'subnet_id': :'String',
    'private_source_dns_zones': :'Array<OCI::Analytics::Models::PrivateSourceDnsZone>',
    'private_source_scan_hosts': :'Array<OCI::Analytics::Models::PrivateSourceScanHost>',
    '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



134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/oci/analytics/models/create_private_access_channel_details.rb', line 134

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

  self.class == other.class &&
    display_name == other.display_name &&
    vcn_id == other.vcn_id &&
    subnet_id == other.subnet_id &&
    private_source_dns_zones == other.private_source_dns_zones &&
    private_source_scan_hosts == other.private_source_scan_hosts &&
    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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/oci/analytics/models/create_private_access_channel_details.rb', line 169

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


149
150
151
 
# File 'lib/oci/analytics/models/create_private_access_channel_details.rb', line 149

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



158
159
160
 
# File 'lib/oci/analytics/models/create_private_access_channel_details.rb', line 158

def hash
  [display_name, vcn_id, subnet_id, private_source_dns_zones, private_source_scan_hosts, network_security_group_ids].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



202
203
204
205
206
207
208
209
210
211
 
# File 'lib/oci/analytics/models/create_private_access_channel_details.rb', line 202

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

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



196
197
198
 
# File 'lib/oci/analytics/models/create_private_access_channel_details.rb', line 196

def to_s
  to_hash.to_s
end