Class: OCI::Apigateway::GatewayClient

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

Overview

API for the API Gateway service. Use this API to manage gateways, deployments, and related items. For more information, see Overview of API Gateway.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ GatewayClient

Creates a new GatewayClient. Notes: If a config is not specified, then the global OCI.config will be used.

This client is not thread-safe

Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the region. A region may be specified in the config or via or the region parameter. If specified in both, then the region parameter will be used.

Parameters:

  • config (Config) (defaults to: nil) —

    A Config object.

  • region (String) (defaults to: nil) —

    A region used to determine the service endpoint. This will usually correspond to a value in Regions::REGION_ENUM, but may be an arbitrary string.

  • endpoint (String) (defaults to: nil) —

    The fully qualified endpoint URL

  • signer (OCI::BaseSigner) (defaults to: nil) —

    A signer implementation which can be used by this client. If this is not provided then a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication, so that the instance principals signer can be provided to the client

  • proxy_settings (OCI::ApiClientProxySettings) (defaults to: nil) —

    If your environment requires you to use a proxy server for outgoing HTTP requests the details for the proxy can be provided in this parameter

  • retry_config (OCI::Retry::RetryConfig) (defaults to: nil) —

    The retry configuration for this service client. This represents the default retry configuration to apply across all operations. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/oci/apigateway/gateway_client.rb', line 57

def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil)
  # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers)
  # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals
  # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then
  # pass it to this constructor.
  #
  # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid
  # so try and load the config from the default file.
  config = OCI::Config.validate_and_build_config_with_signer(config, signer)

  signer = OCI::Signer.config_file_auth_builder(config) if signer.nil?

  @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings)
  @retry_config = retry_config

  if endpoint
    @endpoint = endpoint + '/20190501'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "GatewayClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



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

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/apigateway/gateway_client.rb', line 21

def endpoint
  @endpoint
end

#region ⇒ String

The region, which will usually correspond to a value in Regions::REGION_ENUM.

Returns:

  • (String) 


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

def region
  @region
end

#retry_config ⇒ OCI::Retry::RetryConfig (readonly)

The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries

Returns:



27
28
29
 
# File 'lib/oci/apigateway/gateway_client.rb', line 27

def retry_config
  @retry_config
end

Instance Method Details

#add_gateway_lock(gateway_id, add_resource_lock_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use add_gateway_lock API.

Adds a lock to a Gateway resource.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



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
 
# File 'lib/oci/apigateway/gateway_client.rb', line 120

