Class: OCI::DatabaseTools::Models::CreateDatabaseToolsPrivateEndpointDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_tools/models/create_database_tools_private_endpoint_details.rb

Overview

The details for the new Database Tools private endpoint.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateDatabaseToolsPrivateEndpointDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

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

    The value to assign to the #defined_tags property

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

    The value to assign to the #freeform_tags property

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

    The value to assign to the #security_attributes property

  • :locks (Array<OCI::DatabaseTools::Models::ResourceLock>) —

    The value to assign to the #locks property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :endpoint_service_id (String) —

    The value to assign to the #endpoint_service_id property

  • :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



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
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/oci/database_tools/models/create_database_tools_private_endpoint_details.rb', line 120

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

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

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

  self.endpoint_service_id = attributes[:'endpointServiceId'] if attributes[:'endpointServiceId']

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

  self.endpoint_service_id = attributes[:'endpoint_service_id'] if attributes[:'endpoint_service_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_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

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the Database Tools private endpoint.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/database_tools/models/create_database_tools_private_endpoint_details.rb', line 13

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. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


19
20
21
 
# File 'lib/oci/database_tools/models/create_database_tools_private_endpoint_details.rb', line 19

def defined_tags
  @defined_tags
end

#description ⇒ String

A description of the Database Tools private endpoint.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/database_tools/models/create_database_tools_private_endpoint_details.rb', line 44

def description
  @description
end

#display_name ⇒ String

[Required] A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/database_tools/models/create_database_tools_private_endpoint_details.rb', line 40

def display_name
  @display_name
end

#endpoint_service_id ⇒ String

[Required] The OCID of the DatabaseToolsEndpointService.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/database_tools/models/create_database_tools_private_endpoint_details.rb', line 48

def endpoint_service_id
  @endpoint_service_id
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


25
26
27
 
# File 'lib/oci/database_tools/models/create_database_tools_private_endpoint_details.rb', line 25

def freeform_tags
  @freeform_tags
end

#locks ⇒ Array<OCI::DatabaseTools::Models::ResourceLock>

Locks associated with this resource.

Returns:



36
37
38
 
# File 'lib/oci/database_tools/models/create_database_tools_private_endpoint_details.rb', line 36

def locks
  @locks
end

#nsg_ids ⇒ Array<String>

The OCID of the network security groups that the private endpoint's VNIC belongs to. For more information about NSGs, see NetworkSecurityGroup.

Returns:

  • (Array<String>) 


63
64
65
 
# File 'lib/oci/database_tools/models/create_database_tools_private_endpoint_details.rb', line 63

def nsg_ids
  @nsg_ids
end

#private_endpoint_ip ⇒ String

The private IP address that represents the access point for the associated endpoint service.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/database_tools/models/create_database_tools_private_endpoint_details.rb', line 56

def private_endpoint_ip
  @private_endpoint_ip
end

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

Zero trust Packet Routing (ZPR) Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see ZPR Artifacts. Example: {\"Oracle-ZPR\": {\"MaxEgressCount\": {\"value\": \"42\", \"mode\": \"audit\"}}}

Returns:

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


32
33
34
 
# File 'lib/oci/database_tools/models/create_database_tools_private_endpoint_details.rb', line 32

def security_attributes
  @security_attributes
end

#subnet_id ⇒ String

[Required] The OCID of the subnet that the private endpoint belongs to.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/database_tools/models/create_database_tools_private_endpoint_details.rb', line 52

def subnet_id
  @subnet_id
end

Class Method Details

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/database_tools/models/create_database_tools_private_endpoint_details.rb', line 66

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags',
    'security_attributes': :'securityAttributes',
    'locks': :'locks',
    'display_name': :'displayName',
    'description': :'description',
    'endpoint_service_id': :'endpointServiceId',
    'subnet_id': :'subnetId',
    'private_endpoint_ip': :'privateEndpointIp',
    'nsg_ids': :'nsgIds'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/oci/database_tools/models/create_database_tools_private_endpoint_details.rb', line 85

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'freeform_tags': :'Hash<String, String>',
    'security_attributes': :'Hash<String, Hash<String, Object>>',
    'locks': :'Array<OCI::DatabaseTools::Models::ResourceLock>',
    'display_name': :'String',
    'description': :'String',
    'endpoint_service_id': :'String',
    '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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/oci/database_tools/models/create_database_tools_private_endpoint_details.rb', line 192

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    defined_tags == other.defined_tags &&
    freeform_tags == other.freeform_tags &&
    security_attributes == other.security_attributes &&
    locks == other.locks &&
    display_name == other.display_name &&
    description == other.description &&
    endpoint_service_id == other.endpoint_service_id &&
    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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/oci/database_tools/models/create_database_tools_private_endpoint_details.rb', line 232

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


212
213
214
 
# File 'lib/oci/database_tools/models/create_database_tools_private_endpoint_details.rb', line 212

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



221
222
223
 
# File 'lib/oci/database_tools/models/create_database_tools_private_endpoint_details.rb', line 221

def hash
  [compartment_id, defined_tags, freeform_tags, security_attributes, locks, display_name, description, endpoint_service_id, subnet_id, private_endpoint_ip, nsg_ids].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



265
266
267
268
269
270
271
272
273
274
 
# File 'lib/oci/database_tools/models/create_database_tools_private_endpoint_details.rb', line 265

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



259
260
261
 
# File 'lib/oci/database_tools/models/create_database_tools_private_endpoint_details.rb', line 259

def to_s
  to_hash.to_s
end