Class: OCI::DatabaseManagement::Models::CreateDbManagementPrivateEndpointDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_management/models/create_db_management_private_endpoint_details.rb

Overview

The details used to create a new Database Management private endpoint.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateDbManagementPrivateEndpointDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :is_cluster (BOOLEAN) —

    The value to assign to the #is_cluster property

  • :is_dns_resolution_enabled (BOOLEAN) —

    The value to assign to the #is_dns_resolution_enabled property

  • :subnet_id (String) —

    The value to assign to the #subnet_id property

  • :description (String) —

    The value to assign to the #description property

  • :nsg_ids (Array<String>) —

    The value to assign to the #nsg_ids property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :security_attributes (Hash<String, Hash<String, Object>>) —

    The value to assign to the #security_attributes property



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/oci/database_management/models/create_db_management_private_endpoint_details.rb', line 114

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  self.is_cluster = attributes[:'isCluster'] unless attributes[:'isCluster'].nil?

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

  self.is_cluster = attributes[:'is_cluster'] unless attributes[:'is_cluster'].nil?

  self.is_dns_resolution_enabled = attributes[:'isDnsResolutionEnabled'] unless attributes[:'isDnsResolutionEnabled'].nil?

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

  self.is_dns_resolution_enabled = attributes[:'is_dns_resolution_enabled'] unless attributes[:'is_dns_resolution_enabled'].nil?

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.security_attributes = attributes[:'securityAttributes'] if attributes[:'securityAttributes']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/database_management/models/create_db_management_private_endpoint_details.rb', line 17

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


52
53
54
 
# File 'lib/oci/database_management/models/create_db_management_private_endpoint_details.rb', line 52

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of the private endpoint.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/database_management/models/create_db_management_private_endpoint_details.rb', line 33

def description
  @description
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


45
46
47
 
# File 'lib/oci/database_management/models/create_db_management_private_endpoint_details.rb', line 45

def freeform_tags
  @freeform_tags
end

#is_cluster ⇒ BOOLEAN

Specifies whether the Database Management private endpoint will be used for Oracle Databases in a cluster.

Returns:

  • (BOOLEAN) 


21
22
23
 
# File 'lib/oci/database_management/models/create_db_management_private_endpoint_details.rb', line 21

def is_cluster
  @is_cluster
end

#is_dns_resolution_enabled ⇒ BOOLEAN

Specifies whether the Database Management private endpoint has DNS proxy server enabled to resolve private host name.

Returns:

  • (BOOLEAN) 


25
26
27
 
# File 'lib/oci/database_management/models/create_db_management_private_endpoint_details.rb', line 25

def is_dns_resolution_enabled
  @is_dns_resolution_enabled
end

#name ⇒ String

[Required] The display name of the Database Management private endpoint.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/database_management/models/create_db_management_private_endpoint_details.rb', line 13

def name
  @name
end

#nsg_ids ⇒ Array<String>

The OCIDs of the Network Security Groups to which the Database Management private endpoint belongs.

Returns:

  • (Array<String>) 


38
39
40
 
# File 'lib/oci/database_management/models/create_db_management_private_endpoint_details.rb', line 38

def nsg_ids
  @nsg_ids
end

#security_attributes ⇒ Hash<String, Hash<String, Object>>

Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Oracle-ZPR\": {\"MaxEgressCount\": {\"value\": \"42\", \"mode\": \"enforce\"}}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


60
61
62
 
# File 'lib/oci/database_management/models/create_db_management_private_endpoint_details.rb', line 60

def security_attributes
  @security_attributes
end

#subnet_id ⇒ String

[Required] The OCID of the subnet.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/database_management/models/create_db_management_private_endpoint_details.rb', line 29

def subnet_id
  @subnet_id
end

Class Method Details

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/database_management/models/create_db_management_private_endpoint_details.rb', line 63

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'compartment_id': :'compartmentId',
    'is_cluster': :'isCluster',
    'is_dns_resolution_enabled': :'isDnsResolutionEnabled',
    'subnet_id': :'subnetId',
    'description': :'description',
    'nsg_ids': :'nsgIds',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'security_attributes': :'securityAttributes'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/oci/database_management/models/create_db_management_private_endpoint_details.rb', line 81

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'compartment_id': :'String',
    'is_cluster': :'BOOLEAN',
    'is_dns_resolution_enabled': :'BOOLEAN',
    'subnet_id': :'String',
    'description': :'String',
    'nsg_ids': :'Array<String>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'security_attributes': :'Hash<String, Hash<String, Object>>'
    # 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



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/oci/database_management/models/create_db_management_private_endpoint_details.rb', line 180

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

  self.class == other.class &&
    name == other.name &&
    compartment_id == other.compartment_id &&
    is_cluster == other.is_cluster &&
    is_dns_resolution_enabled == other.is_dns_resolution_enabled &&
    subnet_id == other.subnet_id &&
    description == other.description &&
    nsg_ids == other.nsg_ids &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    security_attributes == other.security_attributes
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



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/oci/database_management/models/create_db_management_private_endpoint_details.rb', line 219

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


199
200
201
 
# File 'lib/oci/database_management/models/create_db_management_private_endpoint_details.rb', line 199

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



208
209
210
 
# File 'lib/oci/database_management/models/create_db_management_private_endpoint_details.rb', line 208

def hash
  [name, compartment_id, is_cluster, is_dns_resolution_enabled, subnet_id, description, nsg_ids, freeform_tags, defined_tags, security_attributes].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



252
253
254
255
256
257
258
259
260
261
 
# File 'lib/oci/database_management/models/create_db_management_private_endpoint_details.rb', line 252

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



246
247
248
 
# File 'lib/oci/database_management/models/create_db_management_private_endpoint_details.rb', line 246

def to_s
  to_hash.to_s
end