def add_gateway_lock(gateway_id, add_resource_lock_details, opts = {})
  logger.debug 'Calling operation GatewayClient#add_gateway_lock.' if logger

  raise "Missing the required parameter 'gateway_id' when calling add_gateway_lock." if gateway_id.nil?
  raise "Missing the required parameter 'add_resource_lock_details' when calling add_gateway_lock." if add_resource_lock_details.nil?
  raise "Parameter value for 'gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(gateway_id)

  path = '/gateways/{gatewayId}/actions/addLock'.sub('{gatewayId}', gateway_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(add_resource_lock_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GatewayClient#add_gateway_lock') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Apigateway::Models::Gateway'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_gateway_compartment(gateway_id, change_gateway_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_gateway_compartment API.

Changes the gateway compartment.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. (default to null)

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. (default to null)

  • :opc_request_id (String) —

    The client request id for tracing. (default to null)

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/apigateway/gateway_client.rb', line 190

def change_gateway_compartment(gateway_id, change_gateway_compartment_details, opts = {})
  logger.debug 'Calling operation GatewayClient#change_gateway_compartment.' if logger

  raise "Missing the required parameter 'gateway_id' when calling change_gateway_compartment." if gateway_id.nil?
  raise "Missing the required parameter 'change_gateway_compartment_details' when calling change_gateway_compartment." if change_gateway_compartment_details.nil?
  raise "Parameter value for 'gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(gateway_id)

  path = '/gateways/{gatewayId}/actions/changeCompartment'.sub('{gatewayId}', gateway_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_gateway_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GatewayClient#change_gateway_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_gateway(create_gateway_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_gateway API.

Creates a new gateway.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. (default to null)

  • :opc_request_id (String) —

    The client request id for tracing. (default to null)

Returns:



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
 
# File 'lib/oci/apigateway/gateway_client.rb', line 255

def create_gateway(create_gateway_details, opts = {})
  logger.debug 'Calling operation GatewayClient#create_gateway.' if logger

  raise "Missing the required parameter 'create_gateway_details' when calling create_gateway." if create_gateway_details.nil?

  path = '/gateways'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_gateway_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GatewayClient#create_gateway') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Apigateway::Models::Gateway'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_gateway(gateway_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_gateway API.

Deletes the gateway with the given identifier.

Parameters:

  • gateway_id (String) —

    The ocid of the gateway.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. (default to null)

  • :opc_request_id (String) —

    The client request id for tracing. (default to null)

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/apigateway/gateway_client.rb', line 317

def delete_gateway(gateway_id, opts = {})
  logger.debug 'Calling operation GatewayClient#delete_gateway.' if logger

  raise "Missing the required parameter 'gateway_id' when calling delete_gateway." if gateway_id.nil?
  raise "Parameter value for 'gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(gateway_id)

  path = '/gateways/{gatewayId}'.sub('{gatewayId}', gateway_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GatewayClient#delete_gateway') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_gateway(gateway_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_gateway API.

Gets a gateway by identifier.

Parameters:

  • gateway_id (String) —

    The ocid of the gateway.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request id for tracing. (default to null)

Returns:



372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/oci/apigateway/gateway_client.rb', line 372

def get_gateway(gateway_id, opts = {})
  logger.debug 'Calling operation GatewayClient#get_gateway.' if logger

  raise "Missing the required parameter 'gateway_id' when calling get_gateway." if gateway_id.nil?
  raise "Parameter value for 'gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(gateway_id)

  path = '/gateways/{gatewayId}'.sub('{gatewayId}', gateway_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GatewayClient#get_gateway') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Apigateway::Models::Gateway'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_gateways(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_gateways API.

Returns a list of gateways.

Parameters:

  • compartment_id (String) —

    The ocid of the compartment in which to list resources.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :certificate_id (String) —

    Filter gateways by the certificate ocid. (default to null)

  • :display_name (String) —

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

    Example: My new resource (default to null)

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state.

    Example: SUCCEEDED (default to null)

  • :limit (Integer) —

    The maximum number of items to return. (default to 100)

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. (default to null)

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. The default order depends on the sortBy value. (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for timeCreated is descending. Default order for displayName is ascending. The displayName sort order is case sensitive. (default to timeCreated) Allowed values are: timeCreated, displayName

  • :opc_request_id (String) —

    The client request id for tracing. (default to null)

Returns:



446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'lib/oci/apigateway/gateway_client.rb', line 446

def list_gateways(compartment_id, opts = {})
  logger.debug 'Calling operation GatewayClient#list_gateways.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_gateways." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::Apigateway::Models::Gateway::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Apigateway::Models::Gateway::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.'
  end

  path = '/gateways'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:certificateId] = opts[:certificate_id] if opts[:certificate_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GatewayClient#list_gateways') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Apigateway::Models::GatewayCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



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

def logger
  @api_client.config.logger
end

#remove_gateway_lock(gateway_id, remove_resource_lock_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use remove_gateway_lock API.

Removes a lock from a Gateway resource.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
 
# File 'lib/oci/apigateway/gateway_client.rb', line 526

def remove_gateway_lock(gateway_id, remove_resource_lock_details, opts = {})
  logger.debug 'Calling operation GatewayClient#remove_gateway_lock.' if logger

  raise "Missing the required parameter 'gateway_id' when calling remove_gateway_lock." if gateway_id.nil?
  raise "Missing the required parameter 'remove_resource_lock_details' when calling remove_gateway_lock." if remove_resource_lock_details.nil?
  raise "Parameter value for 'gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(gateway_id)

  path = '/gateways/{gatewayId}/actions/removeLock'.sub('{gatewayId}', gateway_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(remove_resource_lock_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GatewayClient#remove_gateway_lock') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Apigateway::Models::Gateway'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_gateway(gateway_id, update_gateway_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_gateway API.

Updates the gateway with the given identifier.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. (default to null)

  • :opc_request_id (String) —

    The client request id for tracing. (default to null)

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

Returns:

  • (Response) —

    A Response object with data of type nil



590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
 
# File 'lib/oci/apigateway/gateway_client.rb', line 590

def update_gateway(gateway_id, update_gateway_details, opts = {})
  logger.debug 'Calling operation GatewayClient#update_gateway.' if logger

  raise "Missing the required parameter 'gateway_id' when calling update_gateway." if gateway_id.nil?
  raise "Missing the required parameter 'update_gateway_details' when calling update_gateway." if update_gateway_details.nil?
  raise "Parameter value for 'gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(gateway_id)

  path = '/gateways/{gatewayId}'.sub('{gatewayId}', gateway_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_gateway_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GatewayClient#update_gateway') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end