Class: OCI::Functions::FunctionsManagementClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/functions/functions_management_client.rb

Overview

API for the Functions service.

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

Creates a new FunctionsManagementClient. 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



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

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 + '/20181201'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "FunctionsManagementClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



15
16
17
 
# File 'lib/oci/functions/functions_management_client.rb', line 15

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/functions/functions_management_client.rb', line 19

def endpoint
  @endpoint
end

#region ⇒ String

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

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/functions/functions_management_client.rb', line 29

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:



25
26
27
 
# File 'lib/oci/functions/functions_management_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#change_application_compartment(application_id, change_application_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves an application into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources Between Compartments.

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.

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



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/functions/functions_management_client.rb', line 121

def change_application_compartment(application_id, change_application_compartment_details, opts = {})
  logger.debug 'Calling operation FunctionsManagementClient#change_application_compartment.' if logger

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

  path = '/applications/{applicationId}/actions/changeCompartment'.sub('{applicationId}', application_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[:'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(change_application_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'FunctionsManagementClient#change_application_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_application(create_application_details, opts = {}) ⇒ Response

Note:

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

Creates a new application.

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 unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/oci/functions/functions_management_client.rb', line 178

def create_application(create_application_details, opts = {})
  logger.debug 'Calling operation FunctionsManagementClient#create_application.' if logger

  raise "Missing the required parameter 'create_application_details' when calling create_application." if create_application_details.nil?

  path = '/applications'
  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 = @api_client.object_to_http_body(create_application_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'FunctionsManagementClient#create_application') 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::Functions::Models::Application'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_function(create_function_details, opts = {}) ⇒ Response

Note:

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

Creates a new function.

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 unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/oci/functions/functions_management_client.rb', line 233

def create_function(create_function_details, opts = {})
  logger.debug 'Calling operation FunctionsManagementClient#create_function.' if logger

  raise "Missing the required parameter 'create_function_details' when calling create_function." if create_function_details.nil?

  path = '/functions'
  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 = @api_client.object_to_http_body(create_function_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'FunctionsManagementClient#create_function') 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::Functions::Models::Function'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_application(application_id, opts = {}) ⇒ Response

Note:

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

Deletes an application.

Parameters:

  • application_id (String) —

    The OCID of this application.

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

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/oci/functions/functions_management_client.rb', line 293

def delete_application(application_id, opts = {})
  logger.debug 'Calling operation FunctionsManagementClient#delete_application.' if logger

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

  path = '/applications/{applicationId}'.sub('{applicationId}', application_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[:'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: 'FunctionsManagementClient#delete_application') 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_function(function_id, opts = {}) ⇒ Response

Note:

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

Deletes a function.

Parameters:

  • function_id (String) —

    The OCID of this function.

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

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/oci/functions/functions_management_client.rb', line 354

def delete_function(function_id, opts = {})
  logger.debug 'Calling operation FunctionsManagementClient#delete_function.' if logger

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

  path = '/functions/{functionId}'.sub('{functionId}', function_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[:'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: 'FunctionsManagementClient#delete_function') 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_application(application_id, opts = {}) ⇒ Response

Note:

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

Retrieves an application.

Parameters:

  • application_id (String) —

    The OCID of this application.

  • 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 unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/oci/functions/functions_management_client.rb', line 411

def get_application(application_id, opts = {})
  logger.debug 'Calling operation FunctionsManagementClient#get_application.' if logger

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

  path = '/applications/{applicationId}'.sub('{applicationId}', application_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: 'FunctionsManagementClient#get_application') 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::Functions::Models::Application'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_function(function_id, opts = {}) ⇒ Response

Note:

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

Retrieves a function.

Parameters:

  • function_id (String) —

    The OCID of this function.

  • 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 unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



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
502
503
504
 
# File 'lib/oci/functions/functions_management_client.rb', line 468

def get_function(function_id, opts = {})
  logger.debug 'Calling operation FunctionsManagementClient#get_function.' if logger

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

  path = '/functions/{functionId}'.sub('{functionId}', function_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: 'FunctionsManagementClient#get_function') 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::Functions::Models::Function'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_pbf_listing(pbf_listing_id, opts = {}) ⇒ Response

Note:

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

Fetches a Pre-built Function(PBF) Listing. Returns a PbfListing response model.

Parameters:

  • pbf_listing_id (String) —

    unique PbfListing identifier

  • 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 unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



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
553
554
555
556
557
558
559
560
561
 
# File 'lib/oci/functions/functions_management_client.rb', line 525

def get_pbf_listing(pbf_listing_id, opts = {})
  logger.debug 'Calling operation FunctionsManagementClient#get_pbf_listing.' if logger

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

  path = '/pbfListings/{pbfListingId}'.sub('{pbfListingId}', pbf_listing_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: 'FunctionsManagementClient#get_pbf_listing') 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::Functions::Models::PbfListing'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_pbf_listing_version(pbf_listing_version_id, opts = {}) ⇒ Response

Note:

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

Gets a PbfListingVersion by identifier for a PbfListing.

Parameters:

  • pbf_listing_version_id (String) —

    unique PbfListingVersion identifier

  • 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 unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



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
614
615
616
617
 
# File 'lib/oci/functions/functions_management_client.rb', line 581

def get_pbf_listing_version(pbf_listing_version_id, opts = {})
  logger.debug 'Calling operation FunctionsManagementClient#get_pbf_listing_version.' if logger

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

  path = '/pbfListingVersions/{pbfListingVersionId}'.sub('{pbfListingVersionId}', pbf_listing_version_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: 'FunctionsManagementClient#get_pbf_listing_version') 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::Functions::Models::PbfListingVersion'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists applications for a compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment to which this resource belongs.

  • 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

  • :limit (Integer) —

    The maximum number of items to return. 1 is the minimum, 50 is the maximum.

    Default: 10 (default to 5)

  • :page (String) —

    The pagination token for a list query returned by a previous operation

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :lifecycle_state (String) —

    A filter to return only applications that match the lifecycle state in this parameter. Example: Creating

  • :display_name (String) —

    A filter to return only applications with display names that match the display name string. Matching is exact.

  • :id (String) —

    A filter to return only applications with the specified OCID.

  • :sort_order (String) —

    Specifies sort order.

    • ASC: Ascending sort order.

    • DESC: Descending sort order. (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    Specifies the attribute with which to sort the rules.

    Default: displayName

    • timeCreated: Sorts by timeCreated.

    • displayName: Sorts by displayName.

    • id: Sorts by id. (default to displayName) Allowed values are: timeCreated, id, displayName

Returns:



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
 
# File 'lib/oci/functions/functions_management_client.rb', line 666

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

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

  if opts[:lifecycle_state] && !OCI::Functions::Models::Application::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Functions::Models::Application::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 id displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, id, displayName.'
  end

  path = '/applications'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:id] = opts[:id] if opts[:id]
  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: 'FunctionsManagementClient#list_applications') 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: 'Array<OCI::Functions::Models::ApplicationSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_functions(application_id, opts = {}) ⇒ Response

Note:

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

Lists functions for an application.

Parameters:

  • application_id (String) —

    The OCID of the application to which this function belongs.

  • 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

  • :limit (Integer) —

    The maximum number of items to return. 1 is the minimum, 50 is the maximum.

    Default: 10 (default to 5)

  • :page (String) —

    The pagination token for a list query returned by a previous operation

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :lifecycle_state (String) —

    A filter to return only functions that match the lifecycle state in this parameter. Example: Creating

  • :display_name (String) —

    A filter to return only functions with display names that match the display name string. Matching is exact.

  • :id (String) —

    A filter to return only functions with the specified OCID.

  • :sort_order (String) —

    Specifies sort order.

    • ASC: Ascending sort order.

    • DESC: Descending sort order. (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    Specifies the attribute with which to sort the rules.

    Default: displayName

    • timeCreated: Sorts by timeCreated.

    • displayName: Sorts by displayName.

    • id: Sorts by id. (default to displayName) Allowed values are: timeCreated, id, displayName

Returns:



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
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
 
# File 'lib/oci/functions/functions_management_client.rb', line 770

def list_functions(application_id, opts = {})
  logger.debug 'Calling operation FunctionsManagementClient#list_functions.' if logger

  raise "Missing the required parameter 'application_id' when calling list_functions." if application_id.nil?

  if opts[:lifecycle_state] && !OCI::Functions::Models::Function::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Functions::Models::Function::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 id displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, id, displayName.'
  end

  path = '/functions'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:applicationId] = application_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:id] = opts[:id] if opts[:id]
  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: 'FunctionsManagementClient#list_functions') 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: 'Array<OCI::Functions::Models::FunctionSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_pbf_listing_versions(pbf_listing_id, opts = {}) ⇒ Response

Note:

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

Fetches a wrapped list of all Pre-built Function(PBF) Listing versions. Returns a PbfListingVersionCollection containing an array of PbfListingVersionSummary response models.

Note that the PbfListingIdentifier must be provided as a query parameter, otherwise an exception shall be thrown.

Allowed values are: timeCreated, name

Parameters:

  • pbf_listing_id (String) —

    unique PbfListing identifier

  • 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

  • :pbf_listing_version_id (String) —

    unique PbfListingVersion identifier

  • :name (String) —

    Matches a PbfListingVersion based on a provided semantic version name for a PbfListingVersion. Each PbfListingVersion name is unique with respect to its associated PbfListing.

  • :is_current_version (BOOLEAN) —

    Matches the current version (the most recently added version with an Active lifecycleState) associated with a PbfListing.

  • :lifecycle_state (String) —

    A filter to return only resources their lifecycleState matches the given lifecycleState.

  • :limit (Integer) —

    The maximum number of items to return. 1 is the minimum, 50 is the maximum.

    Default: 10 (default to 5)

  • :page (String) —

    The pagination token for a list query returned by a previous operation

  • :sort_order (String) —

    Specifies sort order.

    • ASC: Ascending sort order.

    • DESC: Descending sort order. (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending. (default to timeCreated)

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



873
874
875
876
877
878
879
880
881
882
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
 
# File 'lib/oci/functions/functions_management_client.rb', line 873

def list_pbf_listing_versions(pbf_listing_id, opts = {})
  logger.debug 'Calling operation FunctionsManagementClient#list_pbf_listing_versions.' if logger

  raise "Missing the required parameter 'pbf_listing_id' when calling list_pbf_listing_versions." if pbf_listing_id.nil?

  if opts[:lifecycle_state] && !OCI::Functions::Models::PbfListingVersion::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Functions::Models::PbfListingVersion::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 name].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, name.'
  end

  path = '/pbfListingVersions'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:pbfListingId] = pbf_listing_id
  query_params[:pbfListingVersionId] = opts[:pbf_listing_version_id] if opts[:pbf_listing_version_id]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:isCurrentVersion] = opts[:is_current_version] if !opts[:is_current_version].nil?
  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: 'FunctionsManagementClient#list_pbf_listing_versions') 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::Functions::Models::PbfListingVersionsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_pbf_listings(opts = {}) ⇒ Response

