Class: OCI::ResourceManager::Models::CreatePrivateEndpointDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/resource_manager/models/create_private_endpoint_details.rb

Overview

Creation details for a private endpoint.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreatePrivateEndpointDetails

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

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :vcn_id (String) —

    The value to assign to the #vcn_id property

  • :subnet_id (String) —

    The value to assign to the #subnet_id property

  • :dns_zones (Array<String>) —

    The value to assign to the #dns_zones property

  • :nsg_id_list (Array<String>) —

    The value to assign to the #nsg_id_list property

  • :is_used_with_configuration_source_provider (BOOLEAN) —

    The value to assign to the #is_used_with_configuration_source_provider 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



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
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/oci/resource_manager/models/create_private_endpoint_details.rb', line 126

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

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

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

  self.nsg_id_list = attributes[:'nsgIdList'] if attributes[:'nsgIdList']

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

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

  self.is_used_with_configuration_source_provider = attributes[:'isUsedWithConfigurationSourceProvider'] unless attributes[:'isUsedWithConfigurationSourceProvider'].nil?

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

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

  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 containing this private endpoint.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/resource_manager/models/create_private_endpoint_details.rb', line 14

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>>) 


62
63
64
 
# File 'lib/oci/resource_manager/models/create_private_endpoint_details.rb', line 62

def defined_tags
  @defined_tags
end

#description ⇒ String

Description of the private endpoint. Avoid entering confidential information.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/resource_manager/models/create_private_endpoint_details.rb', line 23

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) 


19
20
21
 
# File 'lib/oci/resource_manager/models/create_private_endpoint_details.rb', line 19

def display_name
  @display_name
end

#dns_zones ⇒ Array<String>

DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver.

Returns:

  • (Array<String>) 


36
37
38
 
# File 'lib/oci/resource_manager/models/create_private_endpoint_details.rb', line 36

def dns_zones
  @dns_zones
end

#freeform_tags ⇒ Hash<String, String>

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

Returns:

  • (Hash<String, String>) 


55
56
57
 
# File 'lib/oci/resource_manager/models/create_private_endpoint_details.rb', line 55

def freeform_tags
  @freeform_tags
end

#is_used_with_configuration_source_provider ⇒ BOOLEAN

When true, allows the private endpoint to be used with a configuration source provider.

Returns:

  • (BOOLEAN) 


48
49
50
 
# File 'lib/oci/resource_manager/models/create_private_endpoint_details.rb', line 48

def is_used_with_configuration_source_provider
  @is_used_with_configuration_source_provider
end

#nsg_id_list ⇒ Array<String>

The OCIDs of network security groups (NSGs) for the private endpoint. Order does not matter.

Returns:

  • (Array<String>) 


44
45
46
 
# File 'lib/oci/resource_manager/models/create_private_endpoint_details.rb', line 44

def nsg_id_list
  @nsg_id_list
end

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

Security attributes are labels for a resource that can be referenced in a Zero Trust Packet Routing (ZPR) policy to control access to ZPR-supported resources.

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

Returns:

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


69
70
71
 
# File 'lib/oci/resource_manager/models/create_private_endpoint_details.rb', line 69

def security_attributes
  @security_attributes
end

#subnet_id ⇒ String

[Required] The OCID of the subnet within the VCN for the private endpoint.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/resource_manager/models/create_private_endpoint_details.rb', line 31

def subnet_id
  @subnet_id
end

#vcn_id ⇒ String

[Required] The OCID of the VCN for the private endpoint.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/resource_manager/models/create_private_endpoint_details.rb', line 27

def vcn_id
  @vcn_id
end

Class Method Details

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/oci/resource_manager/models/create_private_endpoint_details.rb', line 72

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'vcn_id': :'vcnId',
    'subnet_id': :'subnetId',
    'dns_zones': :'dnsZones',
    'nsg_id_list': :'nsgIdList',
    'is_used_with_configuration_source_provider': :'isUsedWithConfigurationSourceProvider',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'security_attributes': :'securityAttributes'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/oci/resource_manager/models/create_private_endpoint_details.rb', line 91

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'vcn_id': :'String',
    'subnet_id': :'String',
    'dns_zones': :'Array<String>',
    'nsg_id_list': :'Array<String>',
    'is_used_with_configuration_source_provider': :'BOOLEAN',
    '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



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/oci/resource_manager/models/create_private_endpoint_details.rb', line 202

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    vcn_id == other.vcn_id &&
    subnet_id == other.subnet_id &&
    dns_zones == other.dns_zones &&
    nsg_id_list == other.nsg_id_list &&
    is_used_with_configuration_source_provider == other.is_used_with_configuration_source_provider &&
    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



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/oci/resource_manager/models/create_private_endpoint_details.rb', line 242

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


222
223
224
 
# File 'lib/oci/resource_manager/models/create_private_endpoint_details.rb', line 222

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



231
232
233
 
# File 'lib/oci/resource_manager/models/create_private_endpoint_details.rb', line 231

def hash
  [compartment_id, display_name, description, vcn_id, subnet_id, dns_zones, nsg_id_list, is_used_with_configuration_source_provider, 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



275
276
277
278
279
280
281
282
283
284
 
# File 'lib/oci/resource_manager/models/create_private_endpoint_details.rb', line 275

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



269
270
271
 
# File 'lib/oci/resource_manager/models/create_private_endpoint_details.rb', line 269

def to_s
  to_hash.to_s
end