Class: OCI::Functions::FunctionsManagementClient
- Inherits:
-
Object
- Object
- OCI::Functions::FunctionsManagementClient
- Defined in:
- lib/oci/functions/functions_management_client.rb
Overview
API for the Functions service.
Instance Attribute Summary collapse
-
#api_client ⇒ OCI::ApiClient
readonly
Client used to make HTTP requests.
-
#endpoint ⇒ String
readonly
Fully qualified endpoint URL.
-
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
-
#retry_config ⇒ OCI::Retry::RetryConfig
readonly
The default retry configuration to apply to all operations in this service client.
Instance Method Summary collapse
-
#change_application_compartment(application_id, change_application_compartment_details, opts = {}) ⇒ Response
Moves an application into a different compartment within the same tenancy.
-
#create_application(create_application_details, opts = {}) ⇒ Response
Creates a new application.
-
#create_function(create_function_details, opts = {}) ⇒ Response
Creates a new function.
-
#delete_application(application_id, opts = {}) ⇒ Response
Deletes an application.
-
#delete_function(function_id, opts = {}) ⇒ Response
Deletes a function.
-
#get_application(application_id, opts = {}) ⇒ Response
Retrieves an application.
-
#get_function(function_id, opts = {}) ⇒ Response
Retrieves a function.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ FunctionsManagementClient
constructor
Creates a new FunctionsManagementClient.
-
#list_applications(compartment_id, opts = {}) ⇒ Response
Lists applications for a compartment.
-
#list_functions(application_id, opts = {}) ⇒ Response
Lists functions for an application.
-
#logger ⇒ Logger
The logger for this client.
-
#update_application(application_id, update_application_details, opts = {}) ⇒ Response
Modifies an application.
-
#update_function(function_id, update_function_details, opts = {}) ⇒ Response
Modifies a function.
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.
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 |
# File 'lib/oci/functions/functions_management_client.rb', line 52 def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) # If the signer is an InstancePrincipalsSecurityTokenSigner and no config was supplied (which is valid for instance principals) # 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 unless signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner) config ||= OCI::Config.new if signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner) config.validate unless signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner) if signer.nil? signer = OCI::Signer.new( config.user, config.fingerprint, config.tenancy, config.key_file, pass_phrase: config.pass_phrase, private_key_content: config.key_content ) end @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.
12 13 14 |
# File 'lib/oci/functions/functions_management_client.rb', line 12 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
16 17 18 |
# File 'lib/oci/functions/functions_management_client.rb', line 16 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
26 27 28 |
# File 'lib/oci/functions/functions_management_client.rb', line 26 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
22 23 24 |
# File 'lib/oci/functions/functions_management_client.rb', line 22 def retry_config @retry_config end |
Instance Method Details
#change_application_compartment(application_id, change_application_compartment_details, opts = {}) ⇒ Response
Moves an application into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources Between Compartments](docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
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 159 160 161 162 163 164 165 |
# File 'lib/oci/functions/functions_management_client.rb', line 128 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.(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
Creates a new application.
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 |
# File 'lib/oci/functions/functions_management_client.rb', line 184 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.(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
Creates a new function.
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 269 270 271 272 273 |
# File 'lib/oci/functions/functions_management_client.rb', line 238 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.(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
Deletes an application.
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 |
# File 'lib/oci/functions/functions_management_client.rb', line 297 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.(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
Deletes a function.
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 391 392 393 |
# File 'lib/oci/functions/functions_management_client.rb', line 357 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.(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
Retrieves an application.
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 448 449 |
# File 'lib/oci/functions/functions_management_client.rb', line 413 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.(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
Retrieves a function.
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 505 |
# File 'lib/oci/functions/functions_management_client.rb', line 469 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.(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 |
#list_applications(compartment_id, opts = {}) ⇒ Response
Lists applications for a compartment.
553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 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 |
# File 'lib/oci/functions/functions_management_client.rb', line 553 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.(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
Lists functions for an application.
656 657 658 659 660 661 662 663 664 665 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 |
# File 'lib/oci/functions/functions_management_client.rb', line 656 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.(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 |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
102 103 104 |
# File 'lib/oci/functions/functions_management_client.rb', line 102 def logger @api_client.config.logger end |
#update_application(application_id, update_application_details, opts = {}) ⇒ Response
Modifies an application
736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 |
# File 'lib/oci/functions/functions_management_client.rb', line 736 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.(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
Modifies a function
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 826 827 828 829 830 831 832 833 834 835 836 837 |
# File 'lib/oci/functions/functions_management_client.rb', line 799 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.(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 |