Class: OCI::Mysql::MysqlaasClient
- Inherits:
-
Object
- Object
- OCI::Mysql::MysqlaasClient
- Defined in:
- lib/oci/mysql/mysqlaas_client.rb
Overview
The API for the MySQL Database Service
Instance Attribute Summary collapse
-
#api_client ⇒ OCI::ApiClient
readonly
Client used to make HTTP requests.
-
#endpoint ⇒ String
readonly
Fully qualified endpoint URL.
-
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
-
#retry_config ⇒ OCI::Retry::RetryConfig
readonly
The default retry configuration to apply to all operations in this service client.
Instance Method Summary collapse
-
#create_configuration(create_configuration_details, opts = {}) ⇒ Response
Creates a new Configuration.
-
#delete_configuration(configuration_id, opts = {}) ⇒ Response
Deletes a Configuration.
-
#get_configuration(configuration_id, opts = {}) ⇒ Response
Get the full details of the specified Configuration, including the list of MySQL Variables and their values.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ MysqlaasClient
constructor
Creates a new MysqlaasClient.
-
#list_configurations(compartment_id, opts = {}) ⇒ Response
Lists the Configurations available when creating a DB System.
-
#list_shapes(compartment_id, opts = {}) ⇒ Response
Gets a list of the shapes you can use to create a new MySQL DB System.
-
#list_versions(compartment_id, opts = {}) ⇒ Response
Get a list of supported and available MySQL database major versions.
-
#logger ⇒ Logger
The logger for this client.
-
#update_configuration(configuration_id, update_configuration_details, opts = {}) ⇒ Response
Updates the Configuration details.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ MysqlaasClient
Creates a new MysqlaasClient. 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.
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 |
# File 'lib/oci/mysql/mysqlaas_client.rb', line 53 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) if signer.nil? signer = OCI::Signer.new( config.user, config.fingerprint, config.tenancy, config.key_file, pass_phrase: config.pass_phrase, private_key_content: config.key_content ) end @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings) @retry_config = retry_config if endpoint @endpoint = endpoint + '/20190415' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "MysqlaasClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
13 14 15 |
# File 'lib/oci/mysql/mysqlaas_client.rb', line 13 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
17 18 19 |
# File 'lib/oci/mysql/mysqlaas_client.rb', line 17 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
27 28 29 |
# File 'lib/oci/mysql/mysqlaas_client.rb', line 27 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
23 24 25 |
# File 'lib/oci/mysql/mysqlaas_client.rb', line 23 def retry_config @retry_config end |
Instance Method Details
#create_configuration(create_configuration_details, opts = {}) ⇒ Response
Creates a new Configuration.
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 |
# File 'lib/oci/mysql/mysqlaas_client.rb', line 127 def create_configuration(create_configuration_details, opts = {}) logger.debug 'Calling operation MysqlaasClient#create_configuration.' if logger raise "Missing the required parameter 'create_configuration_details' when calling create_configuration." if create_configuration_details.nil? path = '/configurations' 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] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_configuration_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'MysqlaasClient#create_configuration') 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::Mysql::Models::Configuration' ) end # rubocop:enable Metrics/BlockLength end |
#delete_configuration(configuration_id, opts = {}) ⇒ Response
Deletes a Configuration. The Configuration must not be in use by any DB Systems.
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 |
# File 'lib/oci/mysql/mysqlaas_client.rb', line 192 def delete_configuration(configuration_id, opts = {}) logger.debug 'Calling operation MysqlaasClient#delete_configuration.' if logger raise "Missing the required parameter 'configuration_id' when calling delete_configuration." if configuration_id.nil? raise "Parameter value for 'configuration_id' must not be blank" if OCI::Internal::Util.blank_string?(configuration_id) path = '/configurations/{configurationId}'.sub('{configurationId}', configuration_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: 'MysqlaasClient#delete_configuration') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#get_configuration(configuration_id, opts = {}) ⇒ Response
Get the full details of the specified Configuration, including the list of MySQL Variables and their values.
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 |
# File 'lib/oci/mysql/mysqlaas_client.rb', line 255 def get_configuration(configuration_id, opts = {}) logger.debug 'Calling operation MysqlaasClient#get_configuration.' if logger raise "Missing the required parameter 'configuration_id' when calling get_configuration." if configuration_id.nil? raise "Parameter value for 'configuration_id' must not be blank" if OCI::Internal::Util.blank_string?(configuration_id) path = '/configurations/{configurationId}'.sub('{configurationId}', configuration_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-none-match'] = opts[:if_none_match] if opts[:if_none_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'MysqlaasClient#get_configuration') 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::Mysql::Models::Configuration' ) end # rubocop:enable Metrics/BlockLength end |
#list_configurations(compartment_id, opts = {}) ⇒ Response
Lists the Configurations available when creating a DB System.
This may include DEFAULT configurations per Shape and CUSTOM configurations.
The default sort order is a multi-part sort by: - shapeName, ascending - DEFAULT-before-CUSTOM - displayName ascending
Allowed values are: displayName, shapeName, timeCreated, timeUpdated
338 339 340 341 342 343 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 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 |
# File 'lib/oci/mysql/mysqlaas_client.rb', line 338 def list_configurations(compartment_id, opts = {}) logger.debug 'Calling operation MysqlaasClient#list_configurations.' if logger raise "Missing the required parameter 'compartment_id' when calling list_configurations." if compartment_id.nil? if opts[:lifecycle_state] && !OCI::Mysql::Models::Configuration::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Mysql::Models::Configuration::LIFECYCLE_STATE_ENUM.' end type_allowable_values = %w[DEFAULT CUSTOM] if opts[:type] && !opts[:type].empty? opts[:type].each do |val_to_check| unless type_allowable_values.include?(val_to_check) raise 'Invalid value for "type", must be one of DEFAULT, CUSTOM.' end end end if opts[:sort_by] && !%w[displayName shapeName timeCreated timeUpdated].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of displayName, shapeName, timeCreated, timeUpdated.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end path = '/configurations' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:configurationId] = opts[:configuration_id] if opts[:configuration_id] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:type] = OCI::ApiClient.build_collection_params(opts[:type], :multi) if opts[:type] && !opts[:type].empty? query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:shapeName] = opts[:shape_name] if opts[:shape_name] 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: 'MysqlaasClient#list_configurations') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Mysql::Models::ConfigurationSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_shapes(compartment_id, opts = {}) ⇒ Response
Gets a list of the shapes you can use to create a new MySQL DB System. The shape determines the resources allocated to the DB System: CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes.
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 459 460 461 462 463 464 465 466 467 468 469 |
# File 'lib/oci/mysql/mysqlaas_client.rb', line 431 def list_shapes(compartment_id, opts = {}) logger.debug 'Calling operation MysqlaasClient#list_shapes.' if logger raise "Missing the required parameter 'compartment_id' when calling list_shapes." if compartment_id.nil? path = '/shapes' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:availabilityDomain] = opts[:availability_domain] if opts[:availability_domain] query_params[:name] = opts[:name] if opts[:name] # 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: 'MysqlaasClient#list_shapes') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Mysql::Models::ShapeSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_versions(compartment_id, opts = {}) ⇒ Response
Get a list of supported and available MySQL database major versions.
The list is sorted by version family.
492 493 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 |
# File 'lib/oci/mysql/mysqlaas_client.rb', line 492 def list_versions(compartment_id, opts = {}) logger.debug 'Calling operation MysqlaasClient#list_versions.' if logger raise "Missing the required parameter 'compartment_id' when calling list_versions." if compartment_id.nil? path = '/versions' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_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] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'MysqlaasClient#list_versions') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Mysql::Models::VersionSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
101 102 103 |
# File 'lib/oci/mysql/mysqlaas_client.rb', line 101 def logger @api_client.config.logger end |
#update_configuration(configuration_id, update_configuration_details, opts = {}) ⇒ Response
Updates the Configuration details.
555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 |
# File 'lib/oci/mysql/mysqlaas_client.rb', line 555 def update_configuration(configuration_id, update_configuration_details, opts = {}) logger.debug 'Calling operation MysqlaasClient#update_configuration.' if logger raise "Missing the required parameter 'configuration_id' when calling update_configuration." if configuration_id.nil? raise "Missing the required parameter 'update_configuration_details' when calling update_configuration." if update_configuration_details.nil? raise "Parameter value for 'configuration_id' must not be blank" if OCI::Internal::Util.blank_string?(configuration_id) path = '/configurations/{configurationId}'.sub('{configurationId}', configuration_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_configuration_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'MysqlaasClient#update_configuration') 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::Mysql::Models::Configuration' ) end # rubocop:enable Metrics/BlockLength end |