Class: OCI::Apigateway::ApiGatewayClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/apigateway/api_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) ⇒ ApiGatewayClient

Creates a new ApiGatewayClient. 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/api_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 "ApiGatewayClient 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/api_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/api_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/api_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/api_gateway_client.rb', line 27

def retry_config
  @retry_config
end

Instance Method Details

#add_api_lock(api_id, add_resource_lock_details, opts = {}) ⇒ Response

Note:

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

Adds a lock to a Api 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:

  • (Response) —

    A Response object with data of type Api



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/api_gateway_client.rb', line 120

def add_api_lock(api_id, add_resource_lock_details, opts = {})
  logger.debug 'Calling operation ApiGatewayClient#add_api_lock.' if logger

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

  path = '/apis/{apiId}/actions/addLock'.sub('{apiId}', api_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: 'ApiGatewayClient#add_api_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::Api'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#add_certificate_lock(certificate_id, add_resource_lock_details, opts = {}) ⇒ Response

Note:

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

Adds a lock to a Certificate 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:



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

def add_certificate_lock(certificate_id, add_resource_lock_details, opts = {})
  logger.debug 'Calling operation ApiGatewayClient#add_certificate_lock.' if logger

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

  path = '/certificates/{certificateId}/actions/addLock'.sub('{certificateId}', certificate_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: 'ApiGatewayClient#add_certificate_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::Certificate'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#add_sdk_lock(sdk_id, add_resource_lock_details, opts = {}) ⇒ Response

Note:

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

Adds a lock to a Sdk 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:

  • (Response) —

    A Response object with data of type Sdk



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

def add_sdk_lock(sdk_id, add_resource_lock_details, opts = {})
  logger.debug 'Calling operation ApiGatewayClient#add_sdk_lock.' if logger

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

  path = '/sdks/{sdkId}/actions/addLock'.sub('{sdkId}', sdk_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: 'ApiGatewayClient#add_sdk_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::Sdk'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_api_compartment(api_id, change_api_compartment_details, opts = {}) ⇒ Response

Note:

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

Changes the API 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



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

def change_api_compartment(api_id, change_api_compartment_details, opts = {})
  logger.debug 'Calling operation ApiGatewayClient#change_api_compartment.' if logger

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

  path = '/apis/{apiId}/actions/changeCompartment'.sub('{apiId}', api_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_api_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApiGatewayClient#change_api_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

#change_certificate_compartment(certificate_id, change_certificate_compartment_details, opts = {}) ⇒ Response

Note:

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

Changes the certificate 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



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/oci/apigateway/api_gateway_client.rb', line 388

def change_certificate_compartment(certificate_id, change_certificate_compartment_details, opts = {})
  logger.debug 'Calling operation ApiGatewayClient#change_certificate_compartment.' if logger

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

  path = '/certificates/{certificateId}/actions/changeCompartment'.sub('{certificateId}', certificate_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_certificate_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApiGatewayClient#change_certificate_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_api(create_api_details, opts = {}) ⇒ Response

Note:

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

Creates a new API.

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:

  • (Response) —

    A Response object with data of type Api



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

def create_api(create_api_details, opts = {})
  logger.debug 'Calling operation ApiGatewayClient#create_api.' if logger

  raise "Missing the required parameter 'create_api_details' when calling create_api." if create_api_details.nil?

  path = '/apis'
  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_api_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApiGatewayClient#create_api') 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::Api'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_certificate(create_certificate_details, opts = {}) ⇒ Response

Note:

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

Creates a new Certificate.

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:



515
516
517
518
519
520
521
522
523
524
525
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
 
# File 'lib/oci/apigateway/api_gateway_client.rb', line 515

def create_certificate(create_certificate_details, opts = {})
  logger.debug 'Calling operation ApiGatewayClient#create_certificate.' if logger

  raise "Missing the required parameter 'create_certificate_details' when calling create_certificate." if create_certificate_details.nil?

  path = '/certificates'
  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_certificate_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApiGatewayClient#create_certificate') 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::Certificate'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_sdk(create_sdk_details, opts = {}) ⇒ Response

Note:

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

Creates a new SDK.

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:

  • (Response) —

    A Response object with data of type Sdk



576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
 
# File 'lib/oci/apigateway/api_gateway_client.rb', line 576

def create_sdk(create_sdk_details, opts = {})
  logger.debug 'Calling operation ApiGatewayClient#create_sdk.' if logger

  raise "Missing the required parameter 'create_sdk_details' when calling create_sdk." if create_sdk_details.nil?

  path = '/sdks'
  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_sdk_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApiGatewayClient#create_sdk') 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::Sdk'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_api(api_id, opts = {}) ⇒ Response

Note:

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

Deletes the API with the given identifier.

Parameters:

  • api_id (String) —

    The ocid of the API.

  • 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



638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
 
# File 'lib/oci/apigateway/api_gateway_client.rb', line 638

def delete_api(api_id, opts = {})
  logger.debug 'Calling operation ApiGatewayClient#delete_api.' if logger

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

  path = '/apis/{apiId}'.sub('{apiId}', api_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: 'ApiGatewayClient#delete_api') 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

#delete_certificate(certificate_id, opts = {}) ⇒ Response

Note:

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

Deletes the certificate with the given identifier.

Parameters:

  • certificate_id (String) —

    The ocid of the certificate.

  • 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



700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
 
# File 'lib/oci/apigateway/api_gateway_client.rb', line 700

def delete_certificate(certificate_id, opts = {})
  logger.debug 'Calling operation ApiGatewayClient#delete_certificate.' if logger

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

  path = '/certificates/{certificateId}'.sub('{certificateId}', certificate_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: 'ApiGatewayClient#delete_certificate') 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

#delete_sdk(sdk_id, opts = {}) ⇒ Response

Note:

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

Deletes provided SDK.

Parameters:

  • sdk_id (String) —

    The ocid of the SDK.

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

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

  • :is_lock_override (BOOLEAN) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
 
# File 'lib/oci/apigateway/api_gateway_client.rb', line 762

def delete_sdk(sdk_id, opts = {})
  logger.debug 'Calling operation ApiGatewayClient#delete_sdk.' if logger

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

  path = '/sdks/{sdkId}'.sub('{sdkId}', sdk_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-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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApiGatewayClient#delete_sdk') 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_api(api_id, opts = {}) ⇒ Response

Note:

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

Gets an API by identifier.

Parameters:

  • api_id (String) —

    The ocid of the API.

  • 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:

  • (Response) —

    A Response object with data of type Api



817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
 
# File 'lib/oci/apigateway/api_gateway_client.rb', line 817

def get_api(api_id, opts = {})
  logger.debug 'Calling operation ApiGatewayClient#get_api.' if logger

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

  path = '/apis/{apiId}'.sub('{apiId}', api_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: 'ApiGatewayClient#get_api') 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::Api'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_api_content(api_id, opts = {}, &block) ⇒ Response

Note:

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

Get the raw API content.

Parameters:

  • api_id (String) —

    The ocid of the API.

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

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

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)

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

  • :range (String) —

    The Range HTTP request header indicates the part of a document that the server should return. RFC 7233. Note that only a single range of bytes is supported. (default to null)

  • :response_target (String, IO) —

    Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

  • (Response) —

    A Response object with data of type String if response_target and block are not given, otherwise with nil data



883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
 
# File 'lib/oci/apigateway/api_gateway_client.rb', line 883

def get_api_content(api_id, opts = {}, &block)
  logger.debug 'Calling operation ApiGatewayClient#get_api_content.' if logger

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

  path = '/apis/{apiId}/content'.sub('{apiId}', api_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/json'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  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]
  header_params[:range] = opts[:range] if opts[:range]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApiGatewayClient#get_api_content') do
    if !block.nil?
      @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: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @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: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @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: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @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: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#get_api_deployment_specification(api_id, opts = {}) ⇒ Response

Note:

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

Gets an API Deployment specification by identifier.

Parameters:

  • api_id (String) —

    The ocid of the API.

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

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

Returns:



989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
 
# File 'lib/oci/apigateway/api_gateway_client.rb', line 989

def get_api_deployment_specification(api_id, opts = {})
  logger.debug 'Calling operation ApiGatewayClient#get_api_deployment_specification.' if logger

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

  path = '/apis/{apiId}/deploymentSpecification'.sub('{apiId}', api_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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApiGatewayClient#get_api_deployment_specification') 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::ApiSpecification'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_api_validations(api_id, opts = {}) ⇒ Response

Note:

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

Gets the API validation results.

Parameters:

  • api_id (String) —

    The ocid of the API.

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

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

Returns:



1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
 
# File 'lib/oci/apigateway/api_gateway_client.rb', line 1050

def get_api_validations(api_id, opts = {})
  logger.debug 'Calling operation ApiGatewayClient#get_api_validations.' if logger

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

  path = '/apis/{apiId}/validations'.sub('{apiId}', api_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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApiGatewayClient#get_api_validations') 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::ApiValidations'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_certificate(certificate_id, opts = {}) ⇒ Response

Note:

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

Gets a certificate by identifier.

Parameters:

  • certificate_id (String) —

    The ocid of the certificate.

  • 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:



1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
 
# File 'lib/oci/apigateway/api_gateway_client.rb', line 1105

def get_certificate(certificate_id, opts = {})
  logger.debug 'Calling operation ApiGatewayClient#get_certificate.' if logger

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

  path = '/certificates/{certificateId}'.sub('{certificateId}', certificate_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: 'ApiGatewayClient#get_certificate') 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::Certificate'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_sdk(sdk_id, opts = {}) ⇒ Response

Note:

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

Return object store downloadable URL and metadata.

Parameters:

  • sdk_id (String) —

    The ocid of the SDK.

  • 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:

  • (Response) —

    A Response object with data of type Sdk



1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
 
# File 'lib/oci/apigateway/api_gateway_client.rb', line 1159

def get_sdk(sdk_id, opts = {})
  logger.debug 'Calling operation ApiGatewayClient#get_sdk.' if logger

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

  path = '/sdks/{sdkId}'.sub('{sdkId}', sdk_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: 'ApiGatewayClient#get_sdk') 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::Sdk'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns a list of APIs.

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

  • :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: ACTIVE (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:



1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
 
# File 'lib/oci/apigateway/api_gateway_client.rb', line 1232

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

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

  if opts[:lifecycle_state] && !OCI::Apigateway::Models::ApiSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Apigateway::Models::ApiSummary::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 = '/apis'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_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: 'ApiGatewayClient#list_apis') 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::ApiCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns a list of certificates.

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

  • :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: ACTIVE or DELETED (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:



1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
 
# File 'lib/oci/apigateway/api_gateway_client.rb', line 1323

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

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

  if opts[:lifecycle_state] && !OCI::Apigateway::Models::Certificate::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Apigateway::Models::Certificate::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 = '/certificates'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_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: 'ApiGatewayClient#list_certificates') 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::CertificateCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists programming languages in which SDK can be generated.

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

  • :display_name (String) —

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

    Example: My new resource (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:



1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
 
# File 'lib/oci/apigateway/api_gateway_client.rb', line 1409

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

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

  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 = '/sdkLanguageTypes'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  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: 'ApiGatewayClient#list_sdk_language_types') 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::SdkLanguageTypeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sdks(opts = {}) ⇒ Response

Note:

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

Returns list of generated SDKs.

Parameters:

  • 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

  • :sdk_id (String) —

    The ocid of the SDK. This value must be present unless apiId is present. (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: ACTIVE or DELETED (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

  • :api_id (String) —

    The ocid of the API. This value must be present unless sdkId is present. (default to null)

  • :opc_request_id (String) —

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

Returns:



1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
 
# File 'lib/oci/apigateway/api_gateway_client.rb', line 1495

def list_sdks(opts = {})
  logger.debug 'Calling operation ApiGatewayClient#list_sdks.' if logger


  if opts[:lifecycle_state] && !OCI::Apigateway::Models::Sdk::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Apigateway::Models::Sdk::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 = '/sdks'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:sdkId] = opts[:sdk_id] if opts[:sdk_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]
  query_params[:apiId] = opts[:api_id] if opts[:api_id]

  # 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: 'ApiGatewayClient#list_sdks') 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::SdkCollection'
    )
  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/api_gateway_client.rb', line 96

def logger
  @api_client.config.logger
end

#remove_api_lock(api_id, remove_resource_lock_details, opts = {}) ⇒ Response

Note:

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

Removes a lock from a Api 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:

  • (Response) —

    A Response object with data of type Api



1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
 
# File 'lib/oci/apigateway/api_gateway_client.rb', line 1574

def remove_api_lock(api_id, remove_resource_lock_details, opts = {})
  logger.debug 'Calling operation ApiGatewayClient#remove_api_lock.' if logger

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

  path = '/apis/{apiId}/actions/removeLock'.sub('{apiId}', api_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: 'ApiGatewayClient#remove_api_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::Api'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#remove_certificate_lock(certificate_id, remove_resource_lock_details, opts = {}) ⇒ Response

Note:

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

Removes a lock from a Certificate 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:



1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
 
# File 'lib/oci/apigateway/api_gateway_client.rb', line 1637

def remove_certificate_lock(certificate_id, remove_resource_lock_details, opts = {})
  logger.debug 'Calling operation ApiGatewayClient#remove_certificate_lock.' if logger

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

  path = '/certificates/{certificateId}/actions/removeLock'.sub('{certificateId}', certificate_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: 'ApiGatewayClient#remove_certificate_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::Certificate'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#remove_sdk_lock(sdk_id, remove_resource_lock_details, opts = {}) ⇒ Response

Note:

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

Removes a lock from a Sdk 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:

  • (Response) —

    A Response object with data of type Sdk



1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
 
# File 'lib/oci/apigateway/api_gateway_client.rb', line 1700

def remove_sdk_lock(sdk_id, remove_resource_lock_details, opts = {})
  logger.debug 'Calling operation ApiGatewayClient#remove_sdk_lock.' if logger

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

  path = '/sdks/{sdkId}/actions/removeLock'.sub('{sdkId}', sdk_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: 'ApiGatewayClient#remove_sdk_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::Sdk'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_api(api_id, update_api_details, opts = {}) ⇒ Response

Note:

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

Updates the API 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



1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
 
# File 'lib/oci/apigateway/api_gateway_client.rb', line 1764

def update_api(api_id, update_api_details, opts = {})
  logger.debug 'Calling operation ApiGatewayClient#update_api.' if logger

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

  path = '/apis/{apiId}'.sub('{apiId}', api_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_api_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApiGatewayClient#update_api') 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

#update_certificate(certificate_id, update_certificate_details, opts = {}) ⇒ Response

Note:

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

Updates a certificate 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



1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
 
# File 'lib/oci/apigateway/api_gateway_client.rb', line 1828

def update_certificate(certificate_id, update_certificate_details, opts = {})
  logger.debug 'Calling operation ApiGatewayClient#update_certificate.' if logger

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

  path = '/certificates/{certificateId}'.sub('{certificateId}', certificate_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_certificate_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApiGatewayClient#update_certificate') 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

#update_sdk(sdk_id, update_sdk_details, opts = {}) ⇒ Response

Note:

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

Updates the SDK 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 Sdk



1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
 
# File 'lib/oci/apigateway/api_gateway_client.rb', line 1892

def update_sdk(sdk_id, update_sdk_details, opts = {})
  logger.debug 'Calling operation ApiGatewayClient#update_sdk.' if logger

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

  path = '/sdks/{sdkId}'.sub('{sdkId}', sdk_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_sdk_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApiGatewayClient#update_sdk') 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,
      return_type: 'OCI::Apigateway::Models::Sdk'
    )
  end
  # rubocop:enable Metrics/BlockLength
end