Class: OCI::Apigateway::Models::Gateway

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

Overview

A gateway is a virtual network appliance in a regional subnet. A gateway routes inbound traffic to back-end services including public, private, and partner HTTP APIs, as well as Oracle Functions. Avoid entering confidential information. For more information, see API Gateway Concepts.

Constant Summary collapse

ENDPOINT_TYPE_ENUM = 
[
  ENDPOINT_TYPE_PUBLIC = 'PUBLIC'.freeze,
  ENDPOINT_TYPE_PRIVATE = 'PRIVATE'.freeze,
  ENDPOINT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
IP_MODE_ENUM = 
[
  IP_MODE_IPV4 = 'IPV4'.freeze,
  IP_MODE_IPV6 = 'IPV6'.freeze,
  IP_MODE_DUAL_STACK = 'DUAL_STACK'.freeze,
  IP_MODE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Gateway

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/oci/apigateway/models/gateway.rb', line 245

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

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

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

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

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

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

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

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

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

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



140
141
142
 
# File 'lib/oci/apigateway/models/gateway.rb', line 140

def ca_bundles
  @ca_bundles
end

#certificate_id ⇒ String

The OCID of the resource.

Returns:

  • (String) 


105
106
107
 
# File 'lib/oci/apigateway/models/gateway.rb', line 105

def certificate_id
  @certificate_id
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/apigateway/models/gateway.rb', line 54

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


130
131
132
 
# File 'lib/oci/apigateway/models/gateway.rb', line 130

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) 


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

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) 


62
63
64
 
# File 'lib/oci/apigateway/models/gateway.rb', line 62

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


121
122
123
 
# File 'lib/oci/apigateway/models/gateway.rb', line 121

def freeform_tags
  @freeform_tags
end

#hostname ⇒ String

The hostname for APIs deployed on the gateway.

Returns:

  • (String) 


100
101
102
 
# File 'lib/oci/apigateway/models/gateway.rb', line 100

def hostname
  @hostname
end

#id ⇒ String

[Required] The OCID of the resource.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/apigateway/models/gateway.rb', line 40

def id
  @id
end

#ip_addresses ⇒ Array<OCI::Apigateway::Models::IpAddress>

An array of IP addresses associated with the gateway.

Returns:



109
110
111
 
# File 'lib/oci/apigateway/models/gateway.rb', line 109

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


149
150
151
 
# File 'lib/oci/apigateway/models/gateway.rb', line 149

def ip_mode
  @ip_mode
end

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

Returns:



155
156
157
 
# File 'lib/oci/apigateway/models/gateway.rb', line 155

def ipv4_address_configuration
  @ipv4_address_configuration
end

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

Returns:



152
153
154
 
# File 'lib/oci/apigateway/models/gateway.rb', line 152

def ipv6_address_configuration
  @ipv6_address_configuration
end

#lifecycle_details ⇒ String

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.

Returns:

  • (String) 


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

The current state of the gateway.

Returns:

  • (String) 


85
86
87
 
# File 'lib/oci/apigateway/models/gateway.rb', line 85

def lifecycle_state
  @lifecycle_state
end

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

Locks associated with this resource.

Returns:



96
97
98
 
# File 'lib/oci/apigateway/models/gateway.rb', line 96

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


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

def network_security_group_ids
  @network_security_group_ids
end

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

Returns:



112
113
114
 
# File 'lib/oci/apigateway/models/gateway.rb', line 112

def response_cache_details
  @response_cache_details
end

#subnet_id ⇒ String

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

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/apigateway/models/gateway.rb', line 68

def subnet_id
  @subnet_id
end

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

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


136
137
138
 
# File 'lib/oci/apigateway/models/gateway.rb', line 136

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

The time this resource was created. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The time this resource was last updated. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


81
82
83
 
# File 'lib/oci/apigateway/models/gateway.rb', line 81

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/apigateway/models/gateway.rb', line 158

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'endpoint_type': :'endpointType',
    'subnet_id': :'subnetId',
    'network_security_group_ids': :'networkSecurityGroupIds',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'locks': :'locks',
    'hostname': :'hostname',
    'certificate_id': :'certificateId',
    'ip_addresses': :'ipAddresses',
    'response_cache_details': :'responseCacheDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    '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.



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
 
# File 'lib/oci/apigateway/models/gateway.rb', line 188

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'endpoint_type': :'String',
    'subnet_id': :'String',
    'network_security_group_ids': :'Array<String>',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'locks': :'Array<OCI::Apigateway::Models::ResourceLock>',
    'hostname': :'String',
    'certificate_id': :'String',
    'ip_addresses': :'Array<OCI::Apigateway::Models::IpAddress>',
    'response_cache_details': :'OCI::Apigateway::Models::ResponseCacheDetails',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_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



418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/oci/apigateway/models/gateway.rb', line 418

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

  self.class == other.class &&
    id == other.id &&
    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 &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    locks == other.locks &&
    hostname == other.hostname &&
    certificate_id == other.certificate_id &&
    ip_addresses == other.ip_addresses &&
    response_cache_details == other.response_cache_details &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_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



469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
 
# File 'lib/oci/apigateway/models/gateway.rb', line 469

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


449
450
451
 
# File 'lib/oci/apigateway/models/gateway.rb', line 449

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



458
459
460
 
# File 'lib/oci/apigateway/models/gateway.rb', line 458

def hash
  [id, display_name, compartment_id, endpoint_type, subnet_id, network_security_group_ids, time_created, time_updated, lifecycle_state, lifecycle_details, locks, hostname, certificate_id, ip_addresses, response_cache_details, freeform_tags, defined_tags, system_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



502
503
504
505
506
507
508
509
510
511
 
# File 'lib/oci/apigateway/models/gateway.rb', line 502

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



496
497
498
 
# File 'lib/oci/apigateway/models/gateway.rb', line 496

def to_s
  to_hash.to_s
end