Class: OCI::Apigateway::Models::CreateGatewayDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/apigateway/models/create_gateway_details.rb

Overview

Information about the new gateway.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateGatewayDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/oci/apigateway/models/create_gateway_details.rb', line 158

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

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

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

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

  self.certificate_id = attributes[:'certificateId'] if attributes[:'certificateId']

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

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

  self.response_cache_details = attributes[:'responseCacheDetails'] if attributes[:'responseCacheDetails']

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

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

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

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

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

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

  self.ip_mode = attributes[:'ipMode'] if attributes[:'ipMode']

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

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

  self.ipv6_address_configuration = attributes[:'ipv6AddressConfiguration'] if attributes[:'ipv6AddressConfiguration']

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

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

  self.ipv4_address_configuration = attributes[:'ipv4AddressConfiguration'] if attributes[:'ipv4AddressConfiguration']

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

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

Instance Attribute Details

#ca_bundles ⇒ Array<OCI::Apigateway::Models::CaBundle>

An array of CA bundles that should be used on the Gateway for TLS validation.

Returns:



77
78
79
 
# File 'lib/oci/apigateway/models/create_gateway_details.rb', line 77

def ca_bundles
  @ca_bundles
end

#certificate_id ⇒ String

The OCID of the resource which can be empty string.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/apigateway/models/create_gateway_details.rb', line 48

def certificate_id
  @certificate_id
end

#compartment_id ⇒ String

[Required] The OCID of the compartment in which the resource is created.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/apigateway/models/create_gateway_details.rb', line 23

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


73
74
75
 
# File 'lib/oci/apigateway/models/create_gateway_details.rb', line 73

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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

Example: My new resource

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/apigateway/models/create_gateway_details.rb', line 17

def display_name
  @display_name
end

#endpoint_type ⇒ String

[Required] Gateway endpoint type. PUBLIC will have a public ip address assigned to it, while PRIVATE will only be accessible on a private IP address on the subnet.

Example: PUBLIC or PRIVATE

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/apigateway/models/create_gateway_details.rb', line 31

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


64
65
66
 
# File 'lib/oci/apigateway/models/create_gateway_details.rb', line 64

def freeform_tags
  @freeform_tags
end

#ip_mode ⇒ String

Determines whether the gateway has an IPv4 or IPv6 address assigned to it, or both. IPV4 means the gateway will only have an IPv4 address assigned to it, and IPV6 means the gateway will only have an IPv6 address assigned to it. DUAL_STACK means the gateway will have both an IPv4 and IPv6 address assigned to it. Example: IPV4 or IPV6 or DUAL_STACK

Returns:

  • (String) 


86
87
88
 
# File 'lib/oci/apigateway/models/create_gateway_details.rb', line 86

def ip_mode
  @ip_mode
end

#ipv4_address_configuration ⇒ OCI::Apigateway::Models::Ipv4AddressConfiguration

Returns:



92
93
94
 
# File 'lib/oci/apigateway/models/create_gateway_details.rb', line 92

def ipv4_address_configuration
  @ipv4_address_configuration
end

#ipv6_address_configuration ⇒ OCI::Apigateway::Models::Ipv6AddressConfiguration

Returns:



89
90
91
 
# File 'lib/oci/apigateway/models/create_gateway_details.rb', line 89

def ipv6_address_configuration
  @ipv6_address_configuration
end

#locks ⇒ Array<OCI::Apigateway::Models::AddResourceLockDetails>

Locks associated with this resource.

Returns:



55
56
57
 
# File 'lib/oci/apigateway/models/create_gateway_details.rb', line 55

def locks
  @locks
end

#network_security_group_ids ⇒ Array<String>

An array of Network Security Groups OCIDs associated with this API Gateway.

Returns:

  • (Array<String>) 


42
43
44
 
# File 'lib/oci/apigateway/models/create_gateway_details.rb', line 42

def network_security_group_ids
  @network_security_group_ids
end

#response_cache_details ⇒ OCI::Apigateway::Models::ResponseCacheDetails

Returns:



51
52
53
 
# File 'lib/oci/apigateway/models/create_gateway_details.rb', line 51

def response_cache_details
  @response_cache_details
end

#subnet_id ⇒ String

[Required] The OCID of the subnet in which related resources are created.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/apigateway/models/create_gateway_details.rb', line 37

def subnet_id
  @subnet_id
end

Class Method Details

.attribute_map ⇒ Object

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



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/oci/apigateway/models/create_gateway_details.rb', line 95

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'endpoint_type': :'endpointType',
    'subnet_id': :'subnetId',
    'network_security_group_ids': :'networkSecurityGroupIds',
    'certificate_id': :'certificateId',
    'response_cache_details': :'responseCacheDetails',
    'locks': :'locks',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'ca_bundles': :'caBundles',
    'ip_mode': :'ipMode',
    'ipv6_address_configuration': :'ipv6AddressConfiguration',
    'ipv4_address_configuration': :'ipv4AddressConfiguration'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/oci/apigateway/models/create_gateway_details.rb', line 117

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'compartment_id': :'String',
    'endpoint_type': :'String',
    'subnet_id': :'String',
    'network_security_group_ids': :'Array<String>',
    'certificate_id': :'String',
    'response_cache_details': :'OCI::Apigateway::Models::ResponseCacheDetails',
    'locks': :'Array<OCI::Apigateway::Models::AddResourceLockDetails>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'ca_bundles': :'Array<OCI::Apigateway::Models::CaBundle>',
    'ip_mode': :'String',
    'ipv6_address_configuration': :'OCI::Apigateway::Models::Ipv6AddressConfiguration',
    'ipv4_address_configuration': :'OCI::Apigateway::Models::Ipv4AddressConfiguration'
    # 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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/oci/apigateway/models/create_gateway_details.rb', line 252

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

  self.class == other.class &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    endpoint_type == other.endpoint_type &&
    subnet_id == other.subnet_id &&
    network_security_group_ids == other.network_security_group_ids &&
    certificate_id == other.certificate_id &&
    response_cache_details == other.response_cache_details &&
    locks == other.locks &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    ca_bundles == other.ca_bundles &&
    ip_mode == other.ip_mode &&
    ipv6_address_configuration == other.ipv6_address_configuration &&
    ipv4_address_configuration == other.ipv4_address_configuration
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



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/oci/apigateway/models/create_gateway_details.rb', line 295

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


275
276
277
 
# File 'lib/oci/apigateway/models/create_gateway_details.rb', line 275

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



284
285
286
 
# File 'lib/oci/apigateway/models/create_gateway_details.rb', line 284

def hash
  [display_name, compartment_id, endpoint_type, subnet_id, network_security_group_ids, certificate_id, response_cache_details, locks, freeform_tags, defined_tags, ca_bundles, ip_mode, ipv6_address_configuration, ipv4_address_configuration].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



328
329
330
331
332
333
334
335
336
337
 
# File 'lib/oci/apigateway/models/create_gateway_details.rb', line 328

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



322
323
324
 
# File 'lib/oci/apigateway/models/create_gateway_details.rb', line 322

def to_s
  to_hash.to_s
end