Note:

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

Fetches a wrapped list of all Pre-built Function(PBF) Listings. Returns a PbfListingCollection containing an array of PbfListingSummary response models.

Allowed values are: timeCreated, name

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

  • :pbf_listing_id (String) —

    unique PbfListing identifier

  • :name (String) —

    A filter to return only resources that match the entire PBF name given.

  • :name_contains (String) —

    A filter to return only resources that contain the supplied filter text in the PBF name given.

  • :name_starts_with (String) —

    A filter to return only resources that start with the supplied filter text in the PBF name given.

  • :trigger (Array<String>) —

    A filter to return only resources that match the service trigger sources of a PBF.

  • :lifecycle_state (String) —

    A filter to return only resources their lifecycleState matches the given lifecycleState.

  • :limit (Integer) —

    The maximum number of items to return. 1 is the minimum, 50 is the maximum.

    Default: 10 (default to 5)

  • :page (String) —

    The pagination token for a list query returned by a previous operation

  • :sort_order (String) —

    Specifies sort order.

    • ASC: Ascending sort order.

    • DESC: Descending sort order. (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending. (default to timeCreated)

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
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
1027
 
# File 'lib/oci/functions/functions_management_client.rb', line 971

def list_pbf_listings(opts = {})
  logger.debug 'Calling operation FunctionsManagementClient#list_pbf_listings.' if logger


  if opts[:lifecycle_state] && !OCI::Functions::Models::PbfListing::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Functions::Models::PbfListing::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 name].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, name.'
  end

  path = '/pbfListings'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:pbfListingId] = opts[:pbf_listing_id] if opts[:pbf_listing_id]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:nameContains] = opts[:name_contains] if opts[:name_contains]
  query_params[:nameStartsWith] = opts[:name_starts_with] if opts[:name_starts_with]
  query_params[:trigger] = OCI::ApiClient.build_collection_params(opts[:trigger], :multi) if opts[:trigger] && !opts[:trigger].empty?
  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: 'FunctionsManagementClient#list_pbf_listings') 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::Functions::Models::PbfListingsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_triggers(opts = {}) ⇒ Response

