Class: OCI::OsManagementHub::LifecycleEnvironmentClient
- Inherits:
-
Object
- Object
- OCI::OsManagementHub::LifecycleEnvironmentClient
- Defined in:
- lib/oci/os_management_hub/lifecycle_environment_client.rb
Overview
Use the OS Management Hub API to manage and monitor updates and patches for instances in OCI, your private data center, or 3rd-party clouds. For more information, see Overview of OS Management Hub.
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
-
#attach_managed_instances_to_lifecycle_stage(lifecycle_stage_id, attach_managed_instances_to_lifecycle_stage_details, opts = {}) ⇒ Response
Attaches (adds) managed instances to a lifecycle stage.
-
#change_lifecycle_environment_compartment(lifecycle_environment_id, change_lifecycle_environment_compartment_details, opts = {}) ⇒ Response
Moves a lifecycle environment into a different compartment within the same tenancy.
-
#create_lifecycle_environment(create_lifecycle_environment_details, opts = {}) ⇒ Response
Creates a lifecycle environment.
-
#delete_lifecycle_environment(lifecycle_environment_id, opts = {}) ⇒ Response
Deletes the specified lifecycle environment.
-
#detach_managed_instances_from_lifecycle_stage(lifecycle_stage_id, detach_managed_instances_from_lifecycle_stage_details, opts = {}) ⇒ Response
Detaches (removes) a managed instance from a lifecycle stage.
-
#get_lifecycle_environment(lifecycle_environment_id, opts = {}) ⇒ Response
Gets information about the specified lifecycle environment.
-
#get_lifecycle_stage(lifecycle_stage_id, opts = {}) ⇒ Response
Returns information about the specified lifecycle stage.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ LifecycleEnvironmentClient
constructor
Creates a new LifecycleEnvironmentClient.
-
#list_lifecycle_environments(opts = {}) ⇒ Response
Lists lifecycle environments that match the specified compartment or lifecycle environment OCID.
-
#list_lifecycle_stage_installed_packages(lifecycle_stage_id, opts = {}) ⇒ Response
Lists installed packages on managed instances in a specified lifecycle stage.
-
#list_lifecycle_stages(opts = {}) ⇒ Response
Lists lifecycle stages that match the specified compartment or lifecycle stage OCID.
-
#logger ⇒ Logger
The logger for this client.
-
#promote_software_source_to_lifecycle_stage(lifecycle_stage_id, promote_software_source_to_lifecycle_stage_details, opts = {}) ⇒ Response
Updates the versioned custom software source content to the specified lifecycle stage.
-
#update_lifecycle_environment(lifecycle_environment_id, update_lifecycle_environment_details, opts = {}) ⇒ Response
Updates the specified lifecycle environment's name, description, stages, or tags.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ LifecycleEnvironmentClient
Creates a new LifecycleEnvironmentClient. 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.
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 |
# File 'lib/oci/os_management_hub/lifecycle_environment_client.rb', line 56 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 + '/20220901' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "LifecycleEnvironmentClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
16 17 18 |
# File 'lib/oci/os_management_hub/lifecycle_environment_client.rb', line 16 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
20 21 22 |
# File 'lib/oci/os_management_hub/lifecycle_environment_client.rb', line 20 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
30 31 32 |
# File 'lib/oci/os_management_hub/lifecycle_environment_client.rb', line 30 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
26 27 28 |
# File 'lib/oci/os_management_hub/lifecycle_environment_client.rb', line 26 def retry_config @retry_config end |
Instance Method Details
#attach_managed_instances_to_lifecycle_stage(lifecycle_stage_id, attach_managed_instances_to_lifecycle_stage_details, opts = {}) ⇒ Response
Click here to see an example of how to use attach_managed_instances_to_lifecycle_stage API.
Attaches (adds) managed instances to a lifecycle stage. Once added, you can apply operations to all managed instances in the lifecycle stage.
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 164 165 |
# File 'lib/oci/os_management_hub/lifecycle_environment_client.rb', line 126 def attach_managed_instances_to_lifecycle_stage(lifecycle_stage_id, attach_managed_instances_to_lifecycle_stage_details, opts = {}) logger.debug 'Calling operation LifecycleEnvironmentClient#attach_managed_instances_to_lifecycle_stage.' if logger raise "Missing the required parameter 'lifecycle_stage_id' when calling attach_managed_instances_to_lifecycle_stage." if lifecycle_stage_id.nil? raise "Missing the required parameter 'attach_managed_instances_to_lifecycle_stage_details' when calling attach_managed_instances_to_lifecycle_stage." if attach_managed_instances_to_lifecycle_stage_details.nil? raise "Parameter value for 'lifecycle_stage_id' must not be blank" if OCI::Internal::Util.blank_string?(lifecycle_stage_id) path = '/lifecycleStages/{lifecycleStageId}/actions/attachManagedInstances'.sub('{lifecycleStageId}', lifecycle_stage_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[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(attach_managed_instances_to_lifecycle_stage_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'LifecycleEnvironmentClient#attach_managed_instances_to_lifecycle_stage') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#change_lifecycle_environment_compartment(lifecycle_environment_id, change_lifecycle_environment_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_lifecycle_environment_compartment API.
Moves a lifecycle environment into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 |
# File 'lib/oci/os_management_hub/lifecycle_environment_client.rb', line 197 def change_lifecycle_environment_compartment(lifecycle_environment_id, change_lifecycle_environment_compartment_details, opts = {}) logger.debug 'Calling operation LifecycleEnvironmentClient#change_lifecycle_environment_compartment.' if logger raise "Missing the required parameter 'lifecycle_environment_id' when calling change_lifecycle_environment_compartment." if lifecycle_environment_id.nil? raise "Missing the required parameter 'change_lifecycle_environment_compartment_details' when calling change_lifecycle_environment_compartment." if change_lifecycle_environment_compartment_details.nil? raise "Parameter value for 'lifecycle_environment_id' must not be blank" if OCI::Internal::Util.blank_string?(lifecycle_environment_id) path = '/lifecycleEnvironments/{lifecycleEnvironmentId}/actions/changeCompartment'.sub('{lifecycleEnvironmentId}', lifecycle_environment_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(change_lifecycle_environment_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'LifecycleEnvironmentClient#change_lifecycle_environment_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_lifecycle_environment(create_lifecycle_environment_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_lifecycle_environment API.
Creates a lifecycle environment. A lifecycle environment is a user-defined pipeline to deliver curated, versioned content in a prescribed, methodical manner.
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 294 295 296 297 298 |
# File 'lib/oci/os_management_hub/lifecycle_environment_client.rb', line 261 def create_lifecycle_environment(create_lifecycle_environment_details, opts = {}) logger.debug 'Calling operation LifecycleEnvironmentClient#create_lifecycle_environment.' if logger raise "Missing the required parameter 'create_lifecycle_environment_details' when calling create_lifecycle_environment." if create_lifecycle_environment_details.nil? path = '/lifecycleEnvironments' 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_lifecycle_environment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'LifecycleEnvironmentClient#create_lifecycle_environment') 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::OsManagementHub::Models::LifecycleEnvironment' ) end # rubocop:enable Metrics/BlockLength end |
#delete_lifecycle_environment(lifecycle_environment_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_lifecycle_environment API.
Deletes the specified lifecycle environment.
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 |
# File 'lib/oci/os_management_hub/lifecycle_environment_client.rb', line 323 def delete_lifecycle_environment(lifecycle_environment_id, opts = {}) logger.debug 'Calling operation LifecycleEnvironmentClient#delete_lifecycle_environment.' if logger raise "Missing the required parameter 'lifecycle_environment_id' when calling delete_lifecycle_environment." if lifecycle_environment_id.nil? raise "Parameter value for 'lifecycle_environment_id' must not be blank" if OCI::Internal::Util.blank_string?(lifecycle_environment_id) path = '/lifecycleEnvironments/{lifecycleEnvironmentId}'.sub('{lifecycleEnvironmentId}', lifecycle_environment_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: 'LifecycleEnvironmentClient#delete_lifecycle_environment') 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 |
#detach_managed_instances_from_lifecycle_stage(lifecycle_stage_id, detach_managed_instances_from_lifecycle_stage_details, opts = {}) ⇒ Response
Click here to see an example of how to use detach_managed_instances_from_lifecycle_stage API.
Detaches (removes) a managed instance from a lifecycle stage.
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 |
# File 'lib/oci/os_management_hub/lifecycle_environment_client.rb', line 391 def detach_managed_instances_from_lifecycle_stage(lifecycle_stage_id, detach_managed_instances_from_lifecycle_stage_details, opts = {}) logger.debug 'Calling operation LifecycleEnvironmentClient#detach_managed_instances_from_lifecycle_stage.' if logger raise "Missing the required parameter 'lifecycle_stage_id' when calling detach_managed_instances_from_lifecycle_stage." if lifecycle_stage_id.nil? raise "Missing the required parameter 'detach_managed_instances_from_lifecycle_stage_details' when calling detach_managed_instances_from_lifecycle_stage." if detach_managed_instances_from_lifecycle_stage_details.nil? raise "Parameter value for 'lifecycle_stage_id' must not be blank" if OCI::Internal::Util.blank_string?(lifecycle_stage_id) path = '/lifecycleStages/{lifecycleStageId}/actions/detachManagedInstances'.sub('{lifecycleStageId}', lifecycle_stage_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[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(detach_managed_instances_from_lifecycle_stage_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'LifecycleEnvironmentClient#detach_managed_instances_from_lifecycle_stage') 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 |
#get_lifecycle_environment(lifecycle_environment_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_lifecycle_environment API.
Gets information about the specified lifecycle environment.
448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 |
# File 'lib/oci/os_management_hub/lifecycle_environment_client.rb', line 448 def get_lifecycle_environment(lifecycle_environment_id, opts = {}) logger.debug 'Calling operation LifecycleEnvironmentClient#get_lifecycle_environment.' if logger raise "Missing the required parameter 'lifecycle_environment_id' when calling get_lifecycle_environment." if lifecycle_environment_id.nil? raise "Parameter value for 'lifecycle_environment_id' must not be blank" if OCI::Internal::Util.blank_string?(lifecycle_environment_id) path = '/lifecycleEnvironments/{lifecycleEnvironmentId}'.sub('{lifecycleEnvironmentId}', lifecycle_environment_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: 'LifecycleEnvironmentClient#get_lifecycle_environment') 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::OsManagementHub::Models::LifecycleEnvironment' ) end # rubocop:enable Metrics/BlockLength end |
#get_lifecycle_stage(lifecycle_stage_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_lifecycle_stage API.
Returns information about the specified lifecycle stage.
503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 |
# File 'lib/oci/os_management_hub/lifecycle_environment_client.rb', line 503 def get_lifecycle_stage(lifecycle_stage_id, opts = {}) logger.debug 'Calling operation LifecycleEnvironmentClient#get_lifecycle_stage.' if logger raise "Missing the required parameter 'lifecycle_stage_id' when calling get_lifecycle_stage." if lifecycle_stage_id.nil? raise "Parameter value for 'lifecycle_stage_id' must not be blank" if OCI::Internal::Util.blank_string?(lifecycle_stage_id) path = '/lifecycleStages/{lifecycleStageId}'.sub('{lifecycleStageId}', lifecycle_stage_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: 'LifecycleEnvironmentClient#get_lifecycle_stage') 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::OsManagementHub::Models::LifecycleStage' ) end # rubocop:enable Metrics/BlockLength end |
#list_lifecycle_environments(opts = {}) ⇒ Response
Click here to see an example of how to use list_lifecycle_environments API.
Lists lifecycle environments that match the specified compartment or lifecycle environment OCID. Filter the list against a variety of criteria including but not limited to its name, status, architecture, and OS family.
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 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 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 |
# File 'lib/oci/os_management_hub/lifecycle_environment_client.rb', line 584 def list_lifecycle_environments(opts = {}) logger.debug 'Calling operation LifecycleEnvironmentClient#list_lifecycle_environments.' if logger if opts[:arch_type] && !OCI::OsManagementHub::Models::ARCH_TYPE_ENUM.include?(opts[:arch_type]) raise 'Invalid value for "arch_type", must be one of the values in OCI::OsManagementHub::Models::ARCH_TYPE_ENUM.' end if opts[:os_family] && !OCI::OsManagementHub::Models::OS_FAMILY_ENUM.include?(opts[:os_family]) raise 'Invalid value for "os_family", must be one of the values in OCI::OsManagementHub::Models::OS_FAMILY_ENUM.' end location_allowable_values = %w[ON_PREMISE OCI_COMPUTE AZURE EC2 GCP] if opts[:location] && !opts[:location].empty? opts[:location].each do |val_to_check| unless location_allowable_values.include?(val_to_check) raise 'Invalid value for "location", must be one of ON_PREMISE, OCI_COMPUTE, AZURE, EC2, GCP.' end end end location_not_equal_to_allowable_values = %w[ON_PREMISE OCI_COMPUTE AZURE EC2 GCP] if opts[:location_not_equal_to] && !opts[:location_not_equal_to].empty? opts[:location_not_equal_to].each do |val_to_check| unless location_not_equal_to_allowable_values.include?(val_to_check) raise 'Invalid value for "location_not_equal_to", must be one of ON_PREMISE, OCI_COMPUTE, AZURE, EC2, GCP.' end end end if opts[:lifecycle_state] && !OCI::OsManagementHub::Models::LifecycleEnvironment::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::OsManagementHub::Models::LifecycleEnvironment::LIFECYCLE_STATE_ENUM.' end if opts[:sort_order] && !OCI::OsManagementHub::Models::SORT_ORDER_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::OsManagementHub::Models::SORT_ORDER_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 = '/lifecycleEnvironments' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id] query_params[:displayName] = OCI::ApiClient.build_collection_params(opts[:display_name], :multi) if opts[:display_name] && !opts[:display_name].empty? query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains] query_params[:lifecycleEnvironmentId] = opts[:lifecycle_environment_id] if opts[:lifecycle_environment_id] query_params[:archType] = opts[:arch_type] if opts[:arch_type] query_params[:osFamily] = opts[:os_family] if opts[:os_family] query_params[:location] = OCI::ApiClient.build_collection_params(opts[:location], :multi) if opts[:location] && !opts[:location].empty? query_params[:locationNotEqualTo] = OCI::ApiClient.build_collection_params(opts[:location_not_equal_to], :multi) if opts[:location_not_equal_to] && !opts[:location_not_equal_to].empty? 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: 'LifecycleEnvironmentClient#list_lifecycle_environments') 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::OsManagementHub::Models::LifecycleEnvironmentCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_lifecycle_stage_installed_packages(lifecycle_stage_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_lifecycle_stage_installed_packages API.
Lists installed packages on managed instances in a specified lifecycle stage. Filter the list against a variety of criteria including but not limited to the package name.
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 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 |
# File 'lib/oci/os_management_hub/lifecycle_environment_client.rb', line 710 def list_lifecycle_stage_installed_packages(lifecycle_stage_id, opts = {}) logger.debug 'Calling operation LifecycleEnvironmentClient#list_lifecycle_stage_installed_packages.' if logger raise "Missing the required parameter 'lifecycle_stage_id' when calling list_lifecycle_stage_installed_packages." if lifecycle_stage_id.nil? if opts[:lifecycle_state] && !OCI::OsManagementHub::Models::LifecycleStage::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::OsManagementHub::Models::LifecycleStage::LIFECYCLE_STATE_ENUM.' end if opts[:sort_order] && !OCI::OsManagementHub::Models::SORT_ORDER_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::OsManagementHub::Models::SORT_ORDER_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 raise "Parameter value for 'lifecycle_stage_id' must not be blank" if OCI::Internal::Util.blank_string?(lifecycle_stage_id) path = '/lifecycleStages/{lifecycleStageId}/installedPackages'.sub('{lifecycleStageId}', lifecycle_stage_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id] query_params[:displayName] = OCI::ApiClient.build_collection_params(opts[:display_name], :multi) if opts[:display_name] && !opts[:display_name].empty? query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains] 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: 'LifecycleEnvironmentClient#list_lifecycle_stage_installed_packages') 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::OsManagementHub::Models::InstalledPackageCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_lifecycle_stages(opts = {}) ⇒ Response
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 838 839 840 841 842 843 844 845 846 847 848 849 850 851 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 893 894 895 896 897 898 899 |
# File 'lib/oci/os_management_hub/lifecycle_environment_client.rb', line 811 def list_lifecycle_stages(opts = {}) logger.debug 'Calling operation LifecycleEnvironmentClient#list_lifecycle_stages.' if logger if opts[:arch_type] && !OCI::OsManagementHub::Models::ARCH_TYPE_ENUM.include?(opts[:arch_type]) raise 'Invalid value for "arch_type", must be one of the values in OCI::OsManagementHub::Models::ARCH_TYPE_ENUM.' end if opts[:os_family] && !OCI::OsManagementHub::Models::OS_FAMILY_ENUM.include?(opts[:os_family]) raise 'Invalid value for "os_family", must be one of the values in OCI::OsManagementHub::Models::OS_FAMILY_ENUM.' end location_allowable_values = %w[ON_PREMISE OCI_COMPUTE AZURE EC2 GCP] if opts[:location] && !opts[:location].empty? opts[:location].each do |val_to_check| unless location_allowable_values.include?(val_to_check) raise 'Invalid value for "location", must be one of ON_PREMISE, OCI_COMPUTE, AZURE, EC2, GCP.' end end end location_not_equal_to_allowable_values = %w[ON_PREMISE OCI_COMPUTE AZURE EC2 GCP] if opts[:location_not_equal_to] && !opts[:location_not_equal_to].empty? opts[:location_not_equal_to].each do |val_to_check| unless location_not_equal_to_allowable_values.include?(val_to_check) raise 'Invalid value for "location_not_equal_to", must be one of ON_PREMISE, OCI_COMPUTE, AZURE, EC2, GCP.' end end end if opts[:lifecycle_state] && !OCI::OsManagementHub::Models::LifecycleStage::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::OsManagementHub::Models::LifecycleStage::LIFECYCLE_STATE_ENUM.' end if opts[:sort_order] && !OCI::OsManagementHub::Models::SORT_ORDER_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::OsManagementHub::Models::SORT_ORDER_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 = '/lifecycleStages' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id] query_params[:displayName] = OCI::ApiClient.build_collection_params(opts[:display_name], :multi) if opts[:display_name] && !opts[:display_name].empty? query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains] query_params[:lifecycleStageId] = opts[:lifecycle_stage_id] if opts[:lifecycle_stage_id] query_params[:softwareSourceId] = opts[:software_source_id] if opts[:software_source_id] query_params[:archType] = opts[:arch_type] if opts[:arch_type] query_params[:osFamily] = opts[:os_family] if opts[:os_family] query_params[:location] = OCI::ApiClient.build_collection_params(opts[:location], :multi) if opts[:location] && !opts[:location].empty? query_params[:locationNotEqualTo] = OCI::ApiClient.build_collection_params(opts[:location_not_equal_to], :multi) if opts[:location_not_equal_to] && !opts[:location_not_equal_to].empty? 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: 'LifecycleEnvironmentClient#list_lifecycle_stages') 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::OsManagementHub::Models::LifecycleStageCollection' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
95 96 97 |
# File 'lib/oci/os_management_hub/lifecycle_environment_client.rb', line 95 def logger @api_client.config.logger end |
#promote_software_source_to_lifecycle_stage(lifecycle_stage_id, promote_software_source_to_lifecycle_stage_details, opts = {}) ⇒ Response
Click here to see an example of how to use promote_software_source_to_lifecycle_stage API.
Updates the versioned custom software source content to the specified lifecycle stage. A versioned custom software source OCID (softwareSourceId) is required when promoting content to the first lifecycle stage. You must promote content to the first stage before promoting to subsequent stages, otherwise the service returns an error. The softwareSourceId is optional when promoting content to the second, third, forth, or fifth stages. If you provide a softwareSourceId, the service validates that it matches the softwareSourceId of the previous stage. If it does not match, the service returns an error. If you don't provide a softwareSourceId, the service promotes the versioned software source from the previous lifecycle stage. If the previous lifecycle stage has no software source, the service returns an error.
934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 |
# File 'lib/oci/os_management_hub/lifecycle_environment_client.rb', line 934 def promote_software_source_to_lifecycle_stage(lifecycle_stage_id, promote_software_source_to_lifecycle_stage_details, opts = {}) logger.debug 'Calling operation LifecycleEnvironmentClient#promote_software_source_to_lifecycle_stage.' if logger raise "Missing the required parameter 'lifecycle_stage_id' when calling promote_software_source_to_lifecycle_stage." if lifecycle_stage_id.nil? raise "Missing the required parameter 'promote_software_source_to_lifecycle_stage_details' when calling promote_software_source_to_lifecycle_stage." if promote_software_source_to_lifecycle_stage_details.nil? raise "Parameter value for 'lifecycle_stage_id' must not be blank" if OCI::Internal::Util.blank_string?(lifecycle_stage_id) path = '/lifecycleStages/{lifecycleStageId}/actions/promoteSoftwareSource'.sub('{lifecycleStageId}', lifecycle_stage_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:softwareSourceId] = opts[:software_source_id] if opts[:software_source_id] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(promote_software_source_to_lifecycle_stage_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'LifecycleEnvironmentClient#promote_software_source_to_lifecycle_stage') 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 |
#update_lifecycle_environment(lifecycle_environment_id, update_lifecycle_environment_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_lifecycle_environment API.
Updates the specified lifecycle environment's name, description, stages, or tags.
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 1034 1035 1036 1037 |
# File 'lib/oci/os_management_hub/lifecycle_environment_client.rb', line 999 def update_lifecycle_environment(lifecycle_environment_id, update_lifecycle_environment_details, opts = {}) logger.debug 'Calling operation LifecycleEnvironmentClient#update_lifecycle_environment.' if logger raise "Missing the required parameter 'lifecycle_environment_id' when calling update_lifecycle_environment." if lifecycle_environment_id.nil? raise "Missing the required parameter 'update_lifecycle_environment_details' when calling update_lifecycle_environment." if update_lifecycle_environment_details.nil? raise "Parameter value for 'lifecycle_environment_id' must not be blank" if OCI::Internal::Util.blank_string?(lifecycle_environment_id) path = '/lifecycleEnvironments/{lifecycleEnvironmentId}'.sub('{lifecycleEnvironmentId}', lifecycle_environment_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_lifecycle_environment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'LifecycleEnvironmentClient#update_lifecycle_environment') 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::OsManagementHub::Models::LifecycleEnvironment' ) end # rubocop:enable Metrics/BlockLength end |