Class: OCI::KeyManagement::Models::CreateEkmsPrivateEndpointDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/key_management/models/create_ekms_private_endpoint_details.rb

Overview

Information needed to create EKMS private endpoint resource

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateEkmsPrivateEndpointDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :subnet_id (String) —

    The value to assign to the #subnet_id property

  • :compartment_id (String) —

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

  • :display_name (String) —

    The value to assign to the #display_name property

  • :external_key_manager_ip (String) —

    The value to assign to the #external_key_manager_ip property

  • :ca_bundle (String) —

    The value to assign to the #ca_bundle property

  • :port (Integer) —

    The value to assign to the #port property



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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/oci/key_management/models/create_ekms_private_endpoint_details.rb', line 96

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

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

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

  self.ca_bundle = attributes[:'caBundle'] if attributes[:'caBundle']

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

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

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

Instance Attribute Details

#ca_bundle ⇒ String

[Required] CABundle to validate TLS certificate of the external key manager system in PEM format

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/key_management/models/create_ekms_private_endpoint_details.rb', line 44

def ca_bundle
  @ca_bundle
end

#compartment_id ⇒ String

[Required] Compartment identifier.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/key_management/models/create_ekms_private_endpoint_details.rb', line 18

def compartment_id
  @compartment_id
end

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

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


30
31
32
 
# File 'lib/oci/key_management/models/create_ekms_private_endpoint_details.rb', line 30

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] Display name of the EKMS private endpoint resource being created.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/key_management/models/create_ekms_private_endpoint_details.rb', line 34

def display_name
  @display_name
end

#external_key_manager_ip ⇒ String

[Required] External private IP to connect to from this EKMS private endpoint

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/key_management/models/create_ekms_private_endpoint_details.rb', line 39

def external_key_manager_ip
  @external_key_manager_ip
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>) 


24
25
26
 
# File 'lib/oci/key_management/models/create_ekms_private_endpoint_details.rb', line 24

def freeform_tags
  @freeform_tags
end

#port ⇒ Integer

The port of the external key manager system

Returns:

  • (Integer) 


48
49
50
 
# File 'lib/oci/key_management/models/create_ekms_private_endpoint_details.rb', line 48

def port
  @port
end

#subnet_id ⇒ String

[Required] The OCID of subnet in which the EKMS private endpoint is to be created

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/key_management/models/create_ekms_private_endpoint_details.rb', line 14

def subnet_id
  @subnet_id
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/oci/key_management/models/create_ekms_private_endpoint_details.rb', line 51

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'subnet_id': :'subnetId',
    'compartment_id': :'compartmentId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'display_name': :'displayName',
    'external_key_manager_ip': :'externalKeyManagerIp',
    'ca_bundle': :'caBundle',
    'port': :'port'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/oci/key_management/models/create_ekms_private_endpoint_details.rb', line 67

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'subnet_id': :'String',
    'compartment_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'external_key_manager_ip': :'String',
    'ca_bundle': :'String',
    'port': :'Integer'
    # 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



154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/oci/key_management/models/create_ekms_private_endpoint_details.rb', line 154

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

  self.class == other.class &&
    subnet_id == other.subnet_id &&
    compartment_id == other.compartment_id &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    display_name == other.display_name &&
    external_key_manager_ip == other.external_key_manager_ip &&
    ca_bundle == other.ca_bundle &&
    port == other.port
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



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/oci/key_management/models/create_ekms_private_endpoint_details.rb', line 191

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


171
172
173
 
# File 'lib/oci/key_management/models/create_ekms_private_endpoint_details.rb', line 171

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



180
181
182
 
# File 'lib/oci/key_management/models/create_ekms_private_endpoint_details.rb', line 180

def hash
  [subnet_id, compartment_id, freeform_tags, defined_tags, display_name, external_key_manager_ip, ca_bundle, port].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



224
225
226
227
228
229
230
231
232
233
 
# File 'lib/oci/key_management/models/create_ekms_private_endpoint_details.rb', line 224

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



218
219
220
 
# File 'lib/oci/key_management/models/create_ekms_private_endpoint_details.rb', line 218

def to_s
  to_hash.to_s
end