Class: OCI::DatabaseMigration::DatabaseMigrationClient
- Inherits:
-
Object
- Object
- OCI::DatabaseMigration::DatabaseMigrationClient
- Defined in:
- lib/oci/database_migration/database_migration_client.rb
Overview
Use the Oracle Cloud Infrastructure Database Migration APIs to perform database migration operations.
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
-
#abort_job(job_id, opts = {}) ⇒ Response
Aborts a Migration Job (either Evaluation or Migration).
-
#add_migration_objects(migration_id, add_migration_objects_details, opts = {}) ⇒ Response
Add excluded/included object to the list.
-
#change_agent_compartment(agent_id, change_agent_compartment_details, opts = {}) ⇒ Response
Used to configure an ODMS Agent Compartment ID.
-
#change_connection_compartment(connection_id, change_connection_compartment_details, opts = {}) ⇒ Response
Used to change the Database Connection compartment.
-
#change_migration_compartment(migration_id, change_migration_compartment_details, opts = {}) ⇒ Response
Used to change the Migration compartment.
-
#clone_migration(migration_id, clone_migration_details, opts = {}) ⇒ Response
Clone a configuration from an existing Migration.
-
#connection_diagnostics(connection_id, opts = {}) ⇒ Response
Perform connection test for a database connection.
-
#create_connection(create_connection_details, opts = {}) ⇒ Response
Create a Database Connection resource that contains the details to connect to either a Source or Target Database in the migration.
-
#create_migration(create_migration_details, opts = {}) ⇒ Response
Create a Migration resource that contains all the details to perform the database migration operation, such as source and destination database details, credentials, etc.
-
#delete_agent(agent_id, opts = {}) ⇒ Response
Delete the ODMS Agent represented by the specified ODMS Agent ID.
-
#delete_connection(connection_id, opts = {}) ⇒ Response
Deletes the Database Connection represented by the specified connection ID.
-
#delete_job(job_id, opts = {}) ⇒ Response
Deletes the migration job represented by the given job ID.
-
#delete_migration(migration_id, opts = {}) ⇒ Response
Deletes the Migration represented by the specified migration ID.
-
#evaluate_migration(migration_id, opts = {}) ⇒ Response
Start Validate Migration job.
-
#get_advisor_report(job_id, opts = {}) ⇒ Response
Get the Pre-Migration Advisor report details.
-
#get_agent(agent_id, opts = {}) ⇒ Response
Display the ODMS Agent configuration.
-
#get_connection(connection_id, opts = {}) ⇒ Response
Display Database Connection details.
-
#get_job(job_id, opts = {}) ⇒ Response
Get a migration job.
-
#get_job_output_content(job_id, opts = {}, &block) ⇒ Response
Get the migration Job Output content as a String.
-
#get_migration(migration_id, opts = {}) ⇒ Response
Display Migration details.
-
#get_work_request(work_request_id, opts = {}) ⇒ Response
Gets the details of a work request.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ DatabaseMigrationClient
constructor
Creates a new DatabaseMigrationClient.
-
#list_agent_images(opts = {}) ⇒ Response
Get details of the ODMS Agent Images available to install on-premises.
-
#list_agents(compartment_id, opts = {}) ⇒ Response
Display the name of all the existing ODMS Agents in the server.
-
#list_connections(compartment_id, opts = {}) ⇒ Response
List all Database Connections.
-
#list_excluded_objects(job_id, opts = {}) ⇒ Response
List the excluded database objects.
-
#list_job_outputs(job_id, opts = {}) ⇒ Response
List the Job Outputs.
-
#list_jobs(migration_id, opts = {}) ⇒ Response
List all the names of the Migration jobs associated to the specified migration site.
-
#list_migration_object_types(opts = {}) ⇒ Response
Display sample object types to exclude or include for a Migration.
-
#list_migration_objects(migration_id, opts = {}) ⇒ Response
Display excluded/included objects.
-
#list_migrations(compartment_id, opts = {}) ⇒ Response
List all Migrations.
-
#list_work_request_errors(work_request_id, opts = {}) ⇒ Response
Gets the errors for a work request.
-
#list_work_request_logs(work_request_id, opts = {}) ⇒ Response
Gets the logs for a work request.
-
#list_work_requests(compartment_id, opts = {}) ⇒ Response
Lists the work requests in a compartment or for a specified resource.
-
#logger ⇒ Logger
The logger for this client.
-
#remove_migration_objects(migration_id, remove_migration_objects_details, opts = {}) ⇒ Response
Remove excluded/included objects.
-
#resume_job(job_id, opts = {}) ⇒ Response
Resume a migration Job.
-
#retrieve_supported_phases(migration_id, opts = {}) ⇒ Response
Display Migration Phases for a specified migration.
-
#start_migration(migration_id, opts = {}) ⇒ Response
Start Migration job.
-
#update_agent(agent_id, update_agent_details, opts = {}) ⇒ Response
Modifies the ODMS Agent represented by the given ODMS Agent ID.
-
#update_connection(connection_id, update_connection_details, opts = {}) ⇒ Response
Update Database Connection resource details.
-
#update_job(job_id, update_job_details, opts = {}) ⇒ Response
Update Migration Job resource details.
-
#update_migration(migration_id, update_migration_details, opts = {}) ⇒ Response
Update Migration resource details.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ DatabaseMigrationClient
Creates a new DatabaseMigrationClient. 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/database_migration/database_migration_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 + '/20210929' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "DatabaseMigrationClient 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/database_migration/database_migration_client.rb', line 15 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
19 20 21 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 19 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
29 30 31 |
# File 'lib/oci/database_migration/database_migration_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/database_migration/database_migration_client.rb', line 25 def retry_config @retry_config end |
Instance Method Details
#abort_job(job_id, opts = {}) ⇒ Response
Click here to see an example of how to use abort_job API.
Aborts a Migration Job (either Evaluation or Migration).
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 166 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 127 def abort_job(job_id, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#abort_job.' if logger raise "Missing the required parameter 'job_id' when calling abort_job." if job_id.nil? raise "Parameter value for 'job_id' must not be blank" if OCI::Internal::Util.blank_string?(job_id) path = '/jobs/{jobId}/actions/abort'.sub('{jobId}', job_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-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 = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DatabaseMigrationClient#abort_job') 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::DatabaseMigration::Models::Job' ) end # rubocop:enable Metrics/BlockLength end |
#add_migration_objects(migration_id, add_migration_objects_details, opts = {}) ⇒ Response
Click here to see an example of how to use add_migration_objects API.
Add excluded/included object to the list.
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 226 227 228 229 230 231 232 233 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 196 def add_migration_objects(migration_id, add_migration_objects_details, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#add_migration_objects.' if logger raise "Missing the required parameter 'migration_id' when calling add_migration_objects." if migration_id.nil? raise "Missing the required parameter 'add_migration_objects_details' when calling add_migration_objects." if add_migration_objects_details.nil? raise "Parameter value for 'migration_id' must not be blank" if OCI::Internal::Util.blank_string?(migration_id) path = '/migrations/{migrationId}/actions/addMigrationObjects'.sub('{migrationId}', migration_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(add_migration_objects_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DatabaseMigrationClient#add_migration_objects') 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_agent_compartment(agent_id, change_agent_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_agent_compartment API.
Used to configure an ODMS Agent Compartment ID.
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 299 300 301 302 303 304 305 306 307 308 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 269 def change_agent_compartment(agent_id, change_agent_compartment_details, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#change_agent_compartment.' if logger raise "Missing the required parameter 'agent_id' when calling change_agent_compartment." if agent_id.nil? raise "Missing the required parameter 'change_agent_compartment_details' when calling change_agent_compartment." if change_agent_compartment_details.nil? raise "Parameter value for 'agent_id' must not be blank" if OCI::Internal::Util.blank_string?(agent_id) path = '/agents/{agentId}/actions/changeCompartment'.sub('{agentId}', agent_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-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] 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(change_agent_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DatabaseMigrationClient#change_agent_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#change_connection_compartment(connection_id, change_connection_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_connection_compartment API.
Used to change the Database Connection compartment.
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 344 def change_connection_compartment(connection_id, change_connection_compartment_details, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#change_connection_compartment.' if logger raise "Missing the required parameter 'connection_id' when calling change_connection_compartment." if connection_id.nil? raise "Missing the required parameter 'change_connection_compartment_details' when calling change_connection_compartment." if change_connection_compartment_details.nil? raise "Parameter value for 'connection_id' must not be blank" if OCI::Internal::Util.blank_string?(connection_id) path = '/connections/{connectionId}/actions/changeCompartment'.sub('{connectionId}', connection_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-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] 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(change_connection_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DatabaseMigrationClient#change_connection_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#change_migration_compartment(migration_id, change_migration_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_migration_compartment API.
Used to change the Migration compartment.
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 456 457 458 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 419 def change_migration_compartment(migration_id, change_migration_compartment_details, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#change_migration_compartment.' if logger raise "Missing the required parameter 'migration_id' when calling change_migration_compartment." if migration_id.nil? raise "Missing the required parameter 'change_migration_compartment_details' when calling change_migration_compartment." if change_migration_compartment_details.nil? raise "Parameter value for 'migration_id' must not be blank" if OCI::Internal::Util.blank_string?(migration_id) path = '/migrations/{migrationId}/actions/changeCompartment'.sub('{migrationId}', migration_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-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] 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(change_migration_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DatabaseMigrationClient#change_migration_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 |
#clone_migration(migration_id, clone_migration_details, opts = {}) ⇒ Response
Click here to see an example of how to use clone_migration API.
Clone a configuration from an existing Migration.
494 495 496 497 498 499 500 501 502 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 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 494 def clone_migration(migration_id, clone_migration_details, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#clone_migration.' if logger raise "Missing the required parameter 'migration_id' when calling clone_migration." if migration_id.nil? raise "Missing the required parameter 'clone_migration_details' when calling clone_migration." if clone_migration_details.nil? raise "Parameter value for 'migration_id' must not be blank" if OCI::Internal::Util.blank_string?(migration_id) path = '/migrations/{migrationId}/actions/clone'.sub('{migrationId}', migration_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-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(clone_migration_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DatabaseMigrationClient#clone_migration') 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::DatabaseMigration::Models::Migration' ) end # rubocop:enable Metrics/BlockLength end |
#connection_diagnostics(connection_id, opts = {}) ⇒ Response
Click here to see an example of how to use connection_diagnostics API.
Perform connection test for a database connection.
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 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 568 def connection_diagnostics(connection_id, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#connection_diagnostics.' if logger raise "Missing the required parameter 'connection_id' when calling connection_diagnostics." if connection_id.nil? raise "Parameter value for 'connection_id' must not be blank" if OCI::Internal::Util.blank_string?(connection_id) path = '/connections/{connectionId}/actions/diagnostics'.sub('{connectionId}', connection_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: 'DatabaseMigrationClient#connection_diagnostics') 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::DatabaseMigration::Models::DiagnosticsResult' ) end # rubocop:enable Metrics/BlockLength end |
#create_connection(create_connection_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_connection API.
Create a Database Connection resource that contains the details to connect to either a Source or Target Database in the migration.
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 673 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 636 def create_connection(create_connection_details, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#create_connection.' if logger raise "Missing the required parameter 'create_connection_details' when calling create_connection." if create_connection_details.nil? path = '/connections' 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_connection_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DatabaseMigrationClient#create_connection') 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::DatabaseMigration::Models::Connection' ) end # rubocop:enable Metrics/BlockLength end |
#create_migration(create_migration_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_migration API.
Create a Migration resource that contains all the details to perform the database migration operation, such as source and destination database details, credentials, etc.
703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 703 def create_migration(create_migration_details, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#create_migration.' if logger raise "Missing the required parameter 'create_migration_details' when calling create_migration." if create_migration_details.nil? path = '/migrations' 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_migration_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DatabaseMigrationClient#create_migration') 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::DatabaseMigration::Models::Migration' ) end # rubocop:enable Metrics/BlockLength end |
#delete_agent(agent_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_agent API.
Delete the ODMS Agent represented by the specified ODMS Agent ID.
768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 768 def delete_agent(agent_id, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#delete_agent.' if logger raise "Missing the required parameter 'agent_id' when calling delete_agent." if agent_id.nil? raise "Parameter value for 'agent_id' must not be blank" if OCI::Internal::Util.blank_string?(agent_id) path = '/agents/{agentId}'.sub('{agentId}', agent_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DatabaseMigrationClient#delete_agent') 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_connection(connection_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_connection API.
Deletes the Database Connection represented by the specified connection ID.
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 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 832 def delete_connection(connection_id, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#delete_connection.' if logger raise "Missing the required parameter 'connection_id' when calling delete_connection." if connection_id.nil? raise "Parameter value for 'connection_id' must not be blank" if OCI::Internal::Util.blank_string?(connection_id) path = '/connections/{connectionId}'.sub('{connectionId}', connection_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DatabaseMigrationClient#delete_connection') 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_job(job_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_job API.
Deletes the migration job represented by the given job ID.
896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 896 def delete_job(job_id, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#delete_job.' if logger raise "Missing the required parameter 'job_id' when calling delete_job." if job_id.nil? raise "Parameter value for 'job_id' must not be blank" if OCI::Internal::Util.blank_string?(job_id) path = '/jobs/{jobId}'.sub('{jobId}', job_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DatabaseMigrationClient#delete_job') 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_migration(migration_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_migration API.
Deletes the Migration represented by the specified migration ID.
960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 960 def delete_migration(migration_id, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#delete_migration.' if logger raise "Missing the required parameter 'migration_id' when calling delete_migration." if migration_id.nil? raise "Parameter value for 'migration_id' must not be blank" if OCI::Internal::Util.blank_string?(migration_id) path = '/migrations/{migrationId}'.sub('{migrationId}', migration_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DatabaseMigrationClient#delete_migration') 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 |
#evaluate_migration(migration_id, opts = {}) ⇒ Response
Click here to see an example of how to use evaluate_migration API.
Start Validate Migration job.
1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 1030 def evaluate_migration(migration_id, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#evaluate_migration.' if logger raise "Missing the required parameter 'migration_id' when calling evaluate_migration." if migration_id.nil? raise "Parameter value for 'migration_id' must not be blank" if OCI::Internal::Util.blank_string?(migration_id) path = '/migrations/{migrationId}/actions/validate'.sub('{migrationId}', migration_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-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 = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DatabaseMigrationClient#evaluate_migration') 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::DatabaseMigration::Models::Job' ) end # rubocop:enable Metrics/BlockLength end |
#get_advisor_report(job_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_advisor_report API.
Get the Pre-Migration Advisor report details
1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 1091 def get_advisor_report(job_id, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#get_advisor_report.' if logger raise "Missing the required parameter 'job_id' when calling get_advisor_report." if job_id.nil? raise "Parameter value for 'job_id' must not be blank" if OCI::Internal::Util.blank_string?(job_id) path = '/jobs/{jobId}/advisorReport'.sub('{jobId}', job_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: 'DatabaseMigrationClient#get_advisor_report') 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::DatabaseMigration::Models::AdvisorReport' ) end # rubocop:enable Metrics/BlockLength end |
#get_agent(agent_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_agent API.
Display the ODMS Agent configuration.
1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 1149 def get_agent(agent_id, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#get_agent.' if logger raise "Missing the required parameter 'agent_id' when calling get_agent." if agent_id.nil? raise "Parameter value for 'agent_id' must not be blank" if OCI::Internal::Util.blank_string?(agent_id) path = '/agents/{agentId}'.sub('{agentId}', agent_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: 'DatabaseMigrationClient#get_agent') 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::DatabaseMigration::Models::Agent' ) end # rubocop:enable Metrics/BlockLength end |
#get_connection(connection_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_connection API.
Display Database Connection details.
1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 1207 def get_connection(connection_id, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#get_connection.' if logger raise "Missing the required parameter 'connection_id' when calling get_connection." if connection_id.nil? raise "Parameter value for 'connection_id' must not be blank" if OCI::Internal::Util.blank_string?(connection_id) path = '/connections/{connectionId}'.sub('{connectionId}', connection_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: 'DatabaseMigrationClient#get_connection') 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::DatabaseMigration::Models::Connection' ) end # rubocop:enable Metrics/BlockLength end |
#get_job(job_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_job API.
Get a migration job.
1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 1265 def get_job(job_id, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#get_job.' if logger raise "Missing the required parameter 'job_id' when calling get_job." if job_id.nil? raise "Parameter value for 'job_id' must not be blank" if OCI::Internal::Util.blank_string?(job_id) path = '/jobs/{jobId}'.sub('{jobId}', job_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: 'DatabaseMigrationClient#get_job') 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::DatabaseMigration::Models::Job' ) end # rubocop:enable Metrics/BlockLength end |
#get_job_output_content(job_id, opts = {}, &block) ⇒ Response
Click here to see an example of how to use get_job_output_content API.
Get the migration Job Output content as a String.
1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 1325 def get_job_output_content(job_id, opts = {}, &block) logger.debug 'Calling operation DatabaseMigrationClient#get_job_output_content.' if logger raise "Missing the required parameter 'job_id' when calling get_job_output_content." if job_id.nil? raise "Parameter value for 'job_id' must not be blank" if OCI::Internal::Util.blank_string?(job_id) path = '/jobs/{jobId}/output/content'.sub('{jobId}', job_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = opts[:accept] if opts[:accept] header_params[:accept] ||= 'application/x-yaml' header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding] header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DatabaseMigrationClient#get_job_output_content') do if !block.nil? @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Stream', &block ) elsif opts[:response_target] if opts[:response_target].respond_to? :write @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Stream', &proc { |chunk, _response| opts[:response_target].write(chunk) } ) elsif opts[:response_target].is_a?(String) File.open(opts[:response_target], 'wb') do |output| return @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Stream', &proc { |chunk, _response| output.write(chunk) } ) end end else @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'String' ) end end # rubocop:enable Metrics/BlockLength end |
#get_migration(migration_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_migration API.
Display Migration details.
1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 1433 def get_migration(migration_id, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#get_migration.' if logger raise "Missing the required parameter 'migration_id' when calling get_migration." if migration_id.nil? raise "Parameter value for 'migration_id' must not be blank" if OCI::Internal::Util.blank_string?(migration_id) path = '/migrations/{migrationId}'.sub('{migrationId}', migration_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DatabaseMigrationClient#get_migration') 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::DatabaseMigration::Models::Migration' ) end # rubocop:enable Metrics/BlockLength end |
#get_work_request(work_request_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_work_request API.
Gets the details of a work request.
1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 1492 def get_work_request(work_request_id, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#get_work_request.' if logger raise "Missing the required parameter 'work_request_id' when calling get_work_request." if work_request_id.nil? raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id) path = '/workRequests/{workRequestId}'.sub('{workRequestId}', work_request_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: 'DatabaseMigrationClient#get_work_request') 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::DatabaseMigration::Models::WorkRequest' ) end # rubocop:enable Metrics/BlockLength end |
#list_agent_images(opts = {}) ⇒ Response
Click here to see an example of how to use list_agent_images API.
Get details of the ODMS Agent Images available to install on-premises.
1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 1554 def list_agent_images(opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#list_agent_images.' if logger if opts[:sort_order] && !OCI::DatabaseMigration::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseMigration::Models::SORT_ORDERS_ENUM.' end path = '/agentImages' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DatabaseMigrationClient#list_agent_images') 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::DatabaseMigration::Models::AgentImageCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_agents(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_agents API.
Display the name of all the existing ODMS Agents in the server.
1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 1631 def list_agents(compartment_id, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#list_agents.' if logger raise "Missing the required parameter 'compartment_id' when calling list_agents." if compartment_id.nil? if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.' end if opts[:sort_order] && !OCI::DatabaseMigration::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseMigration::Models::SORT_ORDERS_ENUM.' end if opts[:lifecycle_state] && !OCI::DatabaseMigration::Models::LIFECYCLE_STATES_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DatabaseMigration::Models::LIFECYCLE_STATES_ENUM.' end path = '/agents' 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[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] # 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: 'DatabaseMigrationClient#list_agents') 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::DatabaseMigration::Models::AgentCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_connections(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_connections API.
List all Database Connections.
1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 1721 def list_connections(compartment_id, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#list_connections.' if logger raise "Missing the required parameter 'compartment_id' when calling list_connections." if compartment_id.nil? if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.' end if opts[:sort_order] && !OCI::DatabaseMigration::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseMigration::Models::SORT_ORDERS_ENUM.' end if opts[:lifecycle_state] && !OCI::DatabaseMigration::Models::LIFECYCLE_STATES_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DatabaseMigration::Models::LIFECYCLE_STATES_ENUM.' end path = '/connections' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] # 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: 'DatabaseMigrationClient#list_connections') 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::DatabaseMigration::Models::ConnectionCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_excluded_objects(job_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_excluded_objects API.
List the excluded database objects.
1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 1822 def list_excluded_objects(job_id, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#list_excluded_objects.' if logger raise "Missing the required parameter 'job_id' when calling list_excluded_objects." if job_id.nil? if opts[:sort_order] && !OCI::DatabaseMigration::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseMigration::Models::SORT_ORDERS_ENUM.' end if opts[:sort_by] && !%w[type reasonCategory].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of type, reasonCategory.' end if opts[:reason_category] && !OCI::DatabaseMigration::Models::REASON_KEYWORDS_ENUM.include?(opts[:reason_category]) raise 'Invalid value for "reason_category", must be one of the values in OCI::DatabaseMigration::Models::REASON_KEYWORDS_ENUM.' end raise "Parameter value for 'job_id' must not be blank" if OCI::Internal::Util.blank_string?(job_id) path = '/jobs/{jobId}/excludedObjects'.sub('{jobId}', job_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:type] = opts[:type] if opts[:type] query_params[:owner] = opts[:owner] if opts[:owner] query_params[:object] = opts[:object] if opts[:object] query_params[:ownerContains] = opts[:owner_contains] if opts[:owner_contains] query_params[:objectContains] = opts[:object_contains] if opts[:object_contains] query_params[:reasonCategory] = opts[:reason_category] if opts[:reason_category] query_params[:sourceRule] = opts[:source_rule] if opts[:source_rule] # 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: 'DatabaseMigrationClient#list_excluded_objects') 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::DatabaseMigration::Models::ExcludedObjectSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_job_outputs(job_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_job_outputs API.
List the Job Outputs
1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 1907 def list_job_outputs(job_id, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#list_job_outputs.' if logger raise "Missing the required parameter 'job_id' when calling list_job_outputs." if job_id.nil? raise "Parameter value for 'job_id' must not be blank" if OCI::Internal::Util.blank_string?(job_id) path = '/jobs/{jobId}/output'.sub('{jobId}', job_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] # 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: 'DatabaseMigrationClient#list_job_outputs') 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::DatabaseMigration::Models::JobOutputSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_jobs(migration_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_jobs API.
List all the names of the Migration jobs associated to the specified migration site.
1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 1982 def list_jobs(migration_id, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#list_jobs.' if logger raise "Missing the required parameter 'migration_id' when calling list_jobs." if migration_id.nil? if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.' end if opts[:sort_order] && !OCI::DatabaseMigration::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseMigration::Models::SORT_ORDERS_ENUM.' end if opts[:lifecycle_state] && !OCI::DatabaseMigration::Models::JOB_LIFECYCLE_STATES_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DatabaseMigration::Models::JOB_LIFECYCLE_STATES_ENUM.' end path = '/jobs' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:migrationId] = migration_id query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] # 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: 'DatabaseMigrationClient#list_jobs') 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::DatabaseMigration::Models::JobCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_migration_object_types(opts = {}) ⇒ Response
Click here to see an example of how to use list_migration_object_types API.
Display sample object types to exclude or include for a Migration.
2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 2066 def list_migration_object_types(opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#list_migration_object_types.' if logger if opts[:sort_by] && !%w[name].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of name.' end if opts[:sort_order] && !OCI::DatabaseMigration::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseMigration::Models::SORT_ORDERS_ENUM.' end path = '/migrationObjectTypes' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] # 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: 'DatabaseMigrationClient#list_migration_object_types') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::DatabaseMigration::Models::MigrationObjectTypeSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_migration_objects(migration_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_migration_objects API.
Display excluded/included objects.
2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 2144 def list_migration_objects(migration_id, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#list_migration_objects.' if logger raise "Missing the required parameter 'migration_id' when calling list_migration_objects." if migration_id.nil? raise "Parameter value for 'migration_id' must not be blank" if OCI::Internal::Util.blank_string?(migration_id) path = '/migrations/{migrationId}/migrationObjects'.sub('{migrationId}', migration_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DatabaseMigrationClient#list_migration_objects') 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::DatabaseMigration::Models::MigrationObjectCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_migrations(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_migrations API.
List all Migrations.
2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 2221 def list_migrations(compartment_id, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#list_migrations.' if logger raise "Missing the required parameter 'compartment_id' when calling list_migrations." if compartment_id.nil? if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.' end if opts[:sort_order] && !OCI::DatabaseMigration::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseMigration::Models::SORT_ORDERS_ENUM.' end if opts[:lifecycle_state] && !OCI::DatabaseMigration::Models::MIGRATION_LIFECYCLE_STATES_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DatabaseMigration::Models::MIGRATION_LIFECYCLE_STATES_ENUM.' end if opts[:lifecycle_details] && !OCI::DatabaseMigration::Models::MIGRATION_STATUS_ENUM.include?(opts[:lifecycle_details]) raise 'Invalid value for "lifecycle_details", must be one of the values in OCI::DatabaseMigration::Models::MIGRATION_STATUS_ENUM.' end path = '/migrations' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:lifecycleDetails] = opts[:lifecycle_details] if opts[:lifecycle_details] # 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: 'DatabaseMigrationClient#list_migrations') 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::DatabaseMigration::Models::MigrationCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_work_request_errors(work_request_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_work_request_errors API.
Gets the errors for a work request.
Allowed values are: timestamp
2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 2311 def list_work_request_errors(work_request_id, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#list_work_request_errors.' if logger raise "Missing the required parameter 'work_request_id' when calling list_work_request_errors." if work_request_id.nil? if opts[:sort_by] && !%w[timestamp].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timestamp.' end if opts[:sort_order] && !OCI::DatabaseMigration::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseMigration::Models::SORT_ORDERS_ENUM.' end raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id) path = '/workRequests/{workRequestId}/errors'.sub('{workRequestId}', work_request_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DatabaseMigrationClient#list_work_request_errors') 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::DatabaseMigration::Models::WorkRequestErrorCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_work_request_logs(work_request_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_work_request_logs API.
Gets the logs for a work request.
Allowed values are: timestamp
2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 2390 def list_work_request_logs(work_request_id, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#list_work_request_logs.' if logger raise "Missing the required parameter 'work_request_id' when calling list_work_request_logs." if work_request_id.nil? if opts[:sort_by] && !%w[timestamp].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timestamp.' end if opts[:sort_order] && !OCI::DatabaseMigration::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseMigration::Models::SORT_ORDERS_ENUM.' end raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id) path = '/workRequests/{workRequestId}/logs'.sub('{workRequestId}', work_request_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DatabaseMigrationClient#list_work_request_logs') 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::DatabaseMigration::Models::WorkRequestLogEntryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_work_requests(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_work_requests API.
Lists the work requests in a compartment or for a specified resource.
Allowed values are: timeAccepted
2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 2473 def list_work_requests(compartment_id, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#list_work_requests.' if logger raise "Missing the required parameter 'compartment_id' when calling list_work_requests." if compartment_id.nil? if opts[:status] && !OCI::DatabaseMigration::Models::OPERATION_STATUS_ENUM.include?(opts[:status]) raise 'Invalid value for "status", must be one of the values in OCI::DatabaseMigration::Models::OPERATION_STATUS_ENUM.' end if opts[:sort_by] && !%w[timeAccepted].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeAccepted.' end if opts[:sort_order] && !OCI::DatabaseMigration::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseMigration::Models::SORT_ORDERS_ENUM.' end path = '/workRequests' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:resourceId] = opts[:resource_id] if opts[:resource_id] query_params[:status] = opts[:status] if opts[:status] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DatabaseMigrationClient#list_work_requests') 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::DatabaseMigration::Models::WorkRequestCollection' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
94 95 96 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 94 def logger @api_client.config.logger end |
#remove_migration_objects(migration_id, remove_migration_objects_details, opts = {}) ⇒ Response
Click here to see an example of how to use remove_migration_objects API.
Remove excluded/included objects.
2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 2557 def remove_migration_objects(migration_id, remove_migration_objects_details, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#remove_migration_objects.' if logger raise "Missing the required parameter 'migration_id' when calling remove_migration_objects." if migration_id.nil? raise "Missing the required parameter 'remove_migration_objects_details' when calling remove_migration_objects." if remove_migration_objects_details.nil? raise "Parameter value for 'migration_id' must not be blank" if OCI::Internal::Util.blank_string?(migration_id) path = '/migrations/{migrationId}/actions/removeMigrationObjects'.sub('{migrationId}', migration_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(remove_migration_objects_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DatabaseMigrationClient#remove_migration_objects') 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 |
#resume_job(job_id, opts = {}) ⇒ Response
Click here to see an example of how to use resume_job API.
Resume a migration Job.
2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 2630 def resume_job(job_id, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#resume_job.' if logger raise "Missing the required parameter 'job_id' when calling resume_job." if job_id.nil? raise "Parameter value for 'job_id' must not be blank" if OCI::Internal::Util.blank_string?(job_id) path = '/jobs/{jobId}/actions/resume'.sub('{jobId}', job_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-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(opts[:resume_job_details]) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DatabaseMigrationClient#resume_job') 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::DatabaseMigration::Models::Job' ) end # rubocop:enable Metrics/BlockLength end |
#retrieve_supported_phases(migration_id, opts = {}) ⇒ Response
Click here to see an example of how to use retrieve_supported_phases API.
Display Migration Phases for a specified migration.
2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 2691 def retrieve_supported_phases(migration_id, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#retrieve_supported_phases.' if logger raise "Missing the required parameter 'migration_id' when calling retrieve_supported_phases." if migration_id.nil? raise "Parameter value for 'migration_id' must not be blank" if OCI::Internal::Util.blank_string?(migration_id) path = '/migrations/{migrationId}/actions/getSupportedPhases'.sub('{migrationId}', migration_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: 'DatabaseMigrationClient#retrieve_supported_phases') 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::DatabaseMigration::Models::MigrationPhaseCollection' ) end # rubocop:enable Metrics/BlockLength end |
#start_migration(migration_id, opts = {}) ⇒ Response
Click here to see an example of how to use start_migration API.
Start Migration job.
2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 2763 def start_migration(migration_id, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#start_migration.' if logger raise "Missing the required parameter 'migration_id' when calling start_migration." if migration_id.nil? raise "Parameter value for 'migration_id' must not be blank" if OCI::Internal::Util.blank_string?(migration_id) path = '/migrations/{migrationId}/actions/start'.sub('{migrationId}', migration_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-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(opts[:start_migration_details]) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DatabaseMigrationClient#start_migration') 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::DatabaseMigration::Models::Job' ) end # rubocop:enable Metrics/BlockLength end |
#update_agent(agent_id, update_agent_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_agent API.
Modifies the ODMS Agent represented by the given ODMS Agent ID.
2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 2838 def update_agent(agent_id, update_agent_details, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#update_agent.' if logger raise "Missing the required parameter 'agent_id' when calling update_agent." if agent_id.nil? raise "Missing the required parameter 'update_agent_details' when calling update_agent." if update_agent_details.nil? raise "Parameter value for 'agent_id' must not be blank" if OCI::Internal::Util.blank_string?(agent_id) path = '/agents/{agentId}'.sub('{agentId}', agent_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(update_agent_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DatabaseMigrationClient#update_agent') 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::DatabaseMigration::Models::Agent' ) end # rubocop:enable Metrics/BlockLength end |
#update_connection(connection_id, update_connection_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_connection API.
Update Database Connection resource details.
2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 2908 def update_connection(connection_id, update_connection_details, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#update_connection.' if logger raise "Missing the required parameter 'connection_id' when calling update_connection." if connection_id.nil? raise "Missing the required parameter 'update_connection_details' when calling update_connection." if update_connection_details.nil? raise "Parameter value for 'connection_id' must not be blank" if OCI::Internal::Util.blank_string?(connection_id) path = '/connections/{connectionId}'.sub('{connectionId}', connection_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_connection_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DatabaseMigrationClient#update_connection') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#update_job(job_id, update_job_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_job API.
Update Migration Job resource details.
2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 2975 def update_job(job_id, update_job_details, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#update_job.' if logger raise "Missing the required parameter 'job_id' when calling update_job." if job_id.nil? raise "Missing the required parameter 'update_job_details' when calling update_job." if update_job_details.nil? raise "Parameter value for 'job_id' must not be blank" if OCI::Internal::Util.blank_string?(job_id) path = '/jobs/{jobId}'.sub('{jobId}', job_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_job_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DatabaseMigrationClient#update_job') 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::DatabaseMigration::Models::Job' ) end # rubocop:enable Metrics/BlockLength end |
#update_migration(migration_id, update_migration_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_migration API.
Update Migration resource details.
3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 |
# File 'lib/oci/database_migration/database_migration_client.rb', line 3043 def update_migration(migration_id, update_migration_details, opts = {}) logger.debug 'Calling operation DatabaseMigrationClient#update_migration.' if logger raise "Missing the required parameter 'migration_id' when calling update_migration." if migration_id.nil? raise "Missing the required parameter 'update_migration_details' when calling update_migration." if update_migration_details.nil? raise "Parameter value for 'migration_id' must not be blank" if OCI::Internal::Util.blank_string?(migration_id) path = '/migrations/{migrationId}'.sub('{migrationId}', migration_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_migration_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DatabaseMigrationClient#update_migration') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |