Class: OCI::Rover::RoverNodeClient
- Inherits:
-
Object
- Object
- OCI::Rover::RoverNodeClient
- Defined in:
- lib/oci/rover/rover_node_client.rb
Overview
A description of the RoverCloudService API.
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 OCI::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_rover_node_compartment(rover_node_id, change_rover_node_compartment_details, opts = {}) ⇒ Response
Moves a rover node into a different compartment.
-
#create_rover_node(create_rover_node_details, opts = {}) ⇒ Response
Creates a new RoverNode.
-
#delete_rover_node(rover_node_id, opts = {}) ⇒ Response
Deletes a RoverNode resource by identifier.
-
#get_rover_node(rover_node_id, opts = {}) ⇒ Response
Gets a RoverNode by identifier.
-
#get_rover_node_certificate(rover_node_id, opts = {}) ⇒ Response
Get the certificate for a rover node.
-
#get_rover_node_encryption_key(rover_node_id, opts = {}) ⇒ Response
Get the data encryption key for a rover node.
-
#get_rover_node_get_rpt(rover_node_id, jwt, opts = {}) ⇒ Response
Get the resource principal token for a rover node.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ RoverNodeClient
constructor
Creates a new RoverNodeClient.
-
#list_rover_nodes(compartment_id, opts = {}) ⇒ Response
Returns a list of RoverNodes.
-
#logger ⇒ Logger
The logger for this client.
-
#rover_node_action_retrieve_ca_bundle(rover_node_id, opts = {}) ⇒ Response
Retrieve Ca Bundle for a rover node.
-
#rover_node_action_set_key(rover_node_id, jwt, rover_node_action_set_key_details, opts = {}) ⇒ Response
Get the resource principal public key for a rover node.
-
#rover_node_generate_certificate(rover_node_generate_certificate_details, rover_node_id, opts = {}) ⇒ Response
Request to generate certificate for a roverNode.
-
#rover_node_renew_certificate(rover_node_renew_certificate_details, rover_node_id, opts = {}) ⇒ Response
Request to renew certificate for a roverNode.
-
#rover_node_replace_certificate_authority(rover_node_replace_certificate_authority_details, rover_node_id, opts = {}) ⇒ Response
Request to replace certificate authority for a roverNode.
-
#rover_node_retrieve_leaf_certificate(rover_node_id, opts = {}) ⇒ Response
Retrieve the leaf certificate info for a rover node.
-
#update_rover_node(rover_node_id, update_rover_node_details, opts = {}) ⇒ Response
Updates the RoverNode.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ RoverNodeClient
Creates a new RoverNodeClient. 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.
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/rover/rover_node_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 + '/20201210' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "RoverNodeClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
15 16 17 |
# File 'lib/oci/rover/rover_node_client.rb', line 15 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
19 20 21 |
# File 'lib/oci/rover/rover_node_client.rb', line 19 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in OCI::Regions::REGION_ENUM.
29 30 31 |
# File 'lib/oci/rover/rover_node_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
25 26 27 |
# File 'lib/oci/rover/rover_node_client.rb', line 25 def retry_config @retry_config end |
Instance Method Details
#change_rover_node_compartment(rover_node_id, change_rover_node_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_rover_node_compartment API.
Moves a rover node into a different compartment.
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 159 160 161 162 163 |
# File 'lib/oci/rover/rover_node_client.rb', line 124 def change_rover_node_compartment(rover_node_id, change_rover_node_compartment_details, opts = {}) logger.debug 'Calling operation RoverNodeClient#change_rover_node_compartment.' if logger raise "Missing the required parameter 'rover_node_id' when calling change_rover_node_compartment." if rover_node_id.nil? raise "Missing the required parameter 'change_rover_node_compartment_details' when calling change_rover_node_compartment." if change_rover_node_compartment_details.nil? raise "Parameter value for 'rover_node_id' must not be blank" if OCI::Internal::Util.blank_string?(rover_node_id) path = '/roverNodes/{roverNodeId}/actions/changeCompartment'.sub('{roverNodeId}', rover_node_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] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_rover_node_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'RoverNodeClient#change_rover_node_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_rover_node(create_rover_node_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_rover_node API.
Creates a new RoverNode.
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 222 223 224 225 |
# File 'lib/oci/rover/rover_node_client.rb', line 188 def create_rover_node(create_rover_node_details, opts = {}) logger.debug 'Calling operation RoverNodeClient#create_rover_node.' if logger raise "Missing the required parameter 'create_rover_node_details' when calling create_rover_node." if create_rover_node_details.nil? path = '/roverNodes' 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_rover_node_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'RoverNodeClient#create_rover_node') 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::Rover::Models::RoverNode' ) end # rubocop:enable Metrics/BlockLength end |
#delete_rover_node(rover_node_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_rover_node API.
Deletes a RoverNode resource by identifier
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 |
# File 'lib/oci/rover/rover_node_client.rb', line 255 def delete_rover_node(rover_node_id, opts = {}) logger.debug 'Calling operation RoverNodeClient#delete_rover_node.' if logger raise "Missing the required parameter 'rover_node_id' when calling delete_rover_node." if rover_node_id.nil? raise "Parameter value for 'rover_node_id' must not be blank" if OCI::Internal::Util.blank_string?(rover_node_id) path = '/roverNodes/{roverNodeId}'.sub('{roverNodeId}', rover_node_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] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'RoverNodeClient#delete_rover_node') 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_rover_node(rover_node_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_rover_node API.
Gets a RoverNode by identifier.
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 |
# File 'lib/oci/rover/rover_node_client.rb', line 311 def get_rover_node(rover_node_id, opts = {}) logger.debug 'Calling operation RoverNodeClient#get_rover_node.' if logger raise "Missing the required parameter 'rover_node_id' when calling get_rover_node." if rover_node_id.nil? raise "Parameter value for 'rover_node_id' must not be blank" if OCI::Internal::Util.blank_string?(rover_node_id) path = '/roverNodes/{roverNodeId}'.sub('{roverNodeId}', rover_node_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: 'RoverNodeClient#get_rover_node') 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::Rover::Models::RoverNode' ) end # rubocop:enable Metrics/BlockLength end |
#get_rover_node_certificate(rover_node_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_rover_node_certificate API.
Get the certificate for a rover node
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 394 395 396 397 398 399 400 401 |
# File 'lib/oci/rover/rover_node_client.rb', line 365 def get_rover_node_certificate(rover_node_id, opts = {}) logger.debug 'Calling operation RoverNodeClient#get_rover_node_certificate.' if logger raise "Missing the required parameter 'rover_node_id' when calling get_rover_node_certificate." if rover_node_id.nil? raise "Parameter value for 'rover_node_id' must not be blank" if OCI::Internal::Util.blank_string?(rover_node_id) path = '/roverNodes/{roverNodeId}/certificate'.sub('{roverNodeId}', rover_node_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: 'RoverNodeClient#get_rover_node_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::Rover::Models::RoverNodeCertificate' ) end # rubocop:enable Metrics/BlockLength end |
#get_rover_node_encryption_key(rover_node_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_rover_node_encryption_key API.
Get the data encryption key for a rover node.
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 450 451 452 453 454 455 |
# File 'lib/oci/rover/rover_node_client.rb', line 419 def get_rover_node_encryption_key(rover_node_id, opts = {}) logger.debug 'Calling operation RoverNodeClient#get_rover_node_encryption_key.' if logger raise "Missing the required parameter 'rover_node_id' when calling get_rover_node_encryption_key." if rover_node_id.nil? raise "Parameter value for 'rover_node_id' must not be blank" if OCI::Internal::Util.blank_string?(rover_node_id) path = '/roverNodes/{roverNodeId}/encryptionKey'.sub('{roverNodeId}', rover_node_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: 'RoverNodeClient#get_rover_node_encryption_key') 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::Rover::Models::RoverNodeEncryptionKey' ) end # rubocop:enable Metrics/BlockLength end |
#get_rover_node_get_rpt(rover_node_id, jwt, opts = {}) ⇒ Response
Click here to see an example of how to use get_rover_node_get_rpt API.
Get the resource principal token for a rover node
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 506 507 508 509 510 511 512 513 514 |
# File 'lib/oci/rover/rover_node_client.rb', line 476 def get_rover_node_get_rpt(rover_node_id, jwt, opts = {}) logger.debug 'Calling operation RoverNodeClient#get_rover_node_get_rpt.' if logger raise "Missing the required parameter 'rover_node_id' when calling get_rover_node_get_rpt." if rover_node_id.nil? raise "Missing the required parameter 'jwt' when calling get_rover_node_get_rpt." if jwt.nil? raise "Parameter value for 'rover_node_id' must not be blank" if OCI::Internal::Util.blank_string?(rover_node_id) path = '/roverNodes/{roverNodeId}/getRpt'.sub('{roverNodeId}', rover_node_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[:jwt] = jwt 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: 'RoverNodeClient#get_rover_node_get_rpt') 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::Rover::Models::RoverNodeGetRpt' ) end # rubocop:enable Metrics/BlockLength end |
#list_rover_nodes(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_rover_nodes API.
Returns a list of RoverNodes.
Allowed values are: timeCreated, displayName
543 544 545 546 547 548 549 550 551 552 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 |
# File 'lib/oci/rover/rover_node_client.rb', line 543 def list_rover_nodes(compartment_id, opts = {}) logger.debug 'Calling operation RoverNodeClient#list_rover_nodes.' if logger raise "Missing the required parameter 'compartment_id' when calling list_rover_nodes." if compartment_id.nil? if opts[:node_type] && !OCI::Rover::Models::NODE_TYPE_ENUM.include?(opts[:node_type]) raise 'Invalid value for "node_type", must be one of the values in OCI::Rover::Models::NODE_TYPE_ENUM.' end if opts[:lifecycle_state] && !OCI::Rover::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Rover::Models::LIFECYCLE_STATE_ENUM.' end if opts[:sort_order] && !OCI::Rover::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::Rover::Models::SORT_ORDERS_ENUM.' 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 = '/roverNodes' 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[:nodeType] = opts[:node_type] if opts[:node_type] query_params[:shape] = opts[:shape] if opts[:shape] 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[: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: 'RoverNodeClient#list_rover_nodes') 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::Rover::Models::RoverNodeCollection' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
94 95 96 |
# File 'lib/oci/rover/rover_node_client.rb', line 94 def logger @api_client.config.logger end |
#rover_node_action_retrieve_ca_bundle(rover_node_id, opts = {}) ⇒ Response
Click here to see an example of how to use rover_node_action_retrieve_ca_bundle API.
Retrieve Ca Bundle for a rover node
633 634 635 636 637 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 |
# File 'lib/oci/rover/rover_node_client.rb', line 633 def rover_node_action_retrieve_ca_bundle(rover_node_id, opts = {}) logger.debug 'Calling operation RoverNodeClient#rover_node_action_retrieve_ca_bundle.' if logger raise "Missing the required parameter 'rover_node_id' when calling rover_node_action_retrieve_ca_bundle." if rover_node_id.nil? raise "Parameter value for 'rover_node_id' must not be blank" if OCI::Internal::Util.blank_string?(rover_node_id) path = '/roverNodes/{roverNodeId}/actions/retrieveCaBundle'.sub('{roverNodeId}', rover_node_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] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'RoverNodeClient#rover_node_action_retrieve_ca_bundle') 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::Rover::Models::CaBundleResponse' ) end # rubocop:enable Metrics/BlockLength end |
#rover_node_action_set_key(rover_node_id, jwt, rover_node_action_set_key_details, opts = {}) ⇒ Response
Click here to see an example of how to use rover_node_action_set_key API.
Get the resource principal public key for a rover node
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 738 739 740 741 742 743 744 745 746 747 748 |
# File 'lib/oci/rover/rover_node_client.rb', line 706 def rover_node_action_set_key(rover_node_id, jwt, rover_node_action_set_key_details, opts = {}) logger.debug 'Calling operation RoverNodeClient#rover_node_action_set_key.' if logger raise "Missing the required parameter 'rover_node_id' when calling rover_node_action_set_key." if rover_node_id.nil? raise "Missing the required parameter 'jwt' when calling rover_node_action_set_key." if jwt.nil? raise "Missing the required parameter 'rover_node_action_set_key_details' when calling rover_node_action_set_key." if rover_node_action_set_key_details.nil? raise "Parameter value for 'rover_node_id' must not be blank" if OCI::Internal::Util.blank_string?(rover_node_id) path = '/roverNodes/{roverNodeId}/actions/setKey'.sub('{roverNodeId}', rover_node_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[:jwt] = jwt 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] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(rover_node_action_set_key_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'RoverNodeClient#rover_node_action_set_key') 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::Rover::Models::RoverNodeSetKey' ) end # rubocop:enable Metrics/BlockLength end |
#rover_node_generate_certificate(rover_node_generate_certificate_details, rover_node_id, opts = {}) ⇒ Response
Click here to see an example of how to use rover_node_generate_certificate API.
Request to generate certificate for a roverNode.
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 |
# File 'lib/oci/rover/rover_node_client.rb', line 780 def rover_node_generate_certificate(rover_node_generate_certificate_details, rover_node_id, opts = {}) logger.debug 'Calling operation RoverNodeClient#rover_node_generate_certificate.' if logger raise "Missing the required parameter 'rover_node_generate_certificate_details' when calling rover_node_generate_certificate." if rover_node_generate_certificate_details.nil? raise "Missing the required parameter 'rover_node_id' when calling rover_node_generate_certificate." if rover_node_id.nil? raise "Parameter value for 'rover_node_id' must not be blank" if OCI::Internal::Util.blank_string?(rover_node_id) path = '/roverNodes/{roverNodeId}/actions/generateCertificate'.sub('{roverNodeId}', rover_node_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] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(rover_node_generate_certificate_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'RoverNodeClient#rover_node_generate_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::Rover::Models::GenerateCertificateResponse' ) end # rubocop:enable Metrics/BlockLength end |
#rover_node_renew_certificate(rover_node_renew_certificate_details, rover_node_id, opts = {}) ⇒ Response
Click here to see an example of how to use rover_node_renew_certificate API.
Request to renew certificate for a roverNode.
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 |
# File 'lib/oci/rover/rover_node_client.rb', line 852 def rover_node_renew_certificate(rover_node_renew_certificate_details, rover_node_id, opts = {}) logger.debug 'Calling operation RoverNodeClient#rover_node_renew_certificate.' if logger raise "Missing the required parameter 'rover_node_renew_certificate_details' when calling rover_node_renew_certificate." if rover_node_renew_certificate_details.nil? raise "Missing the required parameter 'rover_node_id' when calling rover_node_renew_certificate." if rover_node_id.nil? raise "Parameter value for 'rover_node_id' must not be blank" if OCI::Internal::Util.blank_string?(rover_node_id) path = '/roverNodes/{roverNodeId}/actions/renewCertificate'.sub('{roverNodeId}', rover_node_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] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(rover_node_renew_certificate_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'RoverNodeClient#rover_node_renew_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::Rover::Models::RenewCertificateResponse' ) end # rubocop:enable Metrics/BlockLength end |
#rover_node_replace_certificate_authority(rover_node_replace_certificate_authority_details, rover_node_id, opts = {}) ⇒ Response
Click here to see an example of how to use rover_node_replace_certificate_authority API.
Request to replace certificate authority for a roverNode.
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 |
# File 'lib/oci/rover/rover_node_client.rb', line 924 def (, rover_node_id, opts = {}) logger.debug 'Calling operation RoverNodeClient#rover_node_replace_certificate_authority.' if logger raise "Missing the required parameter 'rover_node_replace_certificate_authority_details' when calling rover_node_replace_certificate_authority." if .nil? raise "Missing the required parameter 'rover_node_id' when calling rover_node_replace_certificate_authority." if rover_node_id.nil? raise "Parameter value for 'rover_node_id' must not be blank" if OCI::Internal::Util.blank_string?(rover_node_id) path = '/roverNodes/{roverNodeId}/actions/replaceCertificateAuthority'.sub('{roverNodeId}', rover_node_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] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body() # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'RoverNodeClient#rover_node_replace_certificate_authority') 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::Rover::Models::ReplaceCertificateAuthorityResponse' ) end # rubocop:enable Metrics/BlockLength end |
#rover_node_retrieve_leaf_certificate(rover_node_id, opts = {}) ⇒ Response
Click here to see an example of how to use rover_node_retrieve_leaf_certificate API.
Retrieve the leaf certificate info for a rover node
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 1028 1029 1030 1031 1032 1033 |
# File 'lib/oci/rover/rover_node_client.rb', line 994 def rover_node_retrieve_leaf_certificate(rover_node_id, opts = {}) logger.debug 'Calling operation RoverNodeClient#rover_node_retrieve_leaf_certificate.' if logger raise "Missing the required parameter 'rover_node_id' when calling rover_node_retrieve_leaf_certificate." if rover_node_id.nil? raise "Parameter value for 'rover_node_id' must not be blank" if OCI::Internal::Util.blank_string?(rover_node_id) path = '/roverNodes/{roverNodeId}/actions/retrieveLeafCertificate'.sub('{roverNodeId}', rover_node_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] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'RoverNodeClient#rover_node_retrieve_leaf_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::Rover::Models::LeafCertificateResponse' ) end # rubocop:enable Metrics/BlockLength end |
#update_rover_node(rover_node_id, update_rover_node_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_rover_node API.
Updates the RoverNode
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 1088 1089 1090 1091 1092 1093 1094 1095 1096 |
# File 'lib/oci/rover/rover_node_client.rb', line 1058 def update_rover_node(rover_node_id, update_rover_node_details, opts = {}) logger.debug 'Calling operation RoverNodeClient#update_rover_node.' if logger raise "Missing the required parameter 'rover_node_id' when calling update_rover_node." if rover_node_id.nil? raise "Missing the required parameter 'update_rover_node_details' when calling update_rover_node." if update_rover_node_details.nil? raise "Parameter value for 'rover_node_id' must not be blank" if OCI::Internal::Util.blank_string?(rover_node_id) path = '/roverNodes/{roverNodeId}'.sub('{roverNodeId}', rover_node_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_rover_node_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'RoverNodeClient#update_rover_node') 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::Rover::Models::RoverNode' ) end # rubocop:enable Metrics/BlockLength end |