Note:

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

Returns a list of Triggers.

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

  • :name (String) —

    A filter to return only resources that match the service trigger source of a PBF.

  • :limit (Integer) —

    The maximum number of items to return. 1 is the minimum, 50 is the maximum.

    Default: 10 (default to 5)

  • :page (String) —

    The pagination token for a list query returned by a previous operation

  • :sort_order (String) —

    Specifies sort order.

    • ASC: Ascending sort order.

    • DESC: Descending sort order. (default to ASC) Allowed values are: ASC, DESC

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



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
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
 
# File 'lib/oci/functions/functions_management_client.rb', line 1060

def list_triggers(opts = {})
  logger.debug 'Calling operation FunctionsManagementClient#list_triggers.' if logger


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

  path = '/pbfListings/triggers'
  operation_signing_strategy = :standard

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

  # 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: 'FunctionsManagementClient#list_triggers') 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::Functions::Models::TriggersCollection'
    )
  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.



94
95
96
 
# File 'lib/oci/functions/functions_management_client.rb', line 94

def logger
  @api_client.config.logger
end

#update_application(application_id, update_application_details, opts = {}) ⇒ Response

Note:

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

Modifies an application

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.

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
 
# File 'lib/oci/functions/functions_management_client.rb', line 1128

def update_application(application_id, update_application_details, opts = {})
  logger.debug 'Calling operation FunctionsManagementClient#update_application.' if logger

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

  path = '/applications/{applicationId}'.sub('{applicationId}', application_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[:'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_application_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'FunctionsManagementClient#update_application') 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::Functions::Models::Application'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_function(function_id, update_function_details, opts = {}) ⇒ Response

Note:

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

Modifies a function

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.

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
 
# File 'lib/oci/functions/functions_management_client.rb', line 1192

def update_function(function_id, update_function_details, opts = {})
  logger.debug 'Calling operation FunctionsManagementClient#update_function.' if logger

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

  path = '/functions/{functionId}'.sub('{functionId}', function_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[:'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_function_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'FunctionsManagementClient#update_function') 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::Functions::Models::Function'
    )
  end
  # rubocop:enable Metrics/BlockLength
end