Class: OCI::DatabaseManagement::DbManagementClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_management/db_management_client.rb

Overview

Use the Database Management API to perform tasks such as obtaining performance and resource usage metrics for a fleet of Managed Databases or a specific Managed Database, creating Managed Database Groups, and running a SQL job on a Managed Database or Managed Database Group.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ DbManagementClient

Creates a new DbManagementClient. 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.

Parameters:

  • config (Config) (defaults to: nil) —

    A Config object.

  • region (String) (defaults to: nil) —

    A region used to determine the service endpoint. This will usually correspond to a value in Regions::REGION_ENUM, but may be an arbitrary string.

  • endpoint (String) (defaults to: nil) —

    The fully qualified endpoint URL

  • signer (OCI::BaseSigner) (defaults to: nil) —

    A signer implementation which can be used by this client. If this is not provided then a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication, so that the instance principals signer can be provided to the client

  • proxy_settings (OCI::ApiClientProxySettings) (defaults to: nil) —

    If your environment requires you to use a proxy server for outgoing HTTP requests the details for the proxy can be provided in this parameter

  • retry_config (OCI::Retry::RetryConfig) (defaults to: nil) —

    The retry configuration for this service client. This represents the default retry configuration to apply across all operations. 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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/oci/database_management/db_management_client.rb', line 57

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 + '/20201101'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "DbManagementClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



17
18
19
 
# File 'lib/oci/database_management/db_management_client.rb', line 17

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/database_management/db_management_client.rb', line 21

def endpoint
  @endpoint
end

#region ⇒ String

The region, which will usually correspond to a value in Regions::REGION_ENUM.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/database_management/db_management_client.rb', line 31

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

Returns:



27
28
29
 
# File 'lib/oci/database_management/db_management_client.rb', line 27

def retry_config
  @retry_config
end

Instance Method Details

#add_data_files(managed_database_id, tablespace_name, add_data_files_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use add_data_files API.

Adds data files or temp files to the tablespace.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • tablespace_name (String) —

    The name of the tablespace.

  • add_data_files_details (OCI::DatabaseManagement::Models::AddDataFilesDetails) —

    The details required to add data files or temp files to the tablespace.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/oci/database_management/db_management_client.rb', line 123

def add_data_files(managed_database_id, tablespace_name, add_data_files_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#add_data_files.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling add_data_files." if managed_database_id.nil?
  raise "Missing the required parameter 'tablespace_name' when calling add_data_files." if tablespace_name.nil?
  raise "Missing the required parameter 'add_data_files_details' when calling add_data_files." if add_data_files_details.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'tablespace_name' must not be blank" if OCI::Internal::Util.blank_string?(tablespace_name)

  path = '/managedDatabases/{managedDatabaseId}/tablespaces/{tablespaceName}/actions/addDataFiles'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{tablespaceName}', tablespace_name.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]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(add_data_files_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#add_data_files') 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::DatabaseManagement::Models::TablespaceAdminStatus'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#add_managed_database_to_managed_database_group(managed_database_group_id, add_managed_database_to_managed_database_group_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use add_managed_database_to_managed_database_group API.

Adds a Managed Database to a specific Managed Database Group. After the database is added, it will be included in the management activities performed on the Managed Database Group.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



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
229
230
 
# File 'lib/oci/database_management/db_management_client.rb', line 192

def add_managed_database_to_managed_database_group(managed_database_group_id, add_managed_database_to_managed_database_group_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#add_managed_database_to_managed_database_group.' if logger

  raise "Missing the required parameter 'managed_database_group_id' when calling add_managed_database_to_managed_database_group." if managed_database_group_id.nil?
  raise "Missing the required parameter 'add_managed_database_to_managed_database_group_details' when calling add_managed_database_to_managed_database_group." if add_managed_database_to_managed_database_group_details.nil?
  raise "Parameter value for 'managed_database_group_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_group_id)

  path = '/managedDatabaseGroups/{managedDatabaseGroupId}/actions/addManagedDatabase'.sub('{managedDatabaseGroupId}', managed_database_group_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]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(add_managed_database_to_managed_database_group_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#add_managed_database_to_managed_database_group') 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

#addm_tasks(managed_database_id, time_start, time_end, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use addm_tasks API.

Lists the metadata for each ADDM task who's end snapshot time falls within the provided start and end time. Details include the name of the ADDM task, description, user, status and creation date time.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • time_start (DateTime) —

    The beginning of the time range to search for ADDM tasks as defined by date-time RFC3339 format.

  • time_end (DateTime) —

    The end of the time range to search for ADDM tasks as defined by date-time RFC3339 format.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :sort_by (String) —

    The option to sort the list of ADDM tasks. (default to END_TIME) Allowed values are: TASK_NAME, TASK_ID, DESCRIPTION, DB_USER, STATUS, TIME_CREATED, BEGIN_TIME, END_TIME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Descending order is the default order. (default to DESC)

Returns:



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/oci/database_management/db_management_client.rb', line 260

def addm_tasks(managed_database_id, time_start, time_end, opts = {})
  logger.debug 'Calling operation DbManagementClient#addm_tasks.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling addm_tasks." if managed_database_id.nil?
  raise "Missing the required parameter 'time_start' when calling addm_tasks." if time_start.nil?
  raise "Missing the required parameter 'time_end' when calling addm_tasks." if time_end.nil?

  if opts[:sort_by] && !%w[TASK_NAME TASK_ID DESCRIPTION DB_USER STATUS TIME_CREATED BEGIN_TIME END_TIME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TASK_NAME, TASK_ID, DESCRIPTION, DB_USER, STATUS, TIME_CREATED, BEGIN_TIME, END_TIME.'
  end

  if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/addmTasks'.sub('{managedDatabaseId}', managed_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:timeStart] = time_start
  query_params[:timeEnd] = time_end
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#addm_tasks') 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::DatabaseManagement::Models::AddmTasksCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_database_parameters(managed_database_id, change_database_parameters_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_database_parameters API.

Changes database parameter values. There are two kinds of database parameters:

  • Dynamic parameters: They can be changed for the current Oracle Database instance. The changes take effect immediately.

  • Static parameters: They cannot be changed for the current instance. You must change these parameters and then restart the database before changes take effect.

Note: If the instance is started using a text initialization parameter file, the parameter changes are applicable only for the current instance. You must update them manually to be passed to a future instance.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



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
 
# File 'lib/oci/database_management/db_management_client.rb', line 350

def change_database_parameters(managed_database_id, change_database_parameters_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#change_database_parameters.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling change_database_parameters." if managed_database_id.nil?
  raise "Missing the required parameter 'change_database_parameters_details' when calling change_database_parameters." if change_database_parameters_details.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/actions/changeDatabaseParameters'.sub('{managedDatabaseId}', managed_database_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]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_database_parameters_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#change_database_parameters') 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::DatabaseManagement::Models::UpdateDatabaseParametersResult'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_db_management_private_endpoint_compartment(db_management_private_endpoint_id, change_db_management_private_endpoint_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_db_management_private_endpoint_compartment API.

Moves the Database Management private endpoint and its dependent resources to the specified compartment.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



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
459
 
# File 'lib/oci/database_management/db_management_client.rb', line 420

def change_db_management_private_endpoint_compartment(db_management_private_endpoint_id, change_db_management_private_endpoint_compartment_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#change_db_management_private_endpoint_compartment.' if logger

  raise "Missing the required parameter 'db_management_private_endpoint_id' when calling change_db_management_private_endpoint_compartment." if db_management_private_endpoint_id.nil?
  raise "Missing the required parameter 'change_db_management_private_endpoint_compartment_details' when calling change_db_management_private_endpoint_compartment." if change_db_management_private_endpoint_compartment_details.nil?
  raise "Parameter value for 'db_management_private_endpoint_id' must not be blank" if OCI::Internal::Util.blank_string?(db_management_private_endpoint_id)

  path = '/dbManagementPrivateEndpoints/{dbManagementPrivateEndpointId}/actions/changeCompartment'.sub('{dbManagementPrivateEndpointId}', db_management_private_endpoint_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(change_db_management_private_endpoint_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#change_db_management_private_endpoint_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_external_db_system_compartment(external_db_system_id, change_external_db_system_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_external_db_system_compartment API.

Moves the external DB system and its related resources (excluding databases) to the specified compartment.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



491
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
529
530
 
# File 'lib/oci/database_management/db_management_client.rb', line 491

def change_external_db_system_compartment(external_db_system_id, change_external_db_system_compartment_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#change_external_db_system_compartment.' if logger

  raise "Missing the required parameter 'external_db_system_id' when calling change_external_db_system_compartment." if external_db_system_id.nil?
  raise "Missing the required parameter 'change_external_db_system_compartment_details' when calling change_external_db_system_compartment." if change_external_db_system_compartment_details.nil?
  raise "Parameter value for 'external_db_system_id' must not be blank" if OCI::Internal::Util.blank_string?(external_db_system_id)

  path = '/externalDbSystems/{externalDbSystemId}/actions/changeCompartment'.sub('{externalDbSystemId}', external_db_system_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(change_external_db_system_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#change_external_db_system_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_external_exadata_infrastructure_compartment(external_exadata_infrastructure_id, change_external_exadata_infrastructure_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_external_exadata_infrastructure_compartment API.

Moves the Exadata infrastructure and its related resources (Exadata storage server, Exadata storage server connectors and Exadata storage server grid) to the specified compartment.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
 
# File 'lib/oci/database_management/db_management_client.rb', line 562

def change_external_exadata_infrastructure_compartment(external_exadata_infrastructure_id, change_external_exadata_infrastructure_compartment_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#change_external_exadata_infrastructure_compartment.' if logger

  raise "Missing the required parameter 'external_exadata_infrastructure_id' when calling change_external_exadata_infrastructure_compartment." if external_exadata_infrastructure_id.nil?
  raise "Missing the required parameter 'change_external_exadata_infrastructure_compartment_details' when calling change_external_exadata_infrastructure_compartment." if change_external_exadata_infrastructure_compartment_details.nil?
  raise "Parameter value for 'external_exadata_infrastructure_id' must not be blank" if OCI::Internal::Util.blank_string?(external_exadata_infrastructure_id)

  path = '/externalExadataInfrastructures/{externalExadataInfrastructureId}/actions/changeCompartment'.sub('{externalExadataInfrastructureId}', external_exadata_infrastructure_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(change_external_exadata_infrastructure_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#change_external_exadata_infrastructure_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_job_compartment(job_id, change_job_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_job_compartment API.

Moves a job.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
 
# File 'lib/oci/database_management/db_management_client.rb', line 633

def change_job_compartment(job_id, change_job_compartment_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#change_job_compartment.' if logger

  raise "Missing the required parameter 'job_id' when calling change_job_compartment." if job_id.nil?
  raise "Missing the required parameter 'change_job_compartment_details' when calling change_job_compartment." if change_job_compartment_details.nil?
  raise "Parameter value for 'job_id' must not be blank" if OCI::Internal::Util.blank_string?(job_id)

  path = '/jobs/{jobId}/actions/changeCompartment'.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[:'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(change_job_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#change_job_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_managed_database_group_compartment(managed_database_group_id, change_managed_database_group_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_managed_database_group_compartment API.

Moves a Managed Database Group to a different compartment. The destination compartment must not have a Managed Database Group with the same name.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
 
# File 'lib/oci/database_management/db_management_client.rb', line 706

def change_managed_database_group_compartment(managed_database_group_id, change_managed_database_group_compartment_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#change_managed_database_group_compartment.' if logger

  raise "Missing the required parameter 'managed_database_group_id' when calling change_managed_database_group_compartment." if managed_database_group_id.nil?
  raise "Missing the required parameter 'change_managed_database_group_compartment_details' when calling change_managed_database_group_compartment." if change_managed_database_group_compartment_details.nil?
  raise "Parameter value for 'managed_database_group_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_group_id)

  path = '/managedDatabaseGroups/{managedDatabaseGroupId}/actions/changeCompartment'.sub('{managedDatabaseGroupId}', managed_database_group_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(change_managed_database_group_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#change_managed_database_group_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_plan_retention(managed_database_id, change_plan_retention_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_plan_retention API.

Changes the retention period of unused plans. The period can range between 5 and 523 weeks.

The database purges plans that have not been used for longer than the plan retention period.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



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
805
 
# File 'lib/oci/database_management/db_management_client.rb', line 769

def change_plan_retention(managed_database_id, change_plan_retention_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#change_plan_retention.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling change_plan_retention." if managed_database_id.nil?
  raise "Missing the required parameter 'change_plan_retention_details' when calling change_plan_retention." if change_plan_retention_details.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/changePlanRetention'.sub('{managedDatabaseId}', managed_database_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 = @api_client.object_to_http_body(change_plan_retention_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#change_plan_retention') 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_space_budget(managed_database_id, change_space_budget_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_space_budget API.

Changes the disk space limit for the SQL Management Base. The allowable range for this limit is between 1% and 50%.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
 
# File 'lib/oci/database_management/db_management_client.rb', line 826

def change_space_budget(managed_database_id, change_space_budget_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#change_space_budget.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling change_space_budget." if managed_database_id.nil?
  raise "Missing the required parameter 'change_space_budget_details' when calling change_space_budget." if change_space_budget_details.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/changeSpaceBudget'.sub('{managedDatabaseId}', managed_database_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 = @api_client.object_to_http_body(change_space_budget_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#change_space_budget') 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_sql_plan_baselines_attributes(managed_database_id, change_sql_plan_baselines_attributes_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_sql_plan_baselines_attributes API.

Changes one or more attributes of a single plan or all plans associated with a SQL statement.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
 
# File 'lib/oci/database_management/db_management_client.rb', line 882

def change_sql_plan_baselines_attributes(managed_database_id, change_sql_plan_baselines_attributes_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#change_sql_plan_baselines_attributes.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling change_sql_plan_baselines_attributes." if managed_database_id.nil?
  raise "Missing the required parameter 'change_sql_plan_baselines_attributes_details' when calling change_sql_plan_baselines_attributes." if change_sql_plan_baselines_attributes_details.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/changeSqlPlanBaselinesAttributes'.sub('{managedDatabaseId}', managed_database_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 = @api_client.object_to_http_body(change_sql_plan_baselines_attributes_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#change_sql_plan_baselines_attributes') 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

#check_external_db_system_connector_connection_status(external_db_system_connector_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use check_external_db_system_connector_connection_status API.

Checks the status of the external DB system component connection specified in this connector. This operation will refresh the connectionStatus and timeConnectionStatusLastUpdated fields.

Parameters:

  • external_db_system_connector_id (String) —

    The OCID of the external connector.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
 
# File 'lib/oci/database_management/db_management_client.rb', line 950

def check_external_db_system_connector_connection_status(external_db_system_connector_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#check_external_db_system_connector_connection_status.' if logger

  raise "Missing the required parameter 'external_db_system_connector_id' when calling check_external_db_system_connector_connection_status." if external_db_system_connector_id.nil?
  raise "Parameter value for 'external_db_system_connector_id' must not be blank" if OCI::Internal::Util.blank_string?(external_db_system_connector_id)

  path = '/externalDbSystemConnectors/{externalDbSystemConnectorId}/actions/checkConnectionStatus'.sub('{externalDbSystemConnectorId}', external_db_system_connector_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#check_external_db_system_connector_connection_status') 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::DatabaseManagement::Models::ExternalDbSystemConnector'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#check_external_exadata_storage_connector(external_exadata_storage_connector_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use check_external_exadata_storage_connector API.

Checks the status of the Exadata storage server connection specified by exadataStorageConnectorId.

Parameters:

  • external_exadata_storage_connector_id (String) —

    The OCID of the connector to the Exadata storage server.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
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
 
# File 'lib/oci/database_management/db_management_client.rb', line 1020

def check_external_exadata_storage_connector(external_exadata_storage_connector_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#check_external_exadata_storage_connector.' if logger

  raise "Missing the required parameter 'external_exadata_storage_connector_id' when calling check_external_exadata_storage_connector." if external_exadata_storage_connector_id.nil?
  raise "Parameter value for 'external_exadata_storage_connector_id' must not be blank" if OCI::Internal::Util.blank_string?(external_exadata_storage_connector_id)

  path = '/externalExadataStorageConnectors/{externalExadataStorageConnectorId}/actions/checkStatus'.sub('{externalExadataStorageConnectorId}', external_exadata_storage_connector_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#check_external_exadata_storage_connector') 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::DatabaseManagement::Models::ExternalExadataStorageConnectorStatus'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#configure_automatic_capture_filters(managed_database_id, configure_automatic_capture_filters_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use configure_automatic_capture_filters API.

Configures automatic capture filters to capture only those statements that match the filter criteria.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
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
 
# File 'lib/oci/database_management/db_management_client.rb', line 1080

def configure_automatic_capture_filters(managed_database_id, configure_automatic_capture_filters_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#configure_automatic_capture_filters.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling configure_automatic_capture_filters." if managed_database_id.nil?
  raise "Missing the required parameter 'configure_automatic_capture_filters_details' when calling configure_automatic_capture_filters." if configure_automatic_capture_filters_details.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/configureAutomaticCaptureFilters'.sub('{managedDatabaseId}', managed_database_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 = @api_client.object_to_http_body(configure_automatic_capture_filters_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#configure_automatic_capture_filters') 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

#configure_automatic_spm_evolve_advisor_task(managed_database_id, configure_automatic_spm_evolve_advisor_task_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use configure_automatic_spm_evolve_advisor_task API.

Configures the Automatic SPM Evolve Advisor task SYS_AUTO_SPM_EVOLVE_TASK by specifying task parameters. As the task is owned by SYS, only SYS can set task parameters.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
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
 
# File 'lib/oci/database_management/db_management_client.rb', line 1138

def configure_automatic_spm_evolve_advisor_task(managed_database_id, configure_automatic_spm_evolve_advisor_task_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#configure_automatic_spm_evolve_advisor_task.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling configure_automatic_spm_evolve_advisor_task." if managed_database_id.nil?
  raise "Missing the required parameter 'configure_automatic_spm_evolve_advisor_task_details' when calling configure_automatic_spm_evolve_advisor_task." if configure_automatic_spm_evolve_advisor_task_details.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/configureAutomaticSpmEvolveAdvisorTask'.sub('{managedDatabaseId}', managed_database_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 = @api_client.object_to_http_body(configure_automatic_spm_evolve_advisor_task_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#configure_automatic_spm_evolve_advisor_task') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_db_management_private_endpoint(create_db_management_private_endpoint_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_db_management_private_endpoint API.

Creates a new Database Management private endpoint.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1199
1200
1201
1202
1203
1204
1205
1206
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
 
# File 'lib/oci/database_management/db_management_client.rb', line 1199

def create_db_management_private_endpoint(create_db_management_private_endpoint_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#create_db_management_private_endpoint.' if logger

  raise "Missing the required parameter 'create_db_management_private_endpoint_details' when calling create_db_management_private_endpoint." if create_db_management_private_endpoint_details.nil?

  path = '/dbManagementPrivateEndpoints'
  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_db_management_private_endpoint_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#create_db_management_private_endpoint') 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::DatabaseManagement::Models::DbManagementPrivateEndpoint'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_external_db_system(create_external_db_system_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_external_db_system API.

Creates an external DB system and its related resources.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



1261
1262
1263
1264
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
 
# File 'lib/oci/database_management/db_management_client.rb', line 1261

def create_external_db_system(create_external_db_system_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#create_external_db_system.' if logger

  raise "Missing the required parameter 'create_external_db_system_details' when calling create_external_db_system." if create_external_db_system_details.nil?

  path = '/externalDbSystems'
  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_external_db_system_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#create_external_db_system') 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::DatabaseManagement::Models::ExternalDbSystem'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_external_db_system_connector(create_external_db_system_connector_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_external_db_system_connector API.

Creates a new external connector.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



1322
1323
1324
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
 
# File 'lib/oci/database_management/db_management_client.rb', line 1322

def create_external_db_system_connector(create_external_db_system_connector_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#create_external_db_system_connector.' if logger

  raise "Missing the required parameter 'create_external_db_system_connector_details' when calling create_external_db_system_connector." if create_external_db_system_connector_details.nil?

  path = '/externalDbSystemConnectors'
  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_external_db_system_connector_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#create_external_db_system_connector') 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::DatabaseManagement::Models::ExternalDbSystemConnector'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_external_db_system_discovery(create_external_db_system_discovery_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_external_db_system_discovery API.

Creates an external DB system discovery resource and initiates the discovery process.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
 
# File 'lib/oci/database_management/db_management_client.rb', line 1384

def create_external_db_system_discovery(create_external_db_system_discovery_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#create_external_db_system_discovery.' if logger

  raise "Missing the required parameter 'create_external_db_system_discovery_details' when calling create_external_db_system_discovery." if create_external_db_system_discovery_details.nil?

  path = '/externalDbSystemDiscoveries'
  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_external_db_system_discovery_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#create_external_db_system_discovery') 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::DatabaseManagement::Models::ExternalDbSystemDiscovery'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_external_exadata_infrastructure(create_external_exadata_infrastructure_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_external_exadata_infrastructure API.

Creates an OCI resource for the Exadata infrastructure and enables the Monitoring service for the Exadata infrastructure. The following resource/subresources are created: Infrastructure Storage server connectors Storage servers Storage grids

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
 
# File 'lib/oci/database_management/db_management_client.rb', line 1451

def create_external_exadata_infrastructure(create_external_exadata_infrastructure_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#create_external_exadata_infrastructure.' if logger

  raise "Missing the required parameter 'create_external_exadata_infrastructure_details' when calling create_external_exadata_infrastructure." if create_external_exadata_infrastructure_details.nil?

  path = '/externalExadataInfrastructures'
  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_external_exadata_infrastructure_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#create_external_exadata_infrastructure') 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::DatabaseManagement::Models::ExternalExadataInfrastructure'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_external_exadata_storage_connector(create_external_exadata_storage_connector_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_external_exadata_storage_connector API.

Creates the Exadata storage server connector after validating the connection information.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
 
# File 'lib/oci/database_management/db_management_client.rb', line 1513

def create_external_exadata_storage_connector(create_external_exadata_storage_connector_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#create_external_exadata_storage_connector.' if logger

  raise "Missing the required parameter 'create_external_exadata_storage_connector_details' when calling create_external_exadata_storage_connector." if create_external_exadata_storage_connector_details.nil?

  path = '/externalExadataStorageConnectors'
  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_external_exadata_storage_connector_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#create_external_exadata_storage_connector') 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::DatabaseManagement::Models::ExternalExadataStorageConnector'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_job(create_job_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_job API.

Creates a job to be executed on a Managed Database or Managed Database Group. Only one of the parameters, managedDatabaseId or managedDatabaseGroupId should be provided as input in CreateJobDetails resource in request body.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type Job



1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
 
# File 'lib/oci/database_management/db_management_client.rb', line 1577

def create_job(create_job_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#create_job.' if logger

  raise "Missing the required parameter 'create_job_details' when calling create_job." if create_job_details.nil?

  path = '/jobs'
  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_job_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#create_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::DatabaseManagement::Models::Job'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_managed_database_group(create_managed_database_group_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_managed_database_group API.

Creates a Managed Database Group. The group does not contain any Managed Databases when it is created, and they must be added later.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



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
 
# File 'lib/oci/database_management/db_management_client.rb', line 1640

def create_managed_database_group(create_managed_database_group_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#create_managed_database_group.' if logger

  raise "Missing the required parameter 'create_managed_database_group_details' when calling create_managed_database_group." if create_managed_database_group_details.nil?

  path = '/managedDatabaseGroups'
  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_managed_database_group_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#create_managed_database_group') 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::DatabaseManagement::Models::ManagedDatabaseGroup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_tablespace(managed_database_id, create_tablespace_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_tablespace API.

Creates a tablespace within the Managed Database specified by managedDatabaseId.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
 
# File 'lib/oci/database_management/db_management_client.rb', line 1703

def create_tablespace(managed_database_id, create_tablespace_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#create_tablespace.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling create_tablespace." if managed_database_id.nil?
  raise "Missing the required parameter 'create_tablespace_details' when calling create_tablespace." if create_tablespace_details.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/tablespaces'.sub('{managedDatabaseId}', managed_database_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]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_tablespace_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#create_tablespace') 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::DatabaseManagement::Models::Tablespace'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_db_management_private_endpoint(db_management_private_endpoint_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_db_management_private_endpoint API.

Deletes a specific Database Management private endpoint.

Parameters:

  • db_management_private_endpoint_id (String) —

    The OCID of the Database Management private endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
 
# File 'lib/oci/database_management/db_management_client.rb', line 1766

def delete_db_management_private_endpoint(db_management_private_endpoint_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#delete_db_management_private_endpoint.' if logger

  raise "Missing the required parameter 'db_management_private_endpoint_id' when calling delete_db_management_private_endpoint." if db_management_private_endpoint_id.nil?
  raise "Parameter value for 'db_management_private_endpoint_id' must not be blank" if OCI::Internal::Util.blank_string?(db_management_private_endpoint_id)

  path = '/dbManagementPrivateEndpoints/{dbManagementPrivateEndpointId}'.sub('{dbManagementPrivateEndpointId}', db_management_private_endpoint_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#delete_db_management_private_endpoint') 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_external_db_system(external_db_system_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_external_db_system API.

Deletes the external DB system specified by externalDbSystemId.

Parameters:

  • external_db_system_id (String) —

    The OCID of the external DB system.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/database_management/db_management_client.rb', line 1827

def delete_external_db_system(external_db_system_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#delete_external_db_system.' if logger

  raise "Missing the required parameter 'external_db_system_id' when calling delete_external_db_system." if external_db_system_id.nil?
  raise "Parameter value for 'external_db_system_id' must not be blank" if OCI::Internal::Util.blank_string?(external_db_system_id)

  path = '/externalDbSystems/{externalDbSystemId}'.sub('{externalDbSystemId}', external_db_system_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#delete_external_db_system') 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_external_db_system_connector(external_db_system_connector_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_external_db_system_connector API.

Deletes the external connector specified by externalDbSystemConnectorId.

Parameters:

  • external_db_system_connector_id (String) —

    The OCID of the external connector.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
 
# File 'lib/oci/database_management/db_management_client.rb', line 1888

def delete_external_db_system_connector(external_db_system_connector_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#delete_external_db_system_connector.' if logger

  raise "Missing the required parameter 'external_db_system_connector_id' when calling delete_external_db_system_connector." if external_db_system_connector_id.nil?
  raise "Parameter value for 'external_db_system_connector_id' must not be blank" if OCI::Internal::Util.blank_string?(external_db_system_connector_id)

  path = '/externalDbSystemConnectors/{externalDbSystemConnectorId}'.sub('{externalDbSystemConnectorId}', external_db_system_connector_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#delete_external_db_system_connector') 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_external_db_system_discovery(external_db_system_discovery_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_external_db_system_discovery API.

Deletes the external DB system discovery resource specified by externalDbSystemDiscoveryId.

Parameters:

  • external_db_system_discovery_id (String) —

    The OCID of the external DB system discovery.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
 
# File 'lib/oci/database_management/db_management_client.rb', line 1949

def delete_external_db_system_discovery(external_db_system_discovery_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#delete_external_db_system_discovery.' if logger

  raise "Missing the required parameter 'external_db_system_discovery_id' when calling delete_external_db_system_discovery." if external_db_system_discovery_id.nil?
  raise "Parameter value for 'external_db_system_discovery_id' must not be blank" if OCI::Internal::Util.blank_string?(external_db_system_discovery_id)

  path = '/externalDbSystemDiscoveries/{externalDbSystemDiscoveryId}'.sub('{externalDbSystemDiscoveryId}', external_db_system_discovery_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#delete_external_db_system_discovery') 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_external_exadata_infrastructure(external_exadata_infrastructure_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_external_exadata_infrastructure API.

Deletes the Exadata infrastructure specified by externalExadataInfrastructureId.

Parameters:

  • external_exadata_infrastructure_id (String) —

    The OCID of the Exadata infrastructure.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



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
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
 
# File 'lib/oci/database_management/db_management_client.rb', line 2010

def delete_external_exadata_infrastructure(external_exadata_infrastructure_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#delete_external_exadata_infrastructure.' if logger

  raise "Missing the required parameter 'external_exadata_infrastructure_id' when calling delete_external_exadata_infrastructure." if external_exadata_infrastructure_id.nil?
  raise "Parameter value for 'external_exadata_infrastructure_id' must not be blank" if OCI::Internal::Util.blank_string?(external_exadata_infrastructure_id)

  path = '/externalExadataInfrastructures/{externalExadataInfrastructureId}'.sub('{externalExadataInfrastructureId}', external_exadata_infrastructure_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#delete_external_exadata_infrastructure') 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_external_exadata_storage_connector(external_exadata_storage_connector_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_external_exadata_storage_connector API.

Deletes the Exadata storage server connector specified by exadataStorageConnectorId.

Parameters:

  • external_exadata_storage_connector_id (String) —

    The OCID of the connector to the Exadata storage server.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/database_management/db_management_client.rb', line 2071

def delete_external_exadata_storage_connector(external_exadata_storage_connector_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#delete_external_exadata_storage_connector.' if logger

  raise "Missing the required parameter 'external_exadata_storage_connector_id' when calling delete_external_exadata_storage_connector." if external_exadata_storage_connector_id.nil?
  raise "Parameter value for 'external_exadata_storage_connector_id' must not be blank" if OCI::Internal::Util.blank_string?(external_exadata_storage_connector_id)

  path = '/externalExadataStorageConnectors/{externalExadataStorageConnectorId}'.sub('{externalExadataStorageConnectorId}', external_exadata_storage_connector_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#delete_external_exadata_storage_connector') 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

Note:

Click here to see an example of how to use delete_job API.

Deletes the job specified by jobId.

Parameters:

  • job_id (String) —

    The identifier of the job.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
 
# File 'lib/oci/database_management/db_management_client.rb', line 2131

def delete_job(job_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#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[:'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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#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_managed_database_group(managed_database_group_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_managed_database_group API.

Deletes the Managed Database Group specified by managedDatabaseGroupId. If the group contains Managed Databases, then it cannot be deleted.

Parameters:

  • managed_database_group_id (String) —

    The OCID of the Managed Database Group.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
 
# File 'lib/oci/database_management/db_management_client.rb', line 2193

def delete_managed_database_group(managed_database_group_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#delete_managed_database_group.' if logger

  raise "Missing the required parameter 'managed_database_group_id' when calling delete_managed_database_group." if managed_database_group_id.nil?
  raise "Parameter value for 'managed_database_group_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_group_id)

  path = '/managedDatabaseGroups/{managedDatabaseGroupId}'.sub('{managedDatabaseGroupId}', managed_database_group_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#delete_managed_database_group') 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_preferred_credential(managed_database_id, credential_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_preferred_credential API.

Deletes the preferred credential based on the credentialName.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • credential_name (String) —

    The name of the preferred credential.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



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
2281
2282
2283
2284
2285
2286
 
# File 'lib/oci/database_management/db_management_client.rb', line 2249

def delete_preferred_credential(managed_database_id, credential_name, opts = {})
  logger.debug 'Calling operation DbManagementClient#delete_preferred_credential.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling delete_preferred_credential." if managed_database_id.nil?
  raise "Missing the required parameter 'credential_name' when calling delete_preferred_credential." if credential_name.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'credential_name' must not be blank" if OCI::Internal::Util.blank_string?(credential_name)

  path = '/managedDatabases/{managedDatabaseId}/preferredCredentials/{credentialName}'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{credentialName}', credential_name.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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#delete_preferred_credential') 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

#disable_automatic_initial_plan_capture(managed_database_id, disable_automatic_initial_plan_capture_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use disable_automatic_initial_plan_capture API.

Disables automatic initial plan capture.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



2306
2307
2308
2309
2310
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
 
# File 'lib/oci/database_management/db_management_client.rb', line 2306

def disable_automatic_initial_plan_capture(managed_database_id, disable_automatic_initial_plan_capture_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#disable_automatic_initial_plan_capture.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling disable_automatic_initial_plan_capture." if managed_database_id.nil?
  raise "Missing the required parameter 'disable_automatic_initial_plan_capture_details' when calling disable_automatic_initial_plan_capture." if disable_automatic_initial_plan_capture_details.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/disableAutomaticInitialPlanCapture'.sub('{managedDatabaseId}', managed_database_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 = @api_client.object_to_http_body(disable_automatic_initial_plan_capture_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#disable_automatic_initial_plan_capture') 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

#disable_automatic_spm_evolve_advisor_task(managed_database_id, disable_automatic_spm_evolve_advisor_task_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use disable_automatic_spm_evolve_advisor_task API.

Disables the Automatic SPM Evolve Advisor task.

One client controls both Automatic SQL Tuning Advisor and Automatic SPM Evolve Advisor. Thus, the same task enables or disables both.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
 
# File 'lib/oci/database_management/db_management_client.rb', line 2365

def disable_automatic_spm_evolve_advisor_task(managed_database_id, disable_automatic_spm_evolve_advisor_task_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#disable_automatic_spm_evolve_advisor_task.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling disable_automatic_spm_evolve_advisor_task." if managed_database_id.nil?
  raise "Missing the required parameter 'disable_automatic_spm_evolve_advisor_task_details' when calling disable_automatic_spm_evolve_advisor_task." if disable_automatic_spm_evolve_advisor_task_details.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/disableAutomaticSpmEvolveAdvisorTask'.sub('{managedDatabaseId}', managed_database_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 = @api_client.object_to_http_body(disable_automatic_spm_evolve_advisor_task_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#disable_automatic_spm_evolve_advisor_task') 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

#disable_external_db_system_database_management(external_db_system_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use disable_external_db_system_database_management API.

Disables Database Management service for all the components of the specified external DB system (except databases).

Parameters:

  • external_db_system_id (String) —

    The OCID of the external DB system.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
 
# File 'lib/oci/database_management/db_management_client.rb', line 2433

def disable_external_db_system_database_management(external_db_system_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#disable_external_db_system_database_management.' if logger

  raise "Missing the required parameter 'external_db_system_id' when calling disable_external_db_system_database_management." if external_db_system_id.nil?
  raise "Parameter value for 'external_db_system_id' must not be blank" if OCI::Internal::Util.blank_string?(external_db_system_id)

  path = '/externalDbSystems/{externalDbSystemId}/actions/disableDatabaseManagement'.sub('{externalDbSystemId}', external_db_system_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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#disable_external_db_system_database_management') 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

#disable_external_db_system_stack_monitoring(external_db_system_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use disable_external_db_system_stack_monitoring API.

Disables Stack Monitoring for all the components of the specified external DB system (except databases).

Parameters:

  • external_db_system_id (String) —

    The OCID of the external DB system.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



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
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
 
# File 'lib/oci/database_management/db_management_client.rb', line 2503

def disable_external_db_system_stack_monitoring(external_db_system_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#disable_external_db_system_stack_monitoring.' if logger

  raise "Missing the required parameter 'external_db_system_id' when calling disable_external_db_system_stack_monitoring." if external_db_system_id.nil?
  raise "Parameter value for 'external_db_system_id' must not be blank" if OCI::Internal::Util.blank_string?(external_db_system_id)

  path = '/externalDbSystems/{externalDbSystemId}/actions/disableStackMonitoring'.sub('{externalDbSystemId}', external_db_system_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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#disable_external_db_system_stack_monitoring') 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

#disable_external_exadata_infrastructure_management(external_exadata_infrastructure_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use disable_external_exadata_infrastructure_management API.

Disables Database Management for the Exadata infrastructure specified by externalExadataInfrastructureId. It covers the following components:

  • Exadata infrastructure

  • Exadata storage grid

  • Exadata storage server

Note that Database Management will not be disabled for the DB systems within the Exadata infrastructure and should be disabled explicitly, if required.

Parameters:

  • external_exadata_infrastructure_id (String) —

    The OCID of the Exadata infrastructure.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
 
# File 'lib/oci/database_management/db_management_client.rb', line 2579

def disable_external_exadata_infrastructure_management(external_exadata_infrastructure_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#disable_external_exadata_infrastructure_management.' if logger

  raise "Missing the required parameter 'external_exadata_infrastructure_id' when calling disable_external_exadata_infrastructure_management." if external_exadata_infrastructure_id.nil?
  raise "Parameter value for 'external_exadata_infrastructure_id' must not be blank" if OCI::Internal::Util.blank_string?(external_exadata_infrastructure_id)

  path = '/externalExadataInfrastructures/{externalExadataInfrastructureId}/actions/disableDatabaseManagement'.sub('{externalExadataInfrastructureId}', external_exadata_infrastructure_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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#disable_external_exadata_infrastructure_management') 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

#disable_high_frequency_automatic_spm_evolve_advisor_task(managed_database_id, disable_high_frequency_automatic_spm_evolve_advisor_task_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use disable_high_frequency_automatic_spm_evolve_advisor_task API.

Disables the high-frequency Automatic SPM Evolve Advisor task.

It is available only on Oracle Exadata Database Machine, Oracle Database Exadata Cloud Service (ExaCS) and Oracle Database Exadata Cloud@Customer (ExaCC).

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



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
2670
2671
2672
2673
2674
2675
2676
 
# File 'lib/oci/database_management/db_management_client.rb', line 2640

def disable_high_frequency_automatic_spm_evolve_advisor_task(managed_database_id, disable_high_frequency_automatic_spm_evolve_advisor_task_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#disable_high_frequency_automatic_spm_evolve_advisor_task.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling disable_high_frequency_automatic_spm_evolve_advisor_task." if managed_database_id.nil?
  raise "Missing the required parameter 'disable_high_frequency_automatic_spm_evolve_advisor_task_details' when calling disable_high_frequency_automatic_spm_evolve_advisor_task." if disable_high_frequency_automatic_spm_evolve_advisor_task_details.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/disableHighFrequencyAutomaticSpmEvolveAdvisorTask'.sub('{managedDatabaseId}', managed_database_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 = @api_client.object_to_http_body(disable_high_frequency_automatic_spm_evolve_advisor_task_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#disable_high_frequency_automatic_spm_evolve_advisor_task') 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

#disable_sql_plan_baselines_usage(managed_database_id, disable_sql_plan_baselines_usage_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use disable_sql_plan_baselines_usage API.

Disables the use of SQL plan baselines stored in SQL Management Base.

When disabled, the optimizer does not use any SQL plan baselines.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



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
2728
2729
2730
2731
2732
2733
2734
 
# File 'lib/oci/database_management/db_management_client.rb', line 2698

def disable_sql_plan_baselines_usage(managed_database_id, disable_sql_plan_baselines_usage_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#disable_sql_plan_baselines_usage.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling disable_sql_plan_baselines_usage." if managed_database_id.nil?
  raise "Missing the required parameter 'disable_sql_plan_baselines_usage_details' when calling disable_sql_plan_baselines_usage." if disable_sql_plan_baselines_usage_details.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/disableSqlPlanBaselinesUsage'.sub('{managedDatabaseId}', managed_database_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 = @api_client.object_to_http_body(disable_sql_plan_baselines_usage_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#disable_sql_plan_baselines_usage') 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

#discover_external_exadata_infrastructure(discover_external_exadata_infrastructure_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use discover_external_exadata_infrastructure API.

Completes the Exadata system prechecking on the following:

  • Verifies if the DB systems are valid RAC DB systems or return 400 status code with NON_RAC_DATABASE_SYSTEM error code.

  • Verifies if the ASM connector defined for each DB system or return 400 status code with CONNECTOR_NOT_DEFINED error code.

  • Verifies if the agents associated with ASM are valid and could be used for the Exadata storage servers or return 400 status code with INVALID_AGENT error code.

  • Verifies if it is an Exadata system or return 400 status code with INVALID_EXADATA_SYSTEM error code.

Starts the discovery process for the Exadata system infrastructure. The following resources/components are discovered

  • Exadata storage servers from each DB systems

  • Exadata storage grid for all Exadata storage servers

  • Exadata infrastructure

The same API covers both new discovery and rediscovery cases. For the new discovery case, new managed resources/sub-resources are created or the existing ones are overridden. For rediscovery case, the existing managed resources/sub-resources are checked to find out which ones should be added or which ones should be removed based on the unique key defined for each resource/sub-resource.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
 
# File 'lib/oci/database_management/db_management_client.rb', line 2783

def discover_external_exadata_infrastructure(discover_external_exadata_infrastructure_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#discover_external_exadata_infrastructure.' if logger

  raise "Missing the required parameter 'discover_external_exadata_infrastructure_details' when calling discover_external_exadata_infrastructure." if discover_external_exadata_infrastructure_details.nil?

  path = '/externalExadataInfrastructures/actions/discoverExadataInfrastructure'
  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(discover_external_exadata_infrastructure_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#discover_external_exadata_infrastructure') 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::DatabaseManagement::Models::ExternalExadataInfrastructureDiscovery'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#drop_sql_plan_baselines(managed_database_id, drop_sql_plan_baselines_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use drop_sql_plan_baselines API.

Drops a single plan or all plans associated with a SQL statement.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/database_management/db_management_client.rb', line 2841

def drop_sql_plan_baselines(managed_database_id, drop_sql_plan_baselines_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#drop_sql_plan_baselines.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling drop_sql_plan_baselines." if managed_database_id.nil?
  raise "Missing the required parameter 'drop_sql_plan_baselines_details' when calling drop_sql_plan_baselines." if drop_sql_plan_baselines_details.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/dropSqlPlanBaselines'.sub('{managedDatabaseId}', managed_database_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 = @api_client.object_to_http_body(drop_sql_plan_baselines_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#drop_sql_plan_baselines') 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

#drop_tablespace(managed_database_id, tablespace_name, drop_tablespace_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use drop_tablespace API.

Drops the tablespace specified by tablespaceName within the Managed Database specified by managedDatabaseId.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • tablespace_name (String) —

    The name of the tablespace.

  • drop_tablespace_details (OCI::DatabaseManagement::Models::DropTablespaceDetails) —

    The details required to drop a tablespace.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



2904
2905
2906
2907
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_management/db_management_client.rb', line 2904

def drop_tablespace(managed_database_id, tablespace_name, drop_tablespace_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#drop_tablespace.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling drop_tablespace." if managed_database_id.nil?
  raise "Missing the required parameter 'tablespace_name' when calling drop_tablespace." if tablespace_name.nil?
  raise "Missing the required parameter 'drop_tablespace_details' when calling drop_tablespace." if drop_tablespace_details.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'tablespace_name' must not be blank" if OCI::Internal::Util.blank_string?(tablespace_name)

  path = '/managedDatabases/{managedDatabaseId}/tablespaces/{tablespaceName}/actions/dropTablespace'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{tablespaceName}', tablespace_name.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]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(drop_tablespace_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#drop_tablespace') 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::DatabaseManagement::Models::TablespaceAdminStatus'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#enable_automatic_initial_plan_capture(managed_database_id, enable_automatic_initial_plan_capture_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use enable_automatic_initial_plan_capture API.

Enables automatic initial plan capture. When enabled, the database checks whether executed SQL statements are eligible for automatic capture. It creates initial plan baselines for eligible statements.

By default, the database creates a SQL plan baseline for every eligible repeatable statement, including all recursive SQL and monitoring SQL. Thus, automatic capture may result in the creation of an extremely large number of plan baselines. To limit the statements that are eligible for plan baselines, configure filters.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



2972
2973
2974
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
 
# File 'lib/oci/database_management/db_management_client.rb', line 2972

def enable_automatic_initial_plan_capture(managed_database_id, enable_automatic_initial_plan_capture_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#enable_automatic_initial_plan_capture.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling enable_automatic_initial_plan_capture." if managed_database_id.nil?
  raise "Missing the required parameter 'enable_automatic_initial_plan_capture_details' when calling enable_automatic_initial_plan_capture." if enable_automatic_initial_plan_capture_details.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/enableAutomaticInitialPlanCapture'.sub('{managedDatabaseId}', managed_database_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 = @api_client.object_to_http_body(enable_automatic_initial_plan_capture_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#enable_automatic_initial_plan_capture') 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

#enable_automatic_spm_evolve_advisor_task(managed_database_id, enable_automatic_spm_evolve_advisor_task_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use enable_automatic_spm_evolve_advisor_task API.

Enables the Automatic SPM Evolve Advisor task. By default, the automatic task SYS_AUTO_SPM_EVOLVE_TASK runs every day in the scheduled maintenance window.

The SPM Evolve Advisor performs the following tasks:

  • Checks AWR for top SQL

  • Looks for alternative plans in all available sources

  • Adds unaccepted plans to the plan history

  • Tests the execution of as many plans as possible during the maintenance window

  • Adds the alternative plan to the baseline if it performs better than the current plan

One client controls both Automatic SQL Tuning Advisor and Automatic SPM Evolve Advisor. Thus, the same task enables or disables both.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



3040
3041
3042
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
 
# File 'lib/oci/database_management/db_management_client.rb', line 3040

def enable_automatic_spm_evolve_advisor_task(managed_database_id, enable_automatic_spm_evolve_advisor_task_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#enable_automatic_spm_evolve_advisor_task.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling enable_automatic_spm_evolve_advisor_task." if managed_database_id.nil?
  raise "Missing the required parameter 'enable_automatic_spm_evolve_advisor_task_details' when calling enable_automatic_spm_evolve_advisor_task." if enable_automatic_spm_evolve_advisor_task_details.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/enableAutomaticSpmEvolveAdvisorTask'.sub('{managedDatabaseId}', managed_database_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 = @api_client.object_to_http_body(enable_automatic_spm_evolve_advisor_task_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#enable_automatic_spm_evolve_advisor_task') 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

#enable_external_db_system_database_management(external_db_system_id, enable_external_db_system_database_management_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use enable_external_db_system_database_management API.

Enables Database Management service for all the components of the specified external DB system (except databases).

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
 
# File 'lib/oci/database_management/db_management_client.rb', line 3109

def enable_external_db_system_database_management(external_db_system_id, enable_external_db_system_database_management_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#enable_external_db_system_database_management.' if logger

  raise "Missing the required parameter 'external_db_system_id' when calling enable_external_db_system_database_management." if external_db_system_id.nil?
  raise "Missing the required parameter 'enable_external_db_system_database_management_details' when calling enable_external_db_system_database_management." if enable_external_db_system_database_management_details.nil?
  raise "Parameter value for 'external_db_system_id' must not be blank" if OCI::Internal::Util.blank_string?(external_db_system_id)

  path = '/externalDbSystems/{externalDbSystemId}/actions/enableDatabaseManagement'.sub('{externalDbSystemId}', external_db_system_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(enable_external_db_system_database_management_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#enable_external_db_system_database_management') 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

#enable_external_db_system_stack_monitoring(external_db_system_id, enable_external_db_system_stack_monitoring_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use enable_external_db_system_stack_monitoring API.

Enables Stack Monitoring for all the components of the specified external DB system (except databases).

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
 
# File 'lib/oci/database_management/db_management_client.rb', line 3181

def enable_external_db_system_stack_monitoring(external_db_system_id, enable_external_db_system_stack_monitoring_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#enable_external_db_system_stack_monitoring.' if logger

  raise "Missing the required parameter 'external_db_system_id' when calling enable_external_db_system_stack_monitoring." if external_db_system_id.nil?
  raise "Missing the required parameter 'enable_external_db_system_stack_monitoring_details' when calling enable_external_db_system_stack_monitoring." if enable_external_db_system_stack_monitoring_details.nil?
  raise "Parameter value for 'external_db_system_id' must not be blank" if OCI::Internal::Util.blank_string?(external_db_system_id)

  path = '/externalDbSystems/{externalDbSystemId}/actions/enableStackMonitoring'.sub('{externalDbSystemId}', external_db_system_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(enable_external_db_system_stack_monitoring_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#enable_external_db_system_stack_monitoring') 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

#enable_external_exadata_infrastructure_management(external_exadata_infrastructure_id, enable_external_exadata_infrastructure_management_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use enable_external_exadata_infrastructure_management API.

Enables Database Management for the Exadata infrastructure specified by externalExadataInfrastructureId. It covers the following components:

  • Exadata infrastructure

  • Exadata storage grid

  • Exadata storage server

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
 
# File 'lib/oci/database_management/db_management_client.rb', line 3257

def enable_external_exadata_infrastructure_management(external_exadata_infrastructure_id, enable_external_exadata_infrastructure_management_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#enable_external_exadata_infrastructure_management.' if logger

  raise "Missing the required parameter 'external_exadata_infrastructure_id' when calling enable_external_exadata_infrastructure_management." if external_exadata_infrastructure_id.nil?
  raise "Missing the required parameter 'enable_external_exadata_infrastructure_management_details' when calling enable_external_exadata_infrastructure_management." if enable_external_exadata_infrastructure_management_details.nil?
  raise "Parameter value for 'external_exadata_infrastructure_id' must not be blank" if OCI::Internal::Util.blank_string?(external_exadata_infrastructure_id)

  path = '/externalExadataInfrastructures/{externalExadataInfrastructureId}/actions/enableDatabaseManagement'.sub('{externalExadataInfrastructureId}', external_exadata_infrastructure_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(enable_external_exadata_infrastructure_management_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#enable_external_exadata_infrastructure_management') 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

#enable_high_frequency_automatic_spm_evolve_advisor_task(managed_database_id, enable_high_frequency_automatic_spm_evolve_advisor_task_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use enable_high_frequency_automatic_spm_evolve_advisor_task API.

Enables the high-frequency Automatic SPM Evolve Advisor task. The high-frequency task runs every hour and runs for no longer than 30 minutes. These settings are not configurable.

The high-frequency task complements the standard Automatic SPM Evolve Advisor task. They are independent and are scheduled through two different frameworks.

It is available only on Oracle Exadata Database Machine, Oracle Database Exadata Cloud Service (ExaCS) and Oracle Database Exadata Cloud@Customer (ExaCC).

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
 
# File 'lib/oci/database_management/db_management_client.rb', line 3324

def enable_high_frequency_automatic_spm_evolve_advisor_task(managed_database_id, enable_high_frequency_automatic_spm_evolve_advisor_task_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#enable_high_frequency_automatic_spm_evolve_advisor_task.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling enable_high_frequency_automatic_spm_evolve_advisor_task." if managed_database_id.nil?
  raise "Missing the required parameter 'enable_high_frequency_automatic_spm_evolve_advisor_task_details' when calling enable_high_frequency_automatic_spm_evolve_advisor_task." if enable_high_frequency_automatic_spm_evolve_advisor_task_details.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/enableHighFrequencyAutomaticSpmEvolveAdvisorTask'.sub('{managedDatabaseId}', managed_database_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 = @api_client.object_to_http_body(enable_high_frequency_automatic_spm_evolve_advisor_task_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#enable_high_frequency_automatic_spm_evolve_advisor_task') 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

#enable_sql_plan_baselines_usage(managed_database_id, enable_sql_plan_baselines_usage_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use enable_sql_plan_baselines_usage API.

Enables the use of SQL plan baselines stored in SQL Management Base.

When enabled, the optimizer uses SQL plan baselines to select plans to avoid potential performance regressions.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
 
# File 'lib/oci/database_management/db_management_client.rb', line 3383

def enable_sql_plan_baselines_usage(managed_database_id, enable_sql_plan_baselines_usage_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#enable_sql_plan_baselines_usage.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling enable_sql_plan_baselines_usage." if managed_database_id.nil?
  raise "Missing the required parameter 'enable_sql_plan_baselines_usage_details' when calling enable_sql_plan_baselines_usage." if enable_sql_plan_baselines_usage_details.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/enableSqlPlanBaselinesUsage'.sub('{managedDatabaseId}', managed_database_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 = @api_client.object_to_http_body(enable_sql_plan_baselines_usage_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#enable_sql_plan_baselines_usage') 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

#generate_awr_snapshot(managed_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use generate_awr_snapshot API.

Creates an AWR snapshot for the target database.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
 
# File 'lib/oci/database_management/db_management_client.rb', line 3445

def generate_awr_snapshot(managed_database_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#generate_awr_snapshot.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling generate_awr_snapshot." if managed_database_id.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/actions/generateAwrSnapshot'.sub('{managedDatabaseId}', managed_database_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]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#generate_awr_snapshot') 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::DatabaseManagement::Models::SnapshotDetails'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_awr_db_report(managed_database_id, awr_db_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_awr_db_report API.

Gets the AWR report for the specific database.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • awr_db_id (String) —

    The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/managedDatabaseId/awrDbs

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :inst_nums (Array<Integer>) —

    The optional multiple value query parameter to filter the database instance numbers.

  • :begin_sn_id_greater_than_or_equal_to (Integer) —

    The optional greater than or equal to filter on the snapshot ID.

  • :end_sn_id_less_than_or_equal_to (Integer) —

    The optional less than or equal to query parameter to filter the snapshot ID.

  • :time_greater_than_or_equal_to (DateTime) —

    The optional greater than or equal to query parameter to filter the timestamp.

  • :time_less_than_or_equal_to (DateTime) —

    The optional less than or equal to query parameter to filter the timestamp.

  • :report_type (String) —

    The query parameter to filter the AWR report types. (default to AWR) Allowed values are: AWR, ASH

  • :container_id (Integer) —

    The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/managedDatabaseId/awrDbSnapshotRanges

  • :report_format (String) —

    The format of the AWR report. (default to HTML) Allowed values are: HTML, TEXT

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
 
# File 'lib/oci/database_management/db_management_client.rb', line 3525

def get_awr_db_report(managed_database_id, awr_db_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_awr_db_report.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling get_awr_db_report." if managed_database_id.nil?
  raise "Missing the required parameter 'awr_db_id' when calling get_awr_db_report." if awr_db_id.nil?

  if opts[:report_type] && !%w[AWR ASH].include?(opts[:report_type])
    raise 'Invalid value for "report_type", must be one of AWR, ASH.'
  end

  if opts[:report_format] && !%w[HTML TEXT].include?(opts[:report_format])
    raise 'Invalid value for "report_format", must be one of HTML, TEXT.'
  end
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'awr_db_id' must not be blank" if OCI::Internal::Util.blank_string?(awr_db_id)

  path = '/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbReport'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{awrDbId}', awr_db_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:instNums] = OCI::ApiClient.build_collection_params(opts[:inst_nums], :csv) if opts[:inst_nums] && !opts[:inst_nums].empty?
  query_params[:beginSnIdGreaterThanOrEqualTo] = opts[:begin_sn_id_greater_than_or_equal_to] if opts[:begin_sn_id_greater_than_or_equal_to]
  query_params[:endSnIdLessThanOrEqualTo] = opts[:end_sn_id_less_than_or_equal_to] if opts[:end_sn_id_less_than_or_equal_to]
  query_params[:timeGreaterThanOrEqualTo] = opts[:time_greater_than_or_equal_to] if opts[:time_greater_than_or_equal_to]
  query_params[:timeLessThanOrEqualTo] = opts[:time_less_than_or_equal_to] if opts[:time_less_than_or_equal_to]
  query_params[:reportType] = opts[:report_type] if opts[:report_type]
  query_params[:containerId] = opts[:container_id] if opts[:container_id]
  query_params[:reportFormat] = opts[:report_format] if opts[:report_format]

  # 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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_awr_db_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::DatabaseManagement::Models::AwrDbReport'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_awr_db_sql_report(managed_database_id, awr_db_id, sql_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_awr_db_sql_report API.

Gets the SQL health check report for one SQL of the specific database.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • awr_db_id (String) —

    The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/managedDatabaseId/awrDbs

  • sql_id (String) —

    The parameter to filter SQL by ID. Note that the SQL ID is generated internally by Oracle for each SQL statement and can be retrieved from AWR Report API (/managedDatabases/managedDatabaseId/awrDbs/awrDbId/awrDbReport) or Performance Hub API (/internal/managedDatabases/managedDatabaseId/actions/retrievePerformanceData)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :inst_num (String) —

    The optional single value query parameter to filter the database instance number.

  • :begin_sn_id_greater_than_or_equal_to (Integer) —

    The optional greater than or equal to filter on the snapshot ID.

  • :end_sn_id_less_than_or_equal_to (Integer) —

    The optional less than or equal to query parameter to filter the snapshot ID.

  • :time_greater_than_or_equal_to (DateTime) —

    The optional greater than or equal to query parameter to filter the timestamp.

  • :time_less_than_or_equal_to (DateTime) —

    The optional less than or equal to query parameter to filter the timestamp.

  • :report_format (String) —

    The format of the AWR report. (default to HTML) Allowed values are: HTML, TEXT

  • :container_id (Integer) —

    The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/managedDatabaseId/awrDbSnapshotRanges

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
 
# File 'lib/oci/database_management/db_management_client.rb', line 3623

def get_awr_db_sql_report(managed_database_id, awr_db_id, sql_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_awr_db_sql_report.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling get_awr_db_sql_report." if managed_database_id.nil?
  raise "Missing the required parameter 'awr_db_id' when calling get_awr_db_sql_report." if awr_db_id.nil?
  raise "Missing the required parameter 'sql_id' when calling get_awr_db_sql_report." if sql_id.nil?

  if opts[:report_format] && !%w[HTML TEXT].include?(opts[:report_format])
    raise 'Invalid value for "report_format", must be one of HTML, TEXT.'
  end
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'awr_db_id' must not be blank" if OCI::Internal::Util.blank_string?(awr_db_id)

  path = '/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbSqlReport'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{awrDbId}', awr_db_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:sqlId] = sql_id
  query_params[:instNum] = opts[:inst_num] if opts[:inst_num]
  query_params[:beginSnIdGreaterThanOrEqualTo] = opts[:begin_sn_id_greater_than_or_equal_to] if opts[:begin_sn_id_greater_than_or_equal_to]
  query_params[:endSnIdLessThanOrEqualTo] = opts[:end_sn_id_less_than_or_equal_to] if opts[:end_sn_id_less_than_or_equal_to]
  query_params[:timeGreaterThanOrEqualTo] = opts[:time_greater_than_or_equal_to] if opts[:time_greater_than_or_equal_to]
  query_params[:timeLessThanOrEqualTo] = opts[:time_less_than_or_equal_to] if opts[:time_less_than_or_equal_to]
  query_params[:reportFormat] = opts[:report_format] if opts[:report_format]
  query_params[:containerId] = opts[:container_id] if opts[:container_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_awr_db_sql_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::DatabaseManagement::Models::AwrDbSqlReport'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_cluster_cache_metric(managed_database_id, start_time, end_time, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_cluster_cache_metric API.

Gets the metrics related to cluster cache for the Oracle Real Application Clusters (Oracle RAC) database specified by managedDatabaseId.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • start_time (String) —

    The start time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'".

  • end_time (String) —

    The end time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'".

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
 
# File 'lib/oci/database_management/db_management_client.rb', line 3703

def get_cluster_cache_metric(managed_database_id, start_time, end_time, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_cluster_cache_metric.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling get_cluster_cache_metric." if managed_database_id.nil?
  raise "Missing the required parameter 'start_time' when calling get_cluster_cache_metric." if start_time.nil?
  raise "Missing the required parameter 'end_time' when calling get_cluster_cache_metric." if end_time.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/clusterCacheMetrics'.sub('{managedDatabaseId}', managed_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:startTime] = start_time
  query_params[:endTime] = end_time

  # 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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_cluster_cache_metric') 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::DatabaseManagement::Models::ClusterCacheMetric'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_database_fleet_health_metrics(compare_baseline_time, compare_target_time, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_database_fleet_health_metrics API.

Gets the health metrics for a fleet of databases in a compartment or in a Managed Database Group. Either the CompartmentId or the ManagedDatabaseGroupId query parameters must be provided to retrieve the health metrics.

Parameters:

  • compare_baseline_time (String) —

    The baseline time for metrics comparison.

  • compare_target_time (String) —

    The target time for metrics comparison.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :managed_database_group_id (String) —

    The OCID of the Managed Database Group.

  • :compartment_id (String) —

    The OCID of the compartment.

  • :compare_type (String) —

    The time window used for metrics comparison.

  • :filter_by_metric_names (String) —

    The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics.

  • :filter_by_database_type (String) —

    The filter used to filter the databases in the fleet by a specific Oracle Database type.

  • :filter_by_database_sub_type (String) —

    The filter used to filter the databases in the fleet by a specific Oracle Database subtype.

  • :filter_by_database_deployment_type (String) —

    The filter used to filter the databases in the fleet by a specific Oracle Database deployment type.

  • :filter_by_database_version (String) —

    The filter used to filter the databases in the fleet by a specific Oracle Database version.

Returns:



3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
 
# File 'lib/oci/database_management/db_management_client.rb', line 3772

def get_database_fleet_health_metrics(compare_baseline_time, compare_target_time, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_database_fleet_health_metrics.' if logger

  raise "Missing the required parameter 'compare_baseline_time' when calling get_database_fleet_health_metrics." if compare_baseline_time.nil?
  raise "Missing the required parameter 'compare_target_time' when calling get_database_fleet_health_metrics." if compare_target_time.nil?

  if opts[:compare_type] && !OCI::DatabaseManagement::Models::COMPARE_TYPE_ENUM.include?(opts[:compare_type])
    raise 'Invalid value for "compare_type", must be one of the values in OCI::DatabaseManagement::Models::COMPARE_TYPE_ENUM.'
  end

  path = '/fleetMetrics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compareBaselineTime] = compare_baseline_time
  query_params[:compareTargetTime] = compare_target_time
  query_params[:managedDatabaseGroupId] = opts[:managed_database_group_id] if opts[:managed_database_group_id]
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:compareType] = opts[:compare_type] if opts[:compare_type]
  query_params[:filterByMetricNames] = opts[:filter_by_metric_names] if opts[:filter_by_metric_names]
  query_params[:filterByDatabaseType] = opts[:filter_by_database_type] if opts[:filter_by_database_type]
  query_params[:filterByDatabaseSubType] = opts[:filter_by_database_sub_type] if opts[:filter_by_database_sub_type]
  query_params[:filterByDatabaseDeploymentType] = opts[:filter_by_database_deployment_type] if opts[:filter_by_database_deployment_type]
  query_params[:filterByDatabaseVersion] = opts[:filter_by_database_version] if opts[:filter_by_database_version]

  # 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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_database_fleet_health_metrics') 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::DatabaseManagement::Models::DatabaseFleetHealthMetrics'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_database_home_metrics(managed_database_id, start_time, end_time, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_database_home_metrics API.

Gets a summary of the activity and resource usage metrics like DB Time, CPU, User I/O, Wait, Storage, and Memory for a Managed Database.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • start_time (String) —

    The start time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'".

  • end_time (String) —

    The end time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'".

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
 
# File 'lib/oci/database_management/db_management_client.rb', line 3846

def get_database_home_metrics(managed_database_id, start_time, end_time, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_database_home_metrics.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling get_database_home_metrics." if managed_database_id.nil?
  raise "Missing the required parameter 'start_time' when calling get_database_home_metrics." if start_time.nil?
  raise "Missing the required parameter 'end_time' when calling get_database_home_metrics." if end_time.nil?

  path = '/databaseHomeMetrics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:managedDatabaseId] = managed_database_id
  query_params[:startTime] = start_time
  query_params[:endTime] = end_time

  # 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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_database_home_metrics') 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::DatabaseManagement::Models::DatabaseHomeMetrics'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_db_management_private_endpoint(db_management_private_endpoint_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_db_management_private_endpoint API.

Gets the details of a specific Database Management private endpoint.

Parameters:

  • db_management_private_endpoint_id (String) —

    The OCID of the Database Management private endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
 
# File 'lib/oci/database_management/db_management_client.rb', line 3904

def get_db_management_private_endpoint(db_management_private_endpoint_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_db_management_private_endpoint.' if logger

  raise "Missing the required parameter 'db_management_private_endpoint_id' when calling get_db_management_private_endpoint." if db_management_private_endpoint_id.nil?
  raise "Parameter value for 'db_management_private_endpoint_id' must not be blank" if OCI::Internal::Util.blank_string?(db_management_private_endpoint_id)

  path = '/dbManagementPrivateEndpoints/{dbManagementPrivateEndpointId}'.sub('{dbManagementPrivateEndpointId}', db_management_private_endpoint_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_db_management_private_endpoint') 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::DatabaseManagement::Models::DbManagementPrivateEndpoint'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_external_asm(external_asm_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_external_asm API.

Gets the details for the external ASM specified by externalAsmId.

Parameters:

  • external_asm_id (String) —

    The OCID of the external ASM.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
 
# File 'lib/oci/database_management/db_management_client.rb', line 3959

def get_external_asm(external_asm_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_external_asm.' if logger

  raise "Missing the required parameter 'external_asm_id' when calling get_external_asm." if external_asm_id.nil?
  raise "Parameter value for 'external_asm_id' must not be blank" if OCI::Internal::Util.blank_string?(external_asm_id)

  path = '/externalAsms/{externalAsmId}'.sub('{externalAsmId}', external_asm_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_external_asm') 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::DatabaseManagement::Models::ExternalAsm'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_external_asm_configuration(external_asm_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_external_asm_configuration API.

Gets configuration details including disk groups for the external ASM specified by externalAsmId.

Parameters:

  • external_asm_id (String) —

    The OCID of the external ASM.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
 
# File 'lib/oci/database_management/db_management_client.rb', line 4014

def get_external_asm_configuration(external_asm_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_external_asm_configuration.' if logger

  raise "Missing the required parameter 'external_asm_id' when calling get_external_asm_configuration." if external_asm_id.nil?
  raise "Parameter value for 'external_asm_id' must not be blank" if OCI::Internal::Util.blank_string?(external_asm_id)

  path = '/externalAsms/{externalAsmId}/configuration'.sub('{externalAsmId}', external_asm_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_external_asm_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::DatabaseManagement::Models::ExternalAsmConfiguration'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_external_asm_instance(external_asm_instance_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_external_asm_instance API.

Gets the details for the external ASM instance specified by externalAsmInstanceId.

Parameters:

  • external_asm_instance_id (String) —

    The OCID of the external ASM instance.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
 
# File 'lib/oci/database_management/db_management_client.rb', line 4069

def get_external_asm_instance(external_asm_instance_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_external_asm_instance.' if logger

  raise "Missing the required parameter 'external_asm_instance_id' when calling get_external_asm_instance." if external_asm_instance_id.nil?
  raise "Parameter value for 'external_asm_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(external_asm_instance_id)

  path = '/externalAsmInstances/{externalAsmInstanceId}'.sub('{externalAsmInstanceId}', external_asm_instance_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_external_asm_instance') 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::DatabaseManagement::Models::ExternalAsmInstance'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_external_cluster(external_cluster_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_external_cluster API.

Gets the details for the external cluster specified by externalClusterId.

Parameters:

  • external_cluster_id (String) —

    The OCID of the external cluster.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
 
# File 'lib/oci/database_management/db_management_client.rb', line 4124

def get_external_cluster(external_cluster_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_external_cluster.' if logger

  raise "Missing the required parameter 'external_cluster_id' when calling get_external_cluster." if external_cluster_id.nil?
  raise "Parameter value for 'external_cluster_id' must not be blank" if OCI::Internal::Util.blank_string?(external_cluster_id)

  path = '/externalClusters/{externalClusterId}'.sub('{externalClusterId}', external_cluster_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_external_cluster') 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::DatabaseManagement::Models::ExternalCluster'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_external_cluster_instance(external_cluster_instance_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_external_cluster_instance API.

Gets the details for the external cluster instance specified by externalClusterInstanceId.

Parameters:

  • external_cluster_instance_id (String) —

    The OCID of the external cluster instance.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
 
# File 'lib/oci/database_management/db_management_client.rb', line 4179

def get_external_cluster_instance(external_cluster_instance_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_external_cluster_instance.' if logger

  raise "Missing the required parameter 'external_cluster_instance_id' when calling get_external_cluster_instance." if external_cluster_instance_id.nil?
  raise "Parameter value for 'external_cluster_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(external_cluster_instance_id)

  path = '/externalClusterInstances/{externalClusterInstanceId}'.sub('{externalClusterInstanceId}', external_cluster_instance_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_external_cluster_instance') 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::DatabaseManagement::Models::ExternalClusterInstance'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_external_db_home(external_db_home_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_external_db_home API.

Gets the details for the external DB home specified by externalDbHomeId.

Parameters:

  • external_db_home_id (String) —

    The OCID of the external database home.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
 
# File 'lib/oci/database_management/db_management_client.rb', line 4234

def get_external_db_home(external_db_home_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_external_db_home.' if logger

  raise "Missing the required parameter 'external_db_home_id' when calling get_external_db_home." if external_db_home_id.nil?
  raise "Parameter value for 'external_db_home_id' must not be blank" if OCI::Internal::Util.blank_string?(external_db_home_id)

  path = '/externalDbHomes/{externalDbHomeId}'.sub('{externalDbHomeId}', external_db_home_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_external_db_home') 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::DatabaseManagement::Models::ExternalDbHome'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_external_db_node(external_db_node_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_external_db_node API.

Gets the details for the external DB node specified by externalDbNodeId.

Parameters:

  • external_db_node_id (String) —

    The OCID of the external database node.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
 
# File 'lib/oci/database_management/db_management_client.rb', line 4289

def get_external_db_node(external_db_node_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_external_db_node.' if logger

  raise "Missing the required parameter 'external_db_node_id' when calling get_external_db_node." if external_db_node_id.nil?
  raise "Parameter value for 'external_db_node_id' must not be blank" if OCI::Internal::Util.blank_string?(external_db_node_id)

  path = '/externalDbNodes/{externalDbNodeId}'.sub('{externalDbNodeId}', external_db_node_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_external_db_node') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DatabaseManagement::Models::ExternalDbNode'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_external_db_system(external_db_system_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_external_db_system API.

Gets the details for the external DB system specified by externalDbSystemId.

Parameters:

  • external_db_system_id (String) —

    The OCID of the external DB system.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
 
# File 'lib/oci/database_management/db_management_client.rb', line 4344

def get_external_db_system(external_db_system_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_external_db_system.' if logger

  raise "Missing the required parameter 'external_db_system_id' when calling get_external_db_system." if external_db_system_id.nil?
  raise "Parameter value for 'external_db_system_id' must not be blank" if OCI::Internal::Util.blank_string?(external_db_system_id)

  path = '/externalDbSystems/{externalDbSystemId}'.sub('{externalDbSystemId}', external_db_system_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_external_db_system') 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::DatabaseManagement::Models::ExternalDbSystem'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_external_db_system_connector(external_db_system_connector_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_external_db_system_connector API.

Gets the details for the external connector specified by externalDbSystemConnectorId.

Parameters:

  • external_db_system_connector_id (String) —

    The OCID of the external connector.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
 
# File 'lib/oci/database_management/db_management_client.rb', line 4399

def get_external_db_system_connector(external_db_system_connector_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_external_db_system_connector.' if logger

  raise "Missing the required parameter 'external_db_system_connector_id' when calling get_external_db_system_connector." if external_db_system_connector_id.nil?
  raise "Parameter value for 'external_db_system_connector_id' must not be blank" if OCI::Internal::Util.blank_string?(external_db_system_connector_id)

  path = '/externalDbSystemConnectors/{externalDbSystemConnectorId}'.sub('{externalDbSystemConnectorId}', external_db_system_connector_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_external_db_system_connector') 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::DatabaseManagement::Models::ExternalDbSystemConnector'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_external_db_system_discovery(external_db_system_discovery_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_external_db_system_discovery API.

Gets the details for the external DB system discovery resource specified by externalDbSystemDiscoveryId.

Parameters:

  • external_db_system_discovery_id (String) —

    The OCID of the external DB system discovery.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
 
# File 'lib/oci/database_management/db_management_client.rb', line 4454

def get_external_db_system_discovery(external_db_system_discovery_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_external_db_system_discovery.' if logger

  raise "Missing the required parameter 'external_db_system_discovery_id' when calling get_external_db_system_discovery." if external_db_system_discovery_id.nil?
  raise "Parameter value for 'external_db_system_discovery_id' must not be blank" if OCI::Internal::Util.blank_string?(external_db_system_discovery_id)

  path = '/externalDbSystemDiscoveries/{externalDbSystemDiscoveryId}'.sub('{externalDbSystemDiscoveryId}', external_db_system_discovery_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_external_db_system_discovery') 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::DatabaseManagement::Models::ExternalDbSystemDiscovery'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_external_exadata_infrastructure(external_exadata_infrastructure_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_external_exadata_infrastructure API.

Gets the details for the Exadata infrastructure specified by externalExadataInfrastructureId. It includes the DB systems and storage grid within the Exadata infrastructure.

Parameters:

  • external_exadata_infrastructure_id (String) —

    The OCID of the Exadata infrastructure.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
 
# File 'lib/oci/database_management/db_management_client.rb', line 4510

def get_external_exadata_infrastructure(external_exadata_infrastructure_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_external_exadata_infrastructure.' if logger

  raise "Missing the required parameter 'external_exadata_infrastructure_id' when calling get_external_exadata_infrastructure." if external_exadata_infrastructure_id.nil?
  raise "Parameter value for 'external_exadata_infrastructure_id' must not be blank" if OCI::Internal::Util.blank_string?(external_exadata_infrastructure_id)

  path = '/externalExadataInfrastructures/{externalExadataInfrastructureId}'.sub('{externalExadataInfrastructureId}', external_exadata_infrastructure_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_external_exadata_infrastructure') 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::DatabaseManagement::Models::ExternalExadataInfrastructure'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_external_exadata_storage_connector(external_exadata_storage_connector_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_external_exadata_storage_connector API.

Gets the details for the Exadata storage server connector specified by exadataStorageConnectorId.

Parameters:

  • external_exadata_storage_connector_id (String) —

    The OCID of the connector to the Exadata storage server.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
 
# File 'lib/oci/database_management/db_management_client.rb', line 4565

def get_external_exadata_storage_connector(external_exadata_storage_connector_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_external_exadata_storage_connector.' if logger

  raise "Missing the required parameter 'external_exadata_storage_connector_id' when calling get_external_exadata_storage_connector." if external_exadata_storage_connector_id.nil?
  raise "Parameter value for 'external_exadata_storage_connector_id' must not be blank" if OCI::Internal::Util.blank_string?(external_exadata_storage_connector_id)

  path = '/externalExadataStorageConnectors/{externalExadataStorageConnectorId}'.sub('{externalExadataStorageConnectorId}', external_exadata_storage_connector_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_external_exadata_storage_connector') 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::DatabaseManagement::Models::ExternalExadataStorageConnector'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_external_exadata_storage_grid(external_exadata_storage_grid_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_external_exadata_storage_grid API.

Gets the details for the Exadata storage server grid specified by exadataStorageGridId.

Parameters:

  • external_exadata_storage_grid_id (String) —

    The OCID of the Exadata storage grid.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
 
# File 'lib/oci/database_management/db_management_client.rb', line 4620

def get_external_exadata_storage_grid(external_exadata_storage_grid_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_external_exadata_storage_grid.' if logger

  raise "Missing the required parameter 'external_exadata_storage_grid_id' when calling get_external_exadata_storage_grid." if external_exadata_storage_grid_id.nil?
  raise "Parameter value for 'external_exadata_storage_grid_id' must not be blank" if OCI::Internal::Util.blank_string?(external_exadata_storage_grid_id)

  path = '/externalExadataStorageGrids/{externalExadataStorageGridId}'.sub('{externalExadataStorageGridId}', external_exadata_storage_grid_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_external_exadata_storage_grid') 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::DatabaseManagement::Models::ExternalExadataStorageGrid'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_external_exadata_storage_server(external_exadata_storage_server_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_external_exadata_storage_server API.

Gets the summary for the Exadata storage server specified by exadataStorageServerId.

Parameters:

  • external_exadata_storage_server_id (String) —

    The OCID of the Exadata storage server.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
 
# File 'lib/oci/database_management/db_management_client.rb', line 4675

def get_external_exadata_storage_server(external_exadata_storage_server_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_external_exadata_storage_server.' if logger

  raise "Missing the required parameter 'external_exadata_storage_server_id' when calling get_external_exadata_storage_server." if external_exadata_storage_server_id.nil?
  raise "Parameter value for 'external_exadata_storage_server_id' must not be blank" if OCI::Internal::Util.blank_string?(external_exadata_storage_server_id)

  path = '/externalExadataStorageServers/{externalExadataStorageServerId}'.sub('{externalExadataStorageServerId}', external_exadata_storage_server_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_external_exadata_storage_server') 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::DatabaseManagement::Models::ExternalExadataStorageServer'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_external_listener(external_listener_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_external_listener API.

Gets the details for the external listener specified by externalListenerId.

Parameters:

  • external_listener_id (String) —

    The OCID of the external listener.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
 
# File 'lib/oci/database_management/db_management_client.rb', line 4730

def get_external_listener(external_listener_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_external_listener.' if logger

  raise "Missing the required parameter 'external_listener_id' when calling get_external_listener." if external_listener_id.nil?
  raise "Parameter value for 'external_listener_id' must not be blank" if OCI::Internal::Util.blank_string?(external_listener_id)

  path = '/externalListeners/{externalListenerId}'.sub('{externalListenerId}', external_listener_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_external_listener') 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::DatabaseManagement::Models::ExternalListener'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_iorm_plan(external_exadata_storage_server_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_iorm_plan API.

Get the IORM plan from the specific Exadata storage server.

Parameters:

  • external_exadata_storage_server_id (String) —

    The OCID of the Exadata storage server.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
 
# File 'lib/oci/database_management/db_management_client.rb', line 4785

def get_iorm_plan(external_exadata_storage_server_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_iorm_plan.' if logger

  raise "Missing the required parameter 'external_exadata_storage_server_id' when calling get_iorm_plan." if external_exadata_storage_server_id.nil?
  raise "Parameter value for 'external_exadata_storage_server_id' must not be blank" if OCI::Internal::Util.blank_string?(external_exadata_storage_server_id)

  path = '/externalExadataStorageServers/{externalExadataStorageServerId}/iormPlan'.sub('{externalExadataStorageServerId}', external_exadata_storage_server_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_iorm_plan') 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::DatabaseManagement::Models::IormPlan'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_job(job_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_job API.

Gets the details for the job specified by jobId.

Parameters:

  • job_id (String) —

    The identifier of the job.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type Job



4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
 
# File 'lib/oci/database_management/db_management_client.rb', line 4840

def get_job(job_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#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::DatabaseManagement::Models::Job'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_job_execution(job_execution_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_job_execution API.

Gets the details for the job execution specified by jobExecutionId.

Parameters:

  • job_execution_id (String) —

    The identifier of the job execution.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
 
# File 'lib/oci/database_management/db_management_client.rb', line 4895

def get_job_execution(job_execution_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_job_execution.' if logger

  raise "Missing the required parameter 'job_execution_id' when calling get_job_execution." if job_execution_id.nil?
  raise "Parameter value for 'job_execution_id' must not be blank" if OCI::Internal::Util.blank_string?(job_execution_id)

  path = '/jobExecutions/{jobExecutionId}'.sub('{jobExecutionId}', job_execution_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_job_execution') 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::DatabaseManagement::Models::JobExecution'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_job_run(job_run_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_job_run API.

Gets the details for the job run specified by jobRunId.

Parameters:

  • job_run_id (String) —

    The identifier of the job run.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
 
# File 'lib/oci/database_management/db_management_client.rb', line 4950

def get_job_run(job_run_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_job_run.' if logger

  raise "Missing the required parameter 'job_run_id' when calling get_job_run." if job_run_id.nil?
  raise "Parameter value for 'job_run_id' must not be blank" if OCI::Internal::Util.blank_string?(job_run_id)

  path = '/jobRuns/{jobRunId}'.sub('{jobRunId}', job_run_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_job_run') 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::DatabaseManagement::Models::JobRun'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_managed_database(managed_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_managed_database API.

Gets the details for the Managed Database specified by managedDatabaseId.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
 
# File 'lib/oci/database_management/db_management_client.rb', line 5005

def get_managed_database(managed_database_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_managed_database.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling get_managed_database." if managed_database_id.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}'.sub('{managedDatabaseId}', managed_database_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_managed_database') 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::DatabaseManagement::Models::ManagedDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_managed_database_group(managed_database_group_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_managed_database_group API.

Gets the details for the Managed Database Group specified by managedDatabaseGroupId.

Parameters:

  • managed_database_group_id (String) —

    The OCID of the Managed Database Group.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
 
# File 'lib/oci/database_management/db_management_client.rb', line 5060

def get_managed_database_group(managed_database_group_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_managed_database_group.' if logger

  raise "Missing the required parameter 'managed_database_group_id' when calling get_managed_database_group." if managed_database_group_id.nil?
  raise "Parameter value for 'managed_database_group_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_group_id)

  path = '/managedDatabaseGroups/{managedDatabaseGroupId}'.sub('{managedDatabaseGroupId}', managed_database_group_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_managed_database_group') 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::DatabaseManagement::Models::ManagedDatabaseGroup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_open_alert_history(external_exadata_storage_server_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_open_alert_history API.

Gets the open alerts from the specified Exadata storage server.

Parameters:

  • external_exadata_storage_server_id (String) —

    The OCID of the Exadata storage server.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
 
# File 'lib/oci/database_management/db_management_client.rb', line 5115

def get_open_alert_history(external_exadata_storage_server_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_open_alert_history.' if logger

  raise "Missing the required parameter 'external_exadata_storage_server_id' when calling get_open_alert_history." if external_exadata_storage_server_id.nil?
  raise "Parameter value for 'external_exadata_storage_server_id' must not be blank" if OCI::Internal::Util.blank_string?(external_exadata_storage_server_id)

  path = '/externalExadataStorageServers/{externalExadataStorageServerId}/openAlertHistory'.sub('{externalExadataStorageServerId}', external_exadata_storage_server_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_open_alert_history') 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::DatabaseManagement::Models::OpenAlertHistory'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_optimizer_statistics_advisor_execution(managed_database_id, execution_name, task_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_optimizer_statistics_advisor_execution API.

Gets a comprehensive report of the Optimizer Statistics Advisor execution, which includes details of the Managed Database, findings, recommendations, rationale, and examples.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • execution_name (String) —

    The name of the Optimizer Statistics Advisor execution.

  • task_name (String) —

    The name of the optimizer statistics collection execution task.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
 
# File 'lib/oci/database_management/db_management_client.rb', line 5173

def get_optimizer_statistics_advisor_execution(managed_database_id, execution_name, task_name, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_optimizer_statistics_advisor_execution.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling get_optimizer_statistics_advisor_execution." if managed_database_id.nil?
  raise "Missing the required parameter 'execution_name' when calling get_optimizer_statistics_advisor_execution." if execution_name.nil?
  raise "Missing the required parameter 'task_name' when calling get_optimizer_statistics_advisor_execution." if task_name.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'execution_name' must not be blank" if OCI::Internal::Util.blank_string?(execution_name)

  path = '/managedDatabases/{managedDatabaseId}/optimizerStatisticsAdvisorExecutions/{executionName}'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{executionName}', execution_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:taskName] = task_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_optimizer_statistics_advisor_execution') 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::DatabaseManagement::Models::OptimizerStatisticsAdvisorExecution'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_optimizer_statistics_advisor_execution_script(managed_database_id, execution_name, task_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_optimizer_statistics_advisor_execution_script API.

Gets the Oracle system-generated script for the specified Optimizer Statistics Advisor execution.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • execution_name (String) —

    The name of the Optimizer Statistics Advisor execution.

  • task_name (String) —

    The name of the optimizer statistics collection execution task.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
 
# File 'lib/oci/database_management/db_management_client.rb', line 5233

def get_optimizer_statistics_advisor_execution_script(managed_database_id, execution_name, task_name, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_optimizer_statistics_advisor_execution_script.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling get_optimizer_statistics_advisor_execution_script." if managed_database_id.nil?
  raise "Missing the required parameter 'execution_name' when calling get_optimizer_statistics_advisor_execution_script." if execution_name.nil?
  raise "Missing the required parameter 'task_name' when calling get_optimizer_statistics_advisor_execution_script." if task_name.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'execution_name' must not be blank" if OCI::Internal::Util.blank_string?(execution_name)

  path = '/managedDatabases/{managedDatabaseId}/optimizerStatisticsAdvisorExecutions/{executionName}/script'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{executionName}', execution_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:taskName] = task_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_optimizer_statistics_advisor_execution_script') 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::DatabaseManagement::Models::OptimizerStatisticsAdvisorExecutionScript'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_optimizer_statistics_collection_operation(managed_database_id, optimizer_statistics_collection_operation_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_optimizer_statistics_collection_operation API.

Gets a detailed report of the Optimizer Statistics Collection operation for the specified Managed Database.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • optimizer_statistics_collection_operation_id (Float) —

    The ID of the Optimizer Statistics Collection operation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
 
# File 'lib/oci/database_management/db_management_client.rb', line 5292

def get_optimizer_statistics_collection_operation(managed_database_id, optimizer_statistics_collection_operation_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_optimizer_statistics_collection_operation.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling get_optimizer_statistics_collection_operation." if managed_database_id.nil?
  raise "Missing the required parameter 'optimizer_statistics_collection_operation_id' when calling get_optimizer_statistics_collection_operation." if optimizer_statistics_collection_operation_id.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'optimizer_statistics_collection_operation_id' must not be blank" if OCI::Internal::Util.blank_string?(optimizer_statistics_collection_operation_id)

  path = '/managedDatabases/{managedDatabaseId}/optimizerStatisticsCollectionOperations/{optimizerStatisticsCollectionOperationId}'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{optimizerStatisticsCollectionOperationId}', optimizer_statistics_collection_operation_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_optimizer_statistics_collection_operation') 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::DatabaseManagement::Models::OptimizerStatisticsCollectionOperation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_pdb_metrics(managed_database_id, start_time, end_time, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_pdb_metrics API.

Gets a summary of the resource usage metrics such as CPU, User I/O, and Storage for each PDB within a specific CDB. If comparmentId is specified, then the metrics for each PDB (within the CDB) in the specified compartment are retrieved. If compartmentId is not specified, then the metrics for all the PDBs within the CDB are retrieved.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • start_time (String) —

    The start time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'".

  • end_time (String) —

    The end time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'".

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :compartment_id (String) —

    The OCID of the compartment.

  • :compare_type (String) —

    The time window used for metrics comparison.

  • :filter_by_metric_names (String) —

    The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics.

Returns:



5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
 
# File 'lib/oci/database_management/db_management_client.rb', line 5361

def get_pdb_metrics(managed_database_id, start_time, end_time, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_pdb_metrics.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling get_pdb_metrics." if managed_database_id.nil?
  raise "Missing the required parameter 'start_time' when calling get_pdb_metrics." if start_time.nil?
  raise "Missing the required parameter 'end_time' when calling get_pdb_metrics." if end_time.nil?

  if opts[:compare_type] && !OCI::DatabaseManagement::Models::COMPARE_TYPE_ENUM.include?(opts[:compare_type])
    raise 'Invalid value for "compare_type", must be one of the values in OCI::DatabaseManagement::Models::COMPARE_TYPE_ENUM.'
  end
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/pdbMetrics'.sub('{managedDatabaseId}', managed_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:startTime] = start_time
  query_params[:endTime] = end_time
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:compareType] = opts[:compare_type] if opts[:compare_type]
  query_params[:filterByMetricNames] = opts[:filter_by_metric_names] if opts[:filter_by_metric_names]

  # 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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_pdb_metrics') 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::DatabaseManagement::Models::PdbMetrics'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_preferred_credential(managed_database_id, credential_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_preferred_credential API.

Gets the preferred credential details for a Managed Database based on credentialName.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • credential_name (String) —

    The name of the preferred credential.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
 
# File 'lib/oci/database_management/db_management_client.rb', line 5428

def get_preferred_credential(managed_database_id, credential_name, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_preferred_credential.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling get_preferred_credential." if managed_database_id.nil?
  raise "Missing the required parameter 'credential_name' when calling get_preferred_credential." if credential_name.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'credential_name' must not be blank" if OCI::Internal::Util.blank_string?(credential_name)

  path = '/managedDatabases/{managedDatabaseId}/preferredCredentials/{credentialName}'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{credentialName}', credential_name.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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_preferred_credential') 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::DatabaseManagement::Models::PreferredCredential'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_sql_plan_baseline(managed_database_id, plan_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_sql_plan_baseline API.

Gets the SQL plan baseline details for the specified planName.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • plan_name (String) —

    The plan name of the SQL plan baseline.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
 
# File 'lib/oci/database_management/db_management_client.rb', line 5486

def get_sql_plan_baseline(managed_database_id, plan_name, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_sql_plan_baseline.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling get_sql_plan_baseline." if managed_database_id.nil?
  raise "Missing the required parameter 'plan_name' when calling get_sql_plan_baseline." if plan_name.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'plan_name' must not be blank" if OCI::Internal::Util.blank_string?(plan_name)

  path = '/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/{planName}'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{planName}', plan_name.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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_sql_plan_baseline') 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::DatabaseManagement::Models::SqlPlanBaseline'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_sql_plan_baseline_configuration(managed_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_sql_plan_baseline_configuration API.

Gets the configuration details of SQL plan baselines for the specified Managed Database. The details include the settings for the capture and use of SQL plan baselines, SPM Evolve Advisor task, and SQL Management Base.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
 
# File 'lib/oci/database_management/db_management_client.rb', line 5545

def get_sql_plan_baseline_configuration(managed_database_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_sql_plan_baseline_configuration.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling get_sql_plan_baseline_configuration." if managed_database_id.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/sqlPlanBaselineConfiguration'.sub('{managedDatabaseId}', managed_database_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_sql_plan_baseline_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::DatabaseManagement::Models::SqlPlanBaselineConfiguration'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_tablespace(managed_database_id, tablespace_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_tablespace API.

Gets the details of the tablespace specified by tablespaceName within the Managed Database specified by managedDatabaseId.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • tablespace_name (String) —

    The name of the tablespace.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
 
# File 'lib/oci/database_management/db_management_client.rb', line 5601

def get_tablespace(managed_database_id, tablespace_name, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_tablespace.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling get_tablespace." if managed_database_id.nil?
  raise "Missing the required parameter 'tablespace_name' when calling get_tablespace." if tablespace_name.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'tablespace_name' must not be blank" if OCI::Internal::Util.blank_string?(tablespace_name)

  path = '/managedDatabases/{managedDatabaseId}/tablespaces/{tablespaceName}'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{tablespaceName}', tablespace_name.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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_tablespace') 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::DatabaseManagement::Models::Tablespace'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_top_sql_cpu_activity(external_exadata_storage_server_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_top_sql_cpu_activity API.

Gets the SQL IDs with the top CPU activity from the Exadata storage server.

Parameters:

  • external_exadata_storage_server_id (String) —

    The OCID of the Exadata storage server.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
 
# File 'lib/oci/database_management/db_management_client.rb', line 5658

def get_top_sql_cpu_activity(external_exadata_storage_server_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_top_sql_cpu_activity.' if logger

  raise "Missing the required parameter 'external_exadata_storage_server_id' when calling get_top_sql_cpu_activity." if external_exadata_storage_server_id.nil?
  raise "Parameter value for 'external_exadata_storage_server_id' must not be blank" if OCI::Internal::Util.blank_string?(external_exadata_storage_server_id)

  path = '/externalExadataStorageServers/{externalExadataStorageServerId}/topSqlCpuActivity'.sub('{externalExadataStorageServerId}', external_exadata_storage_server_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_top_sql_cpu_activity') 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::DatabaseManagement::Models::TopSqlCpuActivity'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_user(managed_database_id, user_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_user API.

Gets the details of the user specified by managedDatabaseId and userName.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • user_name (String) —

    The name of the user whose details are to be viewed.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
 
# File 'lib/oci/database_management/db_management_client.rb', line 5714

def get_user(managed_database_id, user_name, opts = {})
  logger.debug 'Calling operation DbManagementClient#get_user.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling get_user." if managed_database_id.nil?
  raise "Missing the required parameter 'user_name' when calling get_user." if user_name.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'user_name' must not be blank" if OCI::Internal::Util.blank_string?(user_name)

  path = '/managedDatabases/{managedDatabaseId}/users/{userName}'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{userName}', user_name.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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#get_user') 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::DatabaseManagement::Models::User'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_work_request(work_request_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_work_request API.

Gets the status of the work request with the given Work Request ID

Parameters:

  • work_request_id (String) —

    The OCID of the asynchronous work request.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
 
# File 'lib/oci/database_management/db_management_client.rb', line 5770

def get_work_request(work_request_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#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::DatabaseManagement::Models::WorkRequest'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#implement_optimizer_statistics_advisor_recommendations(managed_database_id, execution_name, implement_optimizer_statistics_advisor_recommendations_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use implement_optimizer_statistics_advisor_recommendations API.

Asynchronously implements the findings and recommendations of the Optimizer Statistics Advisor execution.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type Job



5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
 
# File 'lib/oci/database_management/db_management_client.rb', line 5826

def implement_optimizer_statistics_advisor_recommendations(managed_database_id, execution_name, implement_optimizer_statistics_advisor_recommendations_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#implement_optimizer_statistics_advisor_recommendations.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling implement_optimizer_statistics_advisor_recommendations." if managed_database_id.nil?
  raise "Missing the required parameter 'execution_name' when calling implement_optimizer_statistics_advisor_recommendations." if execution_name.nil?
  raise "Missing the required parameter 'implement_optimizer_statistics_advisor_recommendations_details' when calling implement_optimizer_statistics_advisor_recommendations." if implement_optimizer_statistics_advisor_recommendations_details.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'execution_name' must not be blank" if OCI::Internal::Util.blank_string?(execution_name)

  path = '/managedDatabases/{managedDatabaseId}/optimizerStatisticsAdvisorExecutions/{executionName}/actions/implementRecommendations'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{executionName}', execution_name.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 = @api_client.object_to_http_body(implement_optimizer_statistics_advisor_recommendations_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#implement_optimizer_statistics_advisor_recommendations') 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::DatabaseManagement::Models::Job'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_asm_properties(managed_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_asm_properties API.

Gets the list of ASM properties for the specified managedDatabaseId.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :name (String) —

    A filter to return only resources that match the entire name.

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for u2018TIMECREATEDu2019 is descending and the default sort order for u2018NAMEu2019 is ascending. The u2018NAMEu2019 sort order is case-sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, NAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

Returns:



5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
 
# File 'lib/oci/database_management/db_management_client.rb', line 5894

def list_asm_properties(managed_database_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_asm_properties.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling list_asm_properties." if managed_database_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED NAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, NAME.'
  end

  if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/asmProperties'.sub('{managedDatabaseId}', managed_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]

  # 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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_asm_properties') 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::DatabaseManagement::Models::AsmPropertyCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_associated_databases(db_management_private_endpoint_id, compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_associated_databases API.

Gets the list of databases using a specific Database Management private endpoint. Allowed values are: timeRegistered

Parameters:

  • db_management_private_endpoint_id (String) —

    The OCID of the Database Management private endpoint.

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :sort_by (String) —

    The option to sort databases using a specific Database Management private endpoint. (default to timeRegistered)

Returns:



5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
 
# File 'lib/oci/database_management/db_management_client.rb', line 5970

def list_associated_databases(db_management_private_endpoint_id, compartment_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_associated_databases.' if logger

  raise "Missing the required parameter 'db_management_private_endpoint_id' when calling list_associated_databases." if db_management_private_endpoint_id.nil?
  raise "Missing the required parameter 'compartment_id' when calling list_associated_databases." if compartment_id.nil?

  if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end

  if opts[:sort_by] && !%w[timeRegistered].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeRegistered.'
  end
  raise "Parameter value for 'db_management_private_endpoint_id' must not be blank" if OCI::Internal::Util.blank_string?(db_management_private_endpoint_id)

  path = '/dbManagementPrivateEndpoints/{dbManagementPrivateEndpointId}/associatedDatabases'.sub('{dbManagementPrivateEndpointId}', db_management_private_endpoint_id.to_s)
  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[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_associated_databases') 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::DatabaseManagement::Models::AssociatedDatabaseCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_awr_db_snapshots(managed_database_id, awr_db_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_awr_db_snapshots API.

Lists AWR snapshots for the specified database in the AWR.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • awr_db_id (String) —

    The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/managedDatabaseId/awrDbs

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :inst_num (String) —

    The optional single value query parameter to filter the database instance number.

  • :begin_sn_id_greater_than_or_equal_to (Integer) —

    The optional greater than or equal to filter on the snapshot ID.

  • :end_sn_id_less_than_or_equal_to (Integer) —

    The optional less than or equal to query parameter to filter the snapshot ID.

  • :time_greater_than_or_equal_to (DateTime) —

    The optional greater than or equal to query parameter to filter the timestamp.

  • :time_less_than_or_equal_to (DateTime) —

    The optional less than or equal to query parameter to filter the timestamp.

  • :container_id (Integer) —

    The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/managedDatabaseId/awrDbSnapshotRanges

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :sort_by (String) —

    The option to sort the AWR snapshot summary data. (default to TIME_BEGIN) Allowed values are: TIME_BEGIN, SNAPSHOT_ID

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Descending order is the default order. (default to DESC)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
 
# File 'lib/oci/database_management/db_management_client.rb', line 6065

def list_awr_db_snapshots(managed_database_id, awr_db_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_awr_db_snapshots.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling list_awr_db_snapshots." if managed_database_id.nil?
  raise "Missing the required parameter 'awr_db_id' when calling list_awr_db_snapshots." if awr_db_id.nil?

  if opts[:sort_by] && !%w[TIME_BEGIN SNAPSHOT_ID].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_BEGIN, SNAPSHOT_ID.'
  end

  if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'awr_db_id' must not be blank" if OCI::Internal::Util.blank_string?(awr_db_id)

  path = '/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbSnapshots'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{awrDbId}', awr_db_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:instNum] = opts[:inst_num] if opts[:inst_num]
  query_params[:beginSnIdGreaterThanOrEqualTo] = opts[:begin_sn_id_greater_than_or_equal_to] if opts[:begin_sn_id_greater_than_or_equal_to]
  query_params[:endSnIdLessThanOrEqualTo] = opts[:end_sn_id_less_than_or_equal_to] if opts[:end_sn_id_less_than_or_equal_to]
  query_params[:timeGreaterThanOrEqualTo] = opts[:time_greater_than_or_equal_to] if opts[:time_greater_than_or_equal_to]
  query_params[:timeLessThanOrEqualTo] = opts[:time_less_than_or_equal_to] if opts[:time_less_than_or_equal_to]
  query_params[:containerId] = opts[:container_id] if opts[:container_id]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_awr_db_snapshots') 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::DatabaseManagement::Models::AwrDbSnapshotCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_awr_dbs(managed_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_awr_dbs API.

Gets the list of databases and their snapshot summary details available in the AWR of the specified Managed Database.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :name (String) —

    The optional single value query parameter to filter the entity name.

  • :time_greater_than_or_equal_to (DateTime) —

    The optional greater than or equal to query parameter to filter the timestamp.

  • :time_less_than_or_equal_to (DateTime) —

    The optional less than or equal to query parameter to filter the timestamp.

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :sort_by (String) —

    The option to sort the AWR summary data. (default to END_INTERVAL_TIME) Allowed values are: END_INTERVAL_TIME, NAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Descending order is the default order. (default to DESC)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
 
# File 'lib/oci/database_management/db_management_client.rb', line 6158

def list_awr_dbs(managed_database_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_awr_dbs.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling list_awr_dbs." if managed_database_id.nil?

  if opts[:sort_by] && !%w[END_INTERVAL_TIME NAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of END_INTERVAL_TIME, NAME.'
  end

  if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/awrDbs'.sub('{managedDatabaseId}', managed_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:timeGreaterThanOrEqualTo] = opts[:time_greater_than_or_equal_to] if opts[:time_greater_than_or_equal_to]
  query_params[:timeLessThanOrEqualTo] = opts[:time_less_than_or_equal_to] if opts[:time_less_than_or_equal_to]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_awr_dbs') 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::DatabaseManagement::Models::AwrDbCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_consumer_group_privileges(managed_database_id, user_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_consumer_group_privileges API.

Gets the list of consumer group privileges granted to a specific user.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • user_name (String) —

    The name of the user whose details are to be viewed.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :name (String) —

    A filter to return only resources that match the entire name.

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for u2018NAMEu2019 is ascending. The u2018NAMEu2019 sort order is case-sensitive. (default to NAME) Allowed values are: NAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

Returns:



6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
 
# File 'lib/oci/database_management/db_management_client.rb', line 6240

def list_consumer_group_privileges(managed_database_id, user_name, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_consumer_group_privileges.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling list_consumer_group_privileges." if managed_database_id.nil?
  raise "Missing the required parameter 'user_name' when calling list_consumer_group_privileges." if user_name.nil?

  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::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'user_name' must not be blank" if OCI::Internal::Util.blank_string?(user_name)

  path = '/managedDatabases/{managedDatabaseId}/users/{userName}/consumerGroupPrivileges'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{userName}', user_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:name] = opts[:name] if opts[: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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_consumer_group_privileges') 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::DatabaseManagement::Models::ConsumerGroupPrivilegeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_cursor_cache_statements(managed_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_cursor_cache_statements API.

Lists the SQL statements from shared SQL area, also called the cursor cache.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :sql_text (String) —

    A filter to return all the SQL plan baselines that match the SQL text. By default, the search is case insensitive. To run an exact or case-sensitive search, double-quote the search string. You may also use the '%' symbol as a wildcard.

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :sort_by (String) —

    The option to sort the SQL statement summary data. (default to sqlId) Allowed values are: sqlId, schema

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
 
# File 'lib/oci/database_management/db_management_client.rb', line 6321

def list_cursor_cache_statements(managed_database_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_cursor_cache_statements.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling list_cursor_cache_statements." if managed_database_id.nil?

  if opts[:sort_by] && !%w[sqlId schema].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of sqlId, schema.'
  end

  if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/cursorCacheStatements'.sub('{managedDatabaseId}', managed_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:sqlText] = opts[:sql_text] if opts[:sql_text]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_cursor_cache_statements') 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::DatabaseManagement::Models::CursorCacheStatementCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_data_access_containers(managed_database_id, user_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_data_access_containers API.

Gets the list of containers for a specific user. This is only applicable if ALL_CONTAINERS !='Y'.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • user_name (String) —

    The name of the user whose details are to be viewed.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :name (String) —

    A filter to return only resources that match the entire name.

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for u2018NAMEu2019 is ascending. The u2018NAMEu2019 sort order is case-sensitive. (default to NAME) Allowed values are: NAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

Returns:



6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
 
# File 'lib/oci/database_management/db_management_client.rb', line 6399

def list_data_access_containers(managed_database_id, user_name, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_data_access_containers.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling list_data_access_containers." if managed_database_id.nil?
  raise "Missing the required parameter 'user_name' when calling list_data_access_containers." if user_name.nil?

  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::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'user_name' must not be blank" if OCI::Internal::Util.blank_string?(user_name)

  path = '/managedDatabases/{managedDatabaseId}/users/{userName}/dataAccessContainers'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{userName}', user_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:name] = opts[:name] if opts[: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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_data_access_containers') 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::DatabaseManagement::Models::DataAccessContainerCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_database_parameters(managed_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_database_parameters API.

Gets the list of database parameters for the specified Managed Database. The parameters are listed in alphabetical order, along with their current values.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :source (String) —

    The source used to list database parameters. CURRENT is used to get the database parameters that are currently in effect for the database instance. SPFILE is used to list parameters from the server parameter file. Default is CURRENT. (default to CURRENT) Allowed values are: CURRENT, SPFILE

  • :name (String) —

    A filter to return all parameters that have the text given in their names.

  • :is_allowed_values_included (BOOLEAN) —

    When true, results include a list of valid values for parameters (if applicable). (default to false)

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for NAME is ascending and it is case-sensitive. (default to NAME) Allowed values are: NAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

Returns:



6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
 
# File 'lib/oci/database_management/db_management_client.rb', line 6484

def list_database_parameters(managed_database_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_database_parameters.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling list_database_parameters." if managed_database_id.nil?

  if opts[:source] && !%w[CURRENT SPFILE].include?(opts[:source])
    raise 'Invalid value for "source", must be one of CURRENT, SPFILE.'
  end

  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::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/databaseParameters'.sub('{managedDatabaseId}', managed_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:source] = opts[:source] if opts[:source]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:isAllowedValuesIncluded] = opts[:is_allowed_values_included] if !opts[:is_allowed_values_included].nil?
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_database_parameters') 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::DatabaseManagement::Models::DatabaseParametersCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_db_management_private_endpoints(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_db_management_private_endpoints API.

Gets a list of Database Management private endpoints.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :name (String) —

    A filter to return only resources that match the entire name.

  • :vcn_id (String) —

    The OCID of the VCN.

  • :is_cluster (BOOLEAN) —

    The option to filter Database Management private endpoints that can used for Oracle Databases in a cluster. This should be used along with the vcnId query parameter. (default to false)

  • :lifecycle_state (String) —

    The lifecycle state of a resource.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for u2018TIMECREATEDu2019 is descending and the default sort order for u2018NAMEu2019 is ascending. The u2018NAMEu2019 sort order is case-sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, NAME

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
 
# File 'lib/oci/database_management/db_management_client.rb', line 6571

def list_db_management_private_endpoints(compartment_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_db_management_private_endpoints.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_db_management_private_endpoints." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::DatabaseManagement::Models::LIFECYCLE_STATES_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DatabaseManagement::Models::LIFECYCLE_STATES_ENUM.'
  end

  if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end

  if opts[:sort_by] && !%w[TIMECREATED NAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, NAME.'
  end

  path = '/dbManagementPrivateEndpoints'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:vcnId] = opts[:vcn_id] if opts[:vcn_id]
  query_params[:isCluster] = opts[:is_cluster] if !opts[:is_cluster].nil?
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  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]

  # 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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_db_management_private_endpoints') 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::DatabaseManagement::Models::DbManagementPrivateEndpointCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_external_asm_disk_groups(external_asm_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_external_asm_disk_groups API.

Lists ASM disk groups for the external ASM specified by externalAsmId.

Parameters:

  • external_asm_id (String) —

    The OCID of the external ASM.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for NAME is ascending and it is case-sensitive. (default to NAME) Allowed values are: NAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
 
# File 'lib/oci/database_management/db_management_client.rb', line 6655

def list_external_asm_disk_groups(external_asm_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_external_asm_disk_groups.' if logger

  raise "Missing the required parameter 'external_asm_id' when calling list_external_asm_disk_groups." if external_asm_id.nil?

  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::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end
  raise "Parameter value for 'external_asm_id' must not be blank" if OCI::Internal::Util.blank_string?(external_asm_id)

  path = '/externalAsms/{externalAsmId}/diskGroups'.sub('{externalAsmId}', external_asm_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_external_asm_disk_groups') 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::DatabaseManagement::Models::ExternalAsmDiskGroupCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_external_asm_instances(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_external_asm_instances API.

Lists the ASM instances in the specified external ASM.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id (String) —

    The OCID of the compartment.

  • :external_asm_id (String) —

    The OCID of the external ASM.

  • :display_name (String) —

    A filter to only return the resources that match the entire display name.

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for TIMECREATED is descending and the default sort order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case-sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
 
# File 'lib/oci/database_management/db_management_client.rb', line 6733

def list_external_asm_instances(opts = {})
  logger.debug 'Calling operation DbManagementClient#list_external_asm_instances.' if logger


  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::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end

  path = '/externalAsmInstances'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:externalAsmId] = opts[:external_asm_id] if opts[:external_asm_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_external_asm_instances') 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::DatabaseManagement::Models::ExternalAsmInstanceCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_external_asm_users(external_asm_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_external_asm_users API.

Lists ASM users for the external ASM specified by externalAsmId.

Parameters:

  • external_asm_id (String) —

    The OCID of the external ASM.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for NAME is ascending and it is case-sensitive. (default to NAME) Allowed values are: NAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
 
# File 'lib/oci/database_management/db_management_client.rb', line 6810

def list_external_asm_users(external_asm_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_external_asm_users.' if logger

  raise "Missing the required parameter 'external_asm_id' when calling list_external_asm_users." if external_asm_id.nil?

  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::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end
  raise "Parameter value for 'external_asm_id' must not be blank" if OCI::Internal::Util.blank_string?(external_asm_id)

  path = '/externalAsms/{externalAsmId}/users'.sub('{externalAsmId}', external_asm_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_external_asm_users') 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::DatabaseManagement::Models::ExternalAsmUserCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_external_asms(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_external_asms API.

Lists the ASMs in the specified external DB system.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id (String) —

    The OCID of the compartment.

  • :external_db_system_id (String) —

    The OCID of the external DB system.

  • :display_name (String) —

    A filter to only return the resources that match the entire display name.

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for TIMECREATED is descending and the default sort order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case-sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
 
# File 'lib/oci/database_management/db_management_client.rb', line 6888

def list_external_asms(opts = {})
  logger.debug 'Calling operation DbManagementClient#list_external_asms.' if logger


  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::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end

  path = '/externalAsms'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:externalDbSystemId] = opts[:external_db_system_id] if opts[:external_db_system_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_external_asms') 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::DatabaseManagement::Models::ExternalAsmCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_external_cluster_instances(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_external_cluster_instances API.

Lists the cluster instances in the specified external cluster.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id (String) —

    The OCID of the compartment.

  • :external_cluster_id (String) —

    The OCID of the external cluster.

  • :display_name (String) —

    A filter to only return the resources that match the entire display name.

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for TIMECREATED is descending and the default sort order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case-sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
 
# File 'lib/oci/database_management/db_management_client.rb', line 6967

def list_external_cluster_instances(opts = {})
  logger.debug 'Calling operation DbManagementClient#list_external_cluster_instances.' if logger


  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::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end

  path = '/externalClusterInstances'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:externalClusterId] = opts[:external_cluster_id] if opts[:external_cluster_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_external_cluster_instances') 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::DatabaseManagement::Models::ExternalClusterInstanceCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_external_clusters(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_external_clusters API.

Lists the clusters in the specified external DB system.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id (String) —

    The OCID of the compartment.

  • :external_db_system_id (String) —

    The OCID of the external DB system.

  • :display_name (String) —

    A filter to only return the resources that match the entire display name.

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for TIMECREATED is descending and the default sort order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case-sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
 
# File 'lib/oci/database_management/db_management_client.rb', line 7046

def list_external_clusters(opts = {})
  logger.debug 'Calling operation DbManagementClient#list_external_clusters.' if logger


  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::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end

  path = '/externalClusters'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:externalDbSystemId] = opts[:external_db_system_id] if opts[:external_db_system_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_external_clusters') 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::DatabaseManagement::Models::ExternalClusterCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_external_databases(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_external_databases API.

Lists the external databases in the specified compartment or in the specified DB system.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id (String) —

    The OCID of the compartment.

  • :external_db_system_id (String) —

    The OCID of the external DB system.

  • :display_name (String) —

    A filter to only return the resources that match the entire display name.

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for TIMECREATED is descending and the default sort order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case-sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
 
# File 'lib/oci/database_management/db_management_client.rb', line 7125

def list_external_databases(opts = {})
  logger.debug 'Calling operation DbManagementClient#list_external_databases.' if logger


  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::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end

  path = '/externalDatabases'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:externalDbSystemId] = opts[:external_db_system_id] if opts[:external_db_system_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_external_databases') 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::DatabaseManagement::Models::ExternalDatabaseCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_external_db_homes(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_external_db_homes API.

Lists the DB homes in the specified external DB system.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id (String) —

    The OCID of the compartment.

  • :external_db_system_id (String) —

    The OCID of the external DB system.

  • :display_name (String) —

    A filter to only return the resources that match the entire display name.

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for TIMECREATED is descending and the default sort order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case-sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
 
# File 'lib/oci/database_management/db_management_client.rb', line 7204

def list_external_db_homes(opts = {})
  logger.debug 'Calling operation DbManagementClient#list_external_db_homes.' if logger


  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::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end

  path = '/externalDbHomes'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:externalDbSystemId] = opts[:external_db_system_id] if opts[:external_db_system_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_external_db_homes') 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::DatabaseManagement::Models::ExternalDbHomeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_external_db_nodes(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_external_db_nodes API.

Lists the external DB nodes in the specified external DB system.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id (String) —

    The OCID of the compartment.

  • :external_db_system_id (String) —

    The OCID of the external DB system.

  • :display_name (String) —

    A filter to only return the resources that match the entire display name.

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for TIMECREATED is descending and the default sort order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case-sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
 
# File 'lib/oci/database_management/db_management_client.rb', line 7283

def list_external_db_nodes(opts = {})
  logger.debug 'Calling operation DbManagementClient#list_external_db_nodes.' if logger


  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::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end

  path = '/externalDbNodes'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:externalDbSystemId] = opts[:external_db_system_id] if opts[:external_db_system_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_external_db_nodes') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DatabaseManagement::Models::ExternalDbNodeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_external_db_system_connectors(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_external_db_system_connectors API.

Lists the external connectors in the specified external DB system.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id (String) —

    The OCID of the compartment.

  • :external_db_system_id (String) —

    The OCID of the external DB system.

  • :display_name (String) —

    A filter to only return the resources that match the entire display name.

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for TIMECREATED is descending and the default sort order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case-sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
 
# File 'lib/oci/database_management/db_management_client.rb', line 7362

def list_external_db_system_connectors(opts = {})
  logger.debug 'Calling operation DbManagementClient#list_external_db_system_connectors.' if logger


  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::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end

  path = '/externalDbSystemConnectors'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:externalDbSystemId] = opts[:external_db_system_id] if opts[:external_db_system_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_external_db_system_connectors') 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::DatabaseManagement::Models::ExternalDbSystemConnectorCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_external_db_system_discoveries(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_external_db_system_discoveries API.

Lists the external DB system discovery resources in the specified compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :display_name (String) —

    A filter to only return the resources that match the entire display name.

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for TIMECREATED is descending and the default sort order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case-sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
 
# File 'lib/oci/database_management/db_management_client.rb', line 7440

def list_external_db_system_discoveries(compartment_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_external_db_system_discoveries.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_external_db_system_discoveries." 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::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end

  path = '/externalDbSystemDiscoveries'
  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[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_external_db_system_discoveries') 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::DatabaseManagement::Models::ExternalDbSystemDiscoveryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_external_db_systems(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_external_db_systems API.

Lists the external DB systems in the specified compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :display_name (String) —

    A filter to only return the resources that match the entire display name.

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for TIMECREATED is descending and the default sort order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case-sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
 
# File 'lib/oci/database_management/db_management_client.rb', line 7518

def list_external_db_systems(compartment_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_external_db_systems.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_external_db_systems." 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::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end

  path = '/externalDbSystems'
  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[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_external_db_systems') 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::DatabaseManagement::Models::ExternalDbSystemCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_external_exadata_infrastructures(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_external_exadata_infrastructures API.

Lists the Exadata infrastructure resources in the specified compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :display_name (String) —

    The optional single value query filter parameter on the entity display name.

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for u2018TIMECREATEDu2019 is descending and the default sort order for u2018NAMEu2019 is ascending. The u2018NAMEu2019 sort order is case-sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, NAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
 
# File 'lib/oci/database_management/db_management_client.rb', line 7597

def list_external_exadata_infrastructures(compartment_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_external_exadata_infrastructures.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_external_exadata_infrastructures." if compartment_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED NAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, NAME.'
  end

  if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end

  path = '/externalExadataInfrastructures'
  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[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_external_exadata_infrastructures') 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::DatabaseManagement::Models::ExternalExadataInfrastructureCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_external_exadata_storage_connectors(compartment_id, external_exadata_infrastructure_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_external_exadata_storage_connectors API.

Lists the Exadata storage server connectors for the specified Exadata infrastructure.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • external_exadata_infrastructure_id (String) —

    The OCID of the Exadata infrastructure.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :display_name (String) —

    The optional single value query filter parameter on the entity display name.

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for u2018TIMECREATEDu2019 is descending and the default sort order for u2018NAMEu2019 is ascending. The u2018NAMEu2019 sort order is case-sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, NAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
 
# File 'lib/oci/database_management/db_management_client.rb', line 7677

def list_external_exadata_storage_connectors(compartment_id, external_exadata_infrastructure_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_external_exadata_storage_connectors.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_external_exadata_storage_connectors." if compartment_id.nil?
  raise "Missing the required parameter 'external_exadata_infrastructure_id' when calling list_external_exadata_storage_connectors." if external_exadata_infrastructure_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED NAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, NAME.'
  end

  if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end

  path = '/externalExadataStorageConnectors'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:externalExadataInfrastructureId] = external_exadata_infrastructure_id
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_external_exadata_storage_connectors') 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::DatabaseManagement::Models::ExternalExadataStorageConnectorCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_external_exadata_storage_servers(compartment_id, external_exadata_infrastructure_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_external_exadata_storage_servers API.

Lists the Exadata storage servers for the specified Exadata infrastructure.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • external_exadata_infrastructure_id (String) —

    The OCID of the Exadata infrastructure.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :display_name (String) —

    The optional single value query filter parameter on the entity display name.

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for u2018TIMECREATEDu2019 is descending and the default sort order for u2018NAMEu2019 is ascending. The u2018NAMEu2019 sort order is case-sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, NAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
 
# File 'lib/oci/database_management/db_management_client.rb', line 7759

def list_external_exadata_storage_servers(compartment_id, external_exadata_infrastructure_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_external_exadata_storage_servers.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_external_exadata_storage_servers." if compartment_id.nil?
  raise "Missing the required parameter 'external_exadata_infrastructure_id' when calling list_external_exadata_storage_servers." if external_exadata_infrastructure_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED NAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, NAME.'
  end

  if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end

  path = '/externalExadataStorageServers'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:externalExadataInfrastructureId] = external_exadata_infrastructure_id
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_external_exadata_storage_servers') 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::DatabaseManagement::Models::ExternalExadataStorageServerCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_external_listener_services(external_listener_id, managed_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_external_listener_services API.

Lists the database services registered with the specified external listener for the specified Managed Database.

Parameters:

  • external_listener_id (String) —

    The OCID of the external listener.

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for NAME is ascending and it is case-sensitive. (default to NAME) Allowed values are: NAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
 
# File 'lib/oci/database_management/db_management_client.rb', line 7840

def list_external_listener_services(external_listener_id, managed_database_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_external_listener_services.' if logger

  raise "Missing the required parameter 'external_listener_id' when calling list_external_listener_services." if external_listener_id.nil?
  raise "Missing the required parameter 'managed_database_id' when calling list_external_listener_services." if managed_database_id.nil?

  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::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end
  raise "Parameter value for 'external_listener_id' must not be blank" if OCI::Internal::Util.blank_string?(external_listener_id)

  path = '/externalListeners/{externalListenerId}/services'.sub('{externalListenerId}', external_listener_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:managedDatabaseId] = managed_database_id
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_external_listener_services') 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::DatabaseManagement::Models::ExternalListenerServiceCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_external_listeners(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_external_listeners API.

Lists the listeners in the specified external DB system.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id (String) —

    The OCID of the compartment.

  • :external_db_system_id (String) —

    The OCID of the external DB system.

  • :display_name (String) —

    A filter to only return the resources that match the entire display name.

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for TIMECREATED is descending and the default sort order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case-sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
 
# File 'lib/oci/database_management/db_management_client.rb', line 7920

def list_external_listeners(opts = {})
  logger.debug 'Calling operation DbManagementClient#list_external_listeners.' if logger


  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::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end

  path = '/externalListeners'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:externalDbSystemId] = opts[:external_db_system_id] if opts[:external_db_system_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_external_listeners') 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::DatabaseManagement::Models::ExternalListenerCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_job_executions(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_job_executions API.

Gets the job execution for a specific ID or the list of job executions for a job, job run, Managed Database or Managed Database Group in a specific compartment. Only one of the parameters, ID, jobId, jobRunId, managedDatabaseId or managedDatabaseGroupId should be provided. If none of these parameters is provided, all the job executions in the compartment are listed. Job executions can also be filtered based on the name and status parameters.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :id (String) —

    The identifier of the resource.

  • :job_id (String) —

    The identifier of the job.

  • :managed_database_id (String) —

    The OCID of the Managed Database.

  • :managed_database_group_id (String) —

    The OCID of the Managed Database Group.

  • :status (String) —

    The status of the job execution.

  • :name (String) —

    A filter to return only resources that match the entire name.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for u2018TIMECREATEDu2019 is descending and the default sort order for u2018NAMEu2019 is ascending. The u2018NAMEu2019 sort order is case-sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, NAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :job_run_id (String) —

    The identifier of the job run.

Returns:



8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
 
# File 'lib/oci/database_management/db_management_client.rb', line 8008

def list_job_executions(compartment_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_job_executions.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_job_executions." if compartment_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED NAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, NAME.'
  end

  if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end

  path = '/jobExecutions'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:jobId] = opts[:job_id] if opts[:job_id]
  query_params[:managedDatabaseId] = opts[:managed_database_id] if opts[:managed_database_id]
  query_params[:managedDatabaseGroupId] = opts[:managed_database_group_id] if opts[:managed_database_group_id]
  query_params[:status] = opts[:status] if opts[:status]
  query_params[:name] = opts[:name] if opts[: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[:jobRunId] = opts[:job_run_id] if opts[:job_run_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_job_executions') 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::DatabaseManagement::Models::JobExecutionCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_job_runs(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_job_runs API.

Gets the job run for a specific ID or the list of job runs for a job, Managed Database or Managed Database Group in a specific compartment. Only one of the parameters, ID, jobId, managedDatabaseId, or managedDatabaseGroupId should be provided. If none of these parameters is provided, all the job runs in the compartment are listed. Job runs can also be filtered based on name and runStatus parameters.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :id (String) —

    The identifier of the resource.

  • :job_id (String) —

    The identifier of the job.

  • :managed_database_id (String) —

    The OCID of the Managed Database.

  • :managed_database_group_id (String) —

    The OCID of the Managed Database Group.

  • :run_status (String) —

    The status of the job run.

  • :name (String) —

    A filter to return only resources that match the entire name.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for u2018TIMECREATEDu2019 is descending and the default sort order for u2018NAMEu2019 is ascending. The u2018NAMEu2019 sort order is case-sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, NAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

Returns:



8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
 
# File 'lib/oci/database_management/db_management_client.rb', line 8101

def list_job_runs(compartment_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_job_runs.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_job_runs." if compartment_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED NAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, NAME.'
  end

  if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end

  path = '/jobRuns'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:jobId] = opts[:job_id] if opts[:job_id]
  query_params[:managedDatabaseId] = opts[:managed_database_id] if opts[:managed_database_id]
  query_params[:managedDatabaseGroupId] = opts[:managed_database_group_id] if opts[:managed_database_group_id]
  query_params[:runStatus] = opts[:run_status] if opts[:run_status]
  query_params[:name] = opts[:name] if opts[: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]

  # 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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_job_runs') 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::DatabaseManagement::Models::JobRunCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_jobs(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_jobs API.

Gets the job for a specific ID or the list of jobs for a Managed Database or Managed Database Group in a specific compartment. Only one of the parameters, ID, managedDatabaseId or managedDatabaseGroupId, should be provided. If none of these parameters is provided, all the jobs in the compartment are listed. Jobs can also be filtered based on the name and lifecycleState parameters.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :id (String) —

    The identifier of the resource.

  • :managed_database_group_id (String) —

    The OCID of the Managed Database Group.

  • :managed_database_id (String) —

    The OCID of the Managed Database.

  • :name (String) —

    A filter to return only resources that match the entire name.

  • :lifecycle_state (String) —

    The lifecycle state of the job.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for u2018TIMECREATEDu2019 is descending and the default sort order for u2018NAMEu2019 is ascending. The u2018NAMEu2019 sort order is case-sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, NAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

Returns:



8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
 
# File 'lib/oci/database_management/db_management_client.rb', line 8192

def list_jobs(compartment_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_jobs.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_jobs." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::DatabaseManagement::Models::Job::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DatabaseManagement::Models::Job::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_by] && !%w[TIMECREATED NAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, NAME.'
  end

  if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end

  path = '/jobs'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:managedDatabaseGroupId] = opts[:managed_database_group_id] if opts[:managed_database_group_id]
  query_params[:managedDatabaseId] = opts[:managed_database_id] if opts[:managed_database_id]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#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::DatabaseManagement::Models::JobCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_managed_database_groups(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_managed_database_groups API.

Gets the Managed Database Group for a specific ID or the list of Managed Database Groups in a specific compartment. Managed Database Groups can also be filtered based on the name parameter. Only one of the parameters, ID or name should be provided. If none of these parameters is provided, all the Managed Database Groups in the compartment are listed.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :id (String) —

    The identifier of the resource.

  • :name (String) —

    A filter to return only resources that match the entire name.

  • :lifecycle_state (String) —

    The lifecycle state of a resource.

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for u2018TIMECREATEDu2019 is descending and the default sort order for u2018NAMEu2019 is ascending. The u2018NAMEu2019 sort order is case-sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, NAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

Returns:



8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
 
# File 'lib/oci/database_management/db_management_client.rb', line 8284

def list_managed_database_groups(compartment_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_managed_database_groups.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_managed_database_groups." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::DatabaseManagement::Models::LIFECYCLE_STATES_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DatabaseManagement::Models::LIFECYCLE_STATES_ENUM.'
  end

  if opts[:sort_by] && !%w[TIMECREATED NAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, NAME.'
  end

  if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end

  path = '/managedDatabaseGroups'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_managed_database_groups') 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::DatabaseManagement::Models::ManagedDatabaseGroupCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_managed_databases(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_managed_databases API.

Gets the Managed Database for a specific ID or the list of Managed Databases in a specific compartment. Managed Databases can be filtered based on the name parameter. Only one of the parameters, ID or name should be provided. If neither of these parameters is provided, all the Managed Databases in the compartment are listed. Managed Databases can also be filtered based on the deployment type and management option. If the deployment type is not specified or if it is ONPREMISE, then the management option is not considered and Managed Databases with ADVANCED management option are listed.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :id (String) —

    The identifier of the resource.

  • :name (String) —

    A filter to return only resources that match the entire name.

  • :management_option (String) —

    A filter to return Managed Databases with the specified management option.

  • :deployment_type (String) —

    A filter to return Managed Databases of the specified deployment type.

  • :external_exadata_infrastructure_id (String) —

    The OCID of the Exadata infrastructure.

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for u2018TIMECREATEDu2019 is descending and the default sort order for u2018NAMEu2019 is ascending. The u2018NAMEu2019 sort order is case-sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, NAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

Returns:



8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
 
# File 'lib/oci/database_management/db_management_client.rb', line 8378

def list_managed_databases(compartment_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_managed_databases.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_managed_databases." if compartment_id.nil?

  if opts[:management_option] && !OCI::DatabaseManagement::Models::MANAGEMENT_OPTION_ENUM.include?(opts[:management_option])
    raise 'Invalid value for "management_option", must be one of the values in OCI::DatabaseManagement::Models::MANAGEMENT_OPTION_ENUM.'
  end

  if opts[:deployment_type] && !OCI::DatabaseManagement::Models::DEPLOYMENT_TYPE_ENUM.include?(opts[:deployment_type])
    raise 'Invalid value for "deployment_type", must be one of the values in OCI::DatabaseManagement::Models::DEPLOYMENT_TYPE_ENUM.'
  end

  if opts[:sort_by] && !%w[TIMECREATED NAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, NAME.'
  end

  if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end

  path = '/managedDatabases'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:managementOption] = opts[:management_option] if opts[:management_option]
  query_params[:deploymentType] = opts[:deployment_type] if opts[:deployment_type]
  query_params[:externalExadataInfrastructureId] = opts[:external_exadata_infrastructure_id] if opts[:external_exadata_infrastructure_id]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_managed_databases') 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::DatabaseManagement::Models::ManagedDatabaseCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_object_privileges(managed_database_id, user_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_object_privileges API.

Gets the list of object privileges granted to a specific user.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • user_name (String) —

    The name of the user whose details are to be viewed.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :name (String) —

    A filter to return only resources that match the entire name.

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for u2018NAMEu2019 is ascending. The u2018NAMEu2019 sort order is case-sensitive. (default to NAME) Allowed values are: NAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

Returns:



8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
 
# File 'lib/oci/database_management/db_management_client.rb', line 8468

def list_object_privileges(managed_database_id, user_name, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_object_privileges.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling list_object_privileges." if managed_database_id.nil?
  raise "Missing the required parameter 'user_name' when calling list_object_privileges." if user_name.nil?

  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::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'user_name' must not be blank" if OCI::Internal::Util.blank_string?(user_name)

  path = '/managedDatabases/{managedDatabaseId}/users/{userName}/objectPrivileges'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{userName}', user_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:name] = opts[:name] if opts[: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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_object_privileges') 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::DatabaseManagement::Models::ObjectPrivilegeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_optimizer_statistics_advisor_executions(managed_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_optimizer_statistics_advisor_executions API.

Lists the details of the Optimizer Statistics Advisor task executions, such as their duration, and the number of findings, if any. Optionally, you can specify a date-time range (of seven days) to obtain the list of executions that fall within the specified time range. If the date-time range is not specified, then the executions in the last seven days are listed.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :start_time_greater_than_or_equal_to (String) —

    The start time of the time range to retrieve the optimizer statistics of a Managed Database in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'".

  • :end_time_less_than_or_equal_to (String) —

    The end time of the time range to retrieve the optimizer statistics of a Managed Database in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'".

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
 
# File 'lib/oci/database_management/db_management_client.rb', line 8546

def list_optimizer_statistics_advisor_executions(managed_database_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_optimizer_statistics_advisor_executions.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling list_optimizer_statistics_advisor_executions." if managed_database_id.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/optimizerStatisticsAdvisorExecutions'.sub('{managedDatabaseId}', managed_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:startTimeGreaterThanOrEqualTo] = opts[:start_time_greater_than_or_equal_to] if opts[:start_time_greater_than_or_equal_to]
  query_params[:endTimeLessThanOrEqualTo] = opts[:end_time_less_than_or_equal_to] if opts[:end_time_less_than_or_equal_to]

  # 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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_optimizer_statistics_advisor_executions') 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::DatabaseManagement::Models::OptimizerStatisticsAdvisorExecutionsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_optimizer_statistics_collection_aggregations(managed_database_id, group_type, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_optimizer_statistics_collection_aggregations API.

Gets a list of the optimizer statistics collection operations per hour, grouped by task or object status for the specified Managed Database. You must specify a value for GroupByQueryParam to determine whether the data should be grouped by task status or task object status. Optionally, you can specify a date-time range (of seven days) to obtain collection aggregations within the specified time range. If the date-time range is not specified, then the operations in the last seven days are listed. You can further filter the results by providing the optional type of TaskTypeQueryParam. If the task type not provided, then both Auto and Manual tasks are considered for aggregation.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • group_type (String) —

    The optimizer statistics tasks grouped by type.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :start_time_greater_than_or_equal_to (String) —

    The start time of the time range to retrieve the optimizer statistics of a Managed Database in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'".

  • :end_time_less_than_or_equal_to (String) —

    The end time of the time range to retrieve the optimizer statistics of a Managed Database in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'".

  • :task_type (String) —

    The filter types of the optimizer statistics tasks.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

Returns:



8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
 
# File 'lib/oci/database_management/db_management_client.rb', line 8620

def list_optimizer_statistics_collection_aggregations(managed_database_id, group_type, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_optimizer_statistics_collection_aggregations.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling list_optimizer_statistics_collection_aggregations." if managed_database_id.nil?
  raise "Missing the required parameter 'group_type' when calling list_optimizer_statistics_collection_aggregations." if group_type.nil?
  unless OCI::DatabaseManagement::Models::OPTIMIZER_STATISTICS_GROUP_BY_TYPES_ENUM.include?(group_type)
    raise 'Invalid value for "group_type", must be one of the values in OCI::DatabaseManagement::Models::OPTIMIZER_STATISTICS_GROUP_BY_TYPES_ENUM.'
  end


  if opts[:task_type] && !OCI::DatabaseManagement::Models::OPTIMIZER_STATISTICS_TASK_FILTER_TYPES_ENUM.include?(opts[:task_type])
    raise 'Invalid value for "task_type", must be one of the values in OCI::DatabaseManagement::Models::OPTIMIZER_STATISTICS_TASK_FILTER_TYPES_ENUM.'
  end
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/optimizerStatisticsCollectionAggregations'.sub('{managedDatabaseId}', managed_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:groupType] = group_type
  query_params[:startTimeGreaterThanOrEqualTo] = opts[:start_time_greater_than_or_equal_to] if opts[:start_time_greater_than_or_equal_to]
  query_params[:endTimeLessThanOrEqualTo] = opts[:end_time_less_than_or_equal_to] if opts[:end_time_less_than_or_equal_to]
  query_params[:taskType] = opts[:task_type] if opts[:task_type]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_optimizer_statistics_collection_aggregations') 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::DatabaseManagement::Models::OptimizerStatisticsCollectionAggregationsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_optimizer_statistics_collection_operations(managed_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_optimizer_statistics_collection_operations API.

Lists the Optimizer Statistics Collection (Auto and Manual) task operation summary for the specified Managed Database. The summary includes the details of each operation and the number of tasks grouped by status: Completed, In Progress, Failed, and so on. Optionally, you can specify a date-time range (of seven days) to obtain the list of operations that fall within the specified time range. If the date-time range is not specified, then the operations in the last seven days are listed. This API also enables the pagination of results and the opc-next-page response header indicates whether there is a next page. If you use the same header value in a consecutive request, the next page records are returned. To obtain the required results, you can apply the different types of filters supported by this API.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :start_time_greater_than_or_equal_to (String) —

    The start time of the time range to retrieve the optimizer statistics of a Managed Database in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'".

  • :end_time_less_than_or_equal_to (String) —

    The end time of the time range to retrieve the optimizer statistics of a Managed Database in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'".

  • :task_type (String) —

    The filter types of the optimizer statistics tasks.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :filter_by (String) —

    The parameter used to filter the optimizer statistics operations. Any property of the OptimizerStatisticsCollectionOperationSummary can be used to define the filter condition. The allowed conditional operators are AND or OR, and the allowed binary operators are are >, < and =. Any other operator is regarded invalid. Example: jobName=<replace with job name> AND status=<replace with status>

  • :sort_by (String) —

    Sorts the list of optimizer statistics operations based on a specific attribute. (default to START_TIME) Allowed values are: START_TIME, END_TIME, STATUS

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
 
# File 'lib/oci/database_management/db_management_client.rb', line 8715

def list_optimizer_statistics_collection_operations(managed_database_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_optimizer_statistics_collection_operations.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling list_optimizer_statistics_collection_operations." if managed_database_id.nil?

  if opts[:task_type] && !OCI::DatabaseManagement::Models::OPTIMIZER_STATISTICS_TASK_FILTER_TYPES_ENUM.include?(opts[:task_type])
    raise 'Invalid value for "task_type", must be one of the values in OCI::DatabaseManagement::Models::OPTIMIZER_STATISTICS_TASK_FILTER_TYPES_ENUM.'
  end

  if opts[:sort_by] && !%w[START_TIME END_TIME STATUS].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of START_TIME, END_TIME, STATUS.'
  end

  if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/optimizerStatisticsCollectionOperations'.sub('{managedDatabaseId}', managed_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:startTimeGreaterThanOrEqualTo] = opts[:start_time_greater_than_or_equal_to] if opts[:start_time_greater_than_or_equal_to]
  query_params[:endTimeLessThanOrEqualTo] = opts[:end_time_less_than_or_equal_to] if opts[:end_time_less_than_or_equal_to]
  query_params[:taskType] = opts[:task_type] if opts[:task_type]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:filterBy] = opts[:filter_by] if opts[:filter_by]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_optimizer_statistics_collection_operations') 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::DatabaseManagement::Models::OptimizerStatisticsCollectionOperationsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_preferred_credentials(managed_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_preferred_credentials API.

Gets the list of preferred credentials for a given Managed Database.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
 
# File 'lib/oci/database_management/db_management_client.rb', line 8790

def list_preferred_credentials(managed_database_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_preferred_credentials.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling list_preferred_credentials." if managed_database_id.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/preferredCredentials'.sub('{managedDatabaseId}', managed_database_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_preferred_credentials') 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::DatabaseManagement::Models::PreferredCredentialCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_proxied_for_users(managed_database_id, user_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_proxied_for_users API.

Gets the list of users on whose behalf the current user acts as proxy.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • user_name (String) —

    The name of the user whose details are to be viewed.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :name (String) —

    A filter to return only resources that match the entire name.

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for u2018NAMEu2019 is ascending. The u2018NAMEu2019 sort order is case-sensitive. (default to NAME) Allowed values are: NAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

Returns:



8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
 
# File 'lib/oci/database_management/db_management_client.rb', line 8855

def list_proxied_for_users(managed_database_id, user_name, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_proxied_for_users.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling list_proxied_for_users." if managed_database_id.nil?
  raise "Missing the required parameter 'user_name' when calling list_proxied_for_users." if user_name.nil?

  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::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'user_name' must not be blank" if OCI::Internal::Util.blank_string?(user_name)

  path = '/managedDatabases/{managedDatabaseId}/users/{userName}/proxiedForUsers'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{userName}', user_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:name] = opts[:name] if opts[: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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_proxied_for_users') 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::DatabaseManagement::Models::ProxiedForUserCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_proxy_users(managed_database_id, user_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_proxy_users API.

Gets the list of proxy users for the current user.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • user_name (String) —

    The name of the user whose details are to be viewed.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :name (String) —

    A filter to return only resources that match the entire name.

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for u2018NAMEu2019 is ascending. The u2018NAMEu2019 sort order is case-sensitive. (default to NAME) Allowed values are: NAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

Returns:



8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
 
# File 'lib/oci/database_management/db_management_client.rb', line 8935

def list_proxy_users(managed_database_id, user_name, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_proxy_users.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling list_proxy_users." if managed_database_id.nil?
  raise "Missing the required parameter 'user_name' when calling list_proxy_users." if user_name.nil?

  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::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'user_name' must not be blank" if OCI::Internal::Util.blank_string?(user_name)

  path = '/managedDatabases/{managedDatabaseId}/users/{userName}/proxyUsers'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{userName}', user_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:name] = opts[:name] if opts[: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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_proxy_users') 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::DatabaseManagement::Models::ProxyUserCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_roles(managed_database_id, user_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_roles API.

Gets the list of roles granted to a specific user.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • user_name (String) —

    The name of the user whose details are to be viewed.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :name (String) —

    A filter to return only resources that match the entire name.

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for u2018NAMEu2019 is ascending. The u2018NAMEu2019 sort order is case-sensitive. (default to NAME) Allowed values are: NAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

Returns:



9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
 
# File 'lib/oci/database_management/db_management_client.rb', line 9015

def list_roles(managed_database_id, user_name, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_roles.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling list_roles." if managed_database_id.nil?
  raise "Missing the required parameter 'user_name' when calling list_roles." if user_name.nil?

  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::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'user_name' must not be blank" if OCI::Internal::Util.blank_string?(user_name)

  path = '/managedDatabases/{managedDatabaseId}/users/{userName}/roles'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{userName}', user_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:name] = opts[:name] if opts[: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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_roles') 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::DatabaseManagement::Models::RoleCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sql_plan_baseline_jobs(managed_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sql_plan_baseline_jobs API.

Lists the database jobs used for loading SQL plan baselines in the specified Managed Database.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :name (String) —

    A filter to return the SQL plan baseline jobs that match the name.

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for u2018TIMECREATEDu2019 is descending and the default sort order for u2018NAMEu2019 is ascending. The u2018NAMEu2019 sort order is case-sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, NAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
 
# File 'lib/oci/database_management/db_management_client.rb', line 9096

def list_sql_plan_baseline_jobs(managed_database_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_sql_plan_baseline_jobs.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling list_sql_plan_baseline_jobs." if managed_database_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED NAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, NAME.'
  end

  if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/sqlPlanBaselineJobs'.sub('{managedDatabaseId}', managed_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_sql_plan_baseline_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::DatabaseManagement::Models::SqlPlanBaselineJobCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sql_plan_baselines(managed_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sql_plan_baselines API.

Lists the SQL plan baselines for the specified Managed Database.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :plan_name (String) —

    A filter to return only SQL plan baselines that match the plan name.

  • :sql_handle (String) —

    A filter to return all the SQL plan baselines for the specified SQL handle.

  • :sql_text (String) —

    A filter to return all the SQL plan baselines that match the SQL text. By default, the search is case insensitive. To run an exact or case-sensitive search, double-quote the search string. You may also use the '%' symbol as a wildcard.

  • :is_enabled (BOOLEAN) —

    A filter to return only SQL plan baselines that are either enabled or not enabled. By default, all SQL plan baselines are returned.

  • :is_accepted (BOOLEAN) —

    A filter to return only SQL plan baselines that are either accepted or not accepted. By default, all SQL plan baselines are returned.

  • :is_reproduced (BOOLEAN) —

    A filter to return only SQL plan baselines that were either reproduced or not reproduced by the optimizer. By default, all SQL plan baselines are returned.

  • :is_fixed (BOOLEAN) —

    A filter to return only SQL plan baselines that are either fixed or not fixed. By default, all SQL plan baselines are returned.

  • :is_adaptive (BOOLEAN) —

    A filter to return only SQL plan baselines that are either adaptive or not adaptive. By default, all SQL plan baselines are returned.

  • :origin (String) —

    A filter to return all the SQL plan baselines that match the origin.

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :sort_by (String) —

    The option to sort the SQL plan baseline summary data. (default to timeCreated) Allowed values are: timeCreated, timeLastModified

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Descending order is the default order. (default to DESC)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
 
# File 'lib/oci/database_management/db_management_client.rb', line 9193

def list_sql_plan_baselines(managed_database_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_sql_plan_baselines.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling list_sql_plan_baselines." if managed_database_id.nil?

  if opts[:origin] && !OCI::DatabaseManagement::Models::SQL_PLAN_BASELINE_ORIGIN_ENUM.include?(opts[:origin])
    raise 'Invalid value for "origin", must be one of the values in OCI::DatabaseManagement::Models::SQL_PLAN_BASELINE_ORIGIN_ENUM.'
  end

  if opts[:sort_by] && !%w[timeCreated timeLastModified].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, timeLastModified.'
  end

  if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/sqlPlanBaselines'.sub('{managedDatabaseId}', managed_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:planName] = opts[:plan_name] if opts[:plan_name]
  query_params[:sqlHandle] = opts[:sql_handle] if opts[:sql_handle]
  query_params[:sqlText] = opts[:sql_text] if opts[:sql_text]
  query_params[:isEnabled] = opts[:is_enabled] if !opts[:is_enabled].nil?
  query_params[:isAccepted] = opts[:is_accepted] if !opts[:is_accepted].nil?
  query_params[:isReproduced] = opts[:is_reproduced] if !opts[:is_reproduced].nil?
  query_params[:isFixed] = opts[:is_fixed] if !opts[:is_fixed].nil?
  query_params[:isAdaptive] = opts[:is_adaptive] if !opts[:is_adaptive].nil?
  query_params[:origin] = opts[:origin] if opts[:origin]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_sql_plan_baselines') 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::DatabaseManagement::Models::SqlPlanBaselineCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_system_privileges(managed_database_id, user_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_system_privileges API.

Gets the list of system privileges granted to a specific user.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • user_name (String) —

    The name of the user whose details are to be viewed.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :name (String) —

    A filter to return only resources that match the entire name.

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for u2018NAMEu2019 is ascending. The u2018NAMEu2019 sort order is case-sensitive. (default to NAME) Allowed values are: NAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

Returns:



9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
 
# File 'lib/oci/database_management/db_management_client.rb', line 9283

def list_system_privileges(managed_database_id, user_name, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_system_privileges.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling list_system_privileges." if managed_database_id.nil?
  raise "Missing the required parameter 'user_name' when calling list_system_privileges." if user_name.nil?

  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::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'user_name' must not be blank" if OCI::Internal::Util.blank_string?(user_name)

  path = '/managedDatabases/{managedDatabaseId}/users/{userName}/systemPrivileges'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{userName}', user_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:name] = opts[:name] if opts[: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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_system_privileges') 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::DatabaseManagement::Models::SystemPrivilegeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_table_statistics(managed_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_table_statistics API.

Lists the database table statistics grouped by different statuses such as Not Stale Stats, Stale Stats, and No Stats. This also includes the percentage of each status.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
 
# File 'lib/oci/database_management/db_management_client.rb', line 9354

def list_table_statistics(managed_database_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_table_statistics.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling list_table_statistics." if managed_database_id.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/tableStatistics'.sub('{managedDatabaseId}', managed_database_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_table_statistics') 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::DatabaseManagement::Models::TableStatisticsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_tablespaces(managed_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_tablespaces API.

Gets the list of tablespaces for the specified managedDatabaseId.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :name (String) —

    A filter to return only resources that match the entire name.

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for u2018TIMECREATEDu2019 is descending and the default sort order for u2018NAMEu2019 is ascending. The u2018NAMEu2019 sort order is case-sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, NAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

Returns:



9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
 
# File 'lib/oci/database_management/db_management_client.rb', line 9419

def list_tablespaces(managed_database_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_tablespaces.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling list_tablespaces." if managed_database_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED NAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, NAME.'
  end

  if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/tablespaces'.sub('{managedDatabaseId}', managed_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]

  # 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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_tablespaces') 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::DatabaseManagement::Models::TablespaceCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_users(managed_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_users API.

Gets the list of users for the specified managedDatabaseId.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :name (String) —

    A filter to return only resources that match the entire name.

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for u2018TIMECREATEDu2019 is descending and the default sort order for u2018NAMEu2019 is ascending. The u2018NAMEu2019 sort order is case-sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, NAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

Returns:



9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
 
# File 'lib/oci/database_management/db_management_client.rb', line 9497

def list_users(managed_database_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#list_users.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling list_users." if managed_database_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED NAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, NAME.'
  end

  if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/users'.sub('{managedDatabaseId}', managed_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:name] = opts[:name] if opts[: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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#list_users') 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::DatabaseManagement::Models::UserCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_request_errors(work_request_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_work_request_errors API.

Returns a paginated list of errors for a given work request.

Allowed values are: timeAccepted

Parameters:

  • work_request_id (String) —

    The OCID of the asynchronous work request.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided and the default order for timeAccepted is descending. (default to timeAccepted)

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

Returns:



9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
 
# File 'lib/oci/database_management/db_management_client.rb', line 9573

def list_work_request_errors(work_request_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#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[timeAccepted].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeAccepted.'
  end

  if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::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[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#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::DatabaseManagement::Models::WorkRequestErrorCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_request_logs(work_request_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_work_request_logs API.

Returns a paginated list of logs for a given work request.

Allowed values are: timeAccepted

Parameters:

  • work_request_id (String) —

    The OCID of the asynchronous work request.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided and the default order for timeAccepted is descending. (default to timeAccepted)

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

Returns:



9648
9649
9650
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
 
# File 'lib/oci/database_management/db_management_client.rb', line 9648

def list_work_request_logs(work_request_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#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[timeAccepted].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeAccepted.'
  end

  if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::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[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#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::DatabaseManagement::Models::WorkRequestLogEntryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_requests(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_work_requests API.

The list of work requests in a specific compartment was retrieved successfully.

Allowed values are: timeAccepted

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :resource_id (String) —

    The OCID of the resource affected by the work request.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :work_request_id (String) —

    The OCID of the asynchronous work request.

  • :status (String) —

    A filter that returns the resources whose status matches the given WorkRequestStatus.

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided and the default order for timeAccepted is descending. (default to timeAccepted)

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

Returns:



9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
9776
9777
9778
9779
9780
9781
 
# File 'lib/oci/database_management/db_management_client.rb', line 9726

def list_work_requests(compartment_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#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::DatabaseManagement::Models::WORK_REQUEST_STATUS_ENUM.include?(opts[:status])
    raise 'Invalid value for "status", must be one of the values in OCI::DatabaseManagement::Models::WORK_REQUEST_STATUS_ENUM.'
  end

  if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end

  if opts[:sort_by] && !%w[timeAccepted].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeAccepted.'
  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[:workRequestId] = opts[:work_request_id] if opts[:work_request_id]
  query_params[:status] = opts[:status] if opts[:status]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]

  # 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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#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::DatabaseManagement::Models::WorkRequestCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#load_sql_plan_baselines_from_awr(managed_database_id, load_sql_plan_baselines_from_awr_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use load_sql_plan_baselines_from_awr API.

Loads plans from Automatic Workload Repository (AWR) snapshots. You must specify the beginning and ending of the snapshot range. Optionally, you can apply a filter to load only plans that meet specified criteria. By default, the optimizer uses the loaded plans the next time that the database executes the SQL statements.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
 
# File 'lib/oci/database_management/db_management_client.rb', line 9805

def load_sql_plan_baselines_from_awr(managed_database_id, load_sql_plan_baselines_from_awr_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#load_sql_plan_baselines_from_awr.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling load_sql_plan_baselines_from_awr." if managed_database_id.nil?
  raise "Missing the required parameter 'load_sql_plan_baselines_from_awr_details' when calling load_sql_plan_baselines_from_awr." if load_sql_plan_baselines_from_awr_details.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/loadSqlPlanBaselinesFromAwr'.sub('{managedDatabaseId}', managed_database_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 = @api_client.object_to_http_body(load_sql_plan_baselines_from_awr_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#load_sql_plan_baselines_from_awr') 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::DatabaseManagement::Models::SqlPlanBaselineJob'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#load_sql_plan_baselines_from_cursor_cache(managed_database_id, load_sql_plan_baselines_from_cursor_cache_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use load_sql_plan_baselines_from_cursor_cache API.

Loads plans for statements directly from the shared SQL area, also called the cursor cache. By applying a filter on the module name, the schema, or the SQL ID you identify the SQL statement or set of SQL statements to load.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



9864
9865
9866
9867
9868
9869
9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
 
# File 'lib/oci/database_management/db_management_client.rb', line 9864

def load_sql_plan_baselines_from_cursor_cache(managed_database_id, load_sql_plan_baselines_from_cursor_cache_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#load_sql_plan_baselines_from_cursor_cache.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling load_sql_plan_baselines_from_cursor_cache." if managed_database_id.nil?
  raise "Missing the required parameter 'load_sql_plan_baselines_from_cursor_cache_details' when calling load_sql_plan_baselines_from_cursor_cache." if load_sql_plan_baselines_from_cursor_cache_details.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/loadSqlPlanBaselinesFromCursorCache'.sub('{managedDatabaseId}', managed_database_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 = @api_client.object_to_http_body(load_sql_plan_baselines_from_cursor_cache_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#load_sql_plan_baselines_from_cursor_cache') 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::DatabaseManagement::Models::SqlPlanBaselineJob'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



96
97
98
 
# File 'lib/oci/database_management/db_management_client.rb', line 96

def logger
  @api_client.config.logger
end

#patch_external_db_system_discovery(external_db_system_discovery_id, patch_external_db_system_discovery_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_external_db_system_discovery API.

Patches the external DB system discovery specified by externalDbSystemDiscoveryId.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
 
# File 'lib/oci/database_management/db_management_client.rb', line 9927

def patch_external_db_system_discovery(external_db_system_discovery_id, patch_external_db_system_discovery_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#patch_external_db_system_discovery.' if logger

  raise "Missing the required parameter 'external_db_system_discovery_id' when calling patch_external_db_system_discovery." if external_db_system_discovery_id.nil?
  raise "Missing the required parameter 'patch_external_db_system_discovery_details' when calling patch_external_db_system_discovery." if patch_external_db_system_discovery_details.nil?
  raise "Parameter value for 'external_db_system_discovery_id' must not be blank" if OCI::Internal::Util.blank_string?(external_db_system_discovery_id)

  path = '/externalDbSystemDiscoveries/{externalDbSystemDiscoveryId}'.sub('{externalDbSystemDiscoveryId}', external_db_system_discovery_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(patch_external_db_system_discovery_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#patch_external_db_system_discovery') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DatabaseManagement::Models::ExternalDbSystemDiscovery'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#remove_data_file(managed_database_id, tablespace_name, remove_data_file_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use remove_data_file API.

Removes a data file or temp file from the tablespace.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • tablespace_name (String) —

    The name of the tablespace.

  • remove_data_file_details (OCI::DatabaseManagement::Models::RemoveDataFileDetails) —

    The details required to remove a data file or temp file from the tablespace.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
 
# File 'lib/oci/database_management/db_management_client.rb', line 9993

def remove_data_file(managed_database_id, tablespace_name, remove_data_file_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#remove_data_file.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling remove_data_file." if managed_database_id.nil?
  raise "Missing the required parameter 'tablespace_name' when calling remove_data_file." if tablespace_name.nil?
  raise "Missing the required parameter 'remove_data_file_details' when calling remove_data_file." if remove_data_file_details.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'tablespace_name' must not be blank" if OCI::Internal::Util.blank_string?(tablespace_name)

  path = '/managedDatabases/{managedDatabaseId}/tablespaces/{tablespaceName}/actions/removeDataFile'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{tablespaceName}', tablespace_name.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]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(remove_data_file_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#remove_data_file') 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::DatabaseManagement::Models::TablespaceAdminStatus'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#remove_managed_database_from_managed_database_group(managed_database_group_id, remove_managed_database_from_managed_database_group_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use remove_managed_database_from_managed_database_group API.

Removes a Managed Database from a Managed Database Group. Any management activities that are currently running on this database will continue to run to completion. However, any activities scheduled to run in the future will not be performed on this database.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



10063
10064
10065
10066
10067
10068
10069
10070
10071
10072
10073
10074
10075
10076
10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
10087
10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
10100
10101
 
# File 'lib/oci/database_management/db_management_client.rb', line 10063

def remove_managed_database_from_managed_database_group(managed_database_group_id, remove_managed_database_from_managed_database_group_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#remove_managed_database_from_managed_database_group.' if logger

  raise "Missing the required parameter 'managed_database_group_id' when calling remove_managed_database_from_managed_database_group." if managed_database_group_id.nil?
  raise "Missing the required parameter 'remove_managed_database_from_managed_database_group_details' when calling remove_managed_database_from_managed_database_group." if remove_managed_database_from_managed_database_group_details.nil?
  raise "Parameter value for 'managed_database_group_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_group_id)

  path = '/managedDatabaseGroups/{managedDatabaseGroupId}/actions/removeManagedDatabase'.sub('{managedDatabaseGroupId}', managed_database_group_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]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(remove_managed_database_from_managed_database_group_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#remove_managed_database_from_managed_database_group') 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

#reset_database_parameters(managed_database_id, reset_database_parameters_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use reset_database_parameters API.

Resets database parameter values to their default or startup values.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



10127
10128
10129
10130
10131
10132
10133
10134
10135
10136
10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
 
# File 'lib/oci/database_management/db_management_client.rb', line 10127

def reset_database_parameters(managed_database_id, reset_database_parameters_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#reset_database_parameters.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling reset_database_parameters." if managed_database_id.nil?
  raise "Missing the required parameter 'reset_database_parameters_details' when calling reset_database_parameters." if reset_database_parameters_details.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/actions/resetDatabaseParameters'.sub('{managedDatabaseId}', managed_database_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]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(reset_database_parameters_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#reset_database_parameters') 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::DatabaseManagement::Models::UpdateDatabaseParametersResult'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#resize_data_file(managed_database_id, tablespace_name, resize_data_file_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use resize_data_file API.

Resizes a data file or temp file within the tablespace.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • tablespace_name (String) —

    The name of the tablespace.

  • resize_data_file_details (OCI::DatabaseManagement::Models::ResizeDataFileDetails) —

    The details required to resize a data file or temp file within the tablespace.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



10194
10195
10196
10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
10235
 
# File 'lib/oci/database_management/db_management_client.rb', line 10194

def resize_data_file(managed_database_id, tablespace_name, resize_data_file_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#resize_data_file.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling resize_data_file." if managed_database_id.nil?
  raise "Missing the required parameter 'tablespace_name' when calling resize_data_file." if tablespace_name.nil?
  raise "Missing the required parameter 'resize_data_file_details' when calling resize_data_file." if resize_data_file_details.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'tablespace_name' must not be blank" if OCI::Internal::Util.blank_string?(tablespace_name)

  path = '/managedDatabases/{managedDatabaseId}/tablespaces/{tablespaceName}/actions/resizeDataFile'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{tablespaceName}', tablespace_name.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]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(resize_data_file_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#resize_data_file') 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::DatabaseManagement::Models::TablespaceAdminStatus'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#run_historic_addm(managed_database_id, run_historic_addm_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use run_historic_addm API.

Creates and executes a historic ADDM task using the specified AWR snapshot IDs. If an existing ADDM task uses the provided awr snapshot IDs, the existing task will be returned.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • run_historic_addm_details (OCI::DatabaseManagement::Models::RunHistoricAddmDetails) —

    The details of the ADDM task, which include the beginning and ending AWR snapshot IDs.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



10263
10264
10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
 
# File 'lib/oci/database_management/db_management_client.rb', line 10263

def run_historic_addm(managed_database_id, run_historic_addm_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#run_historic_addm.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling run_historic_addm." if managed_database_id.nil?
  raise "Missing the required parameter 'run_historic_addm_details' when calling run_historic_addm." if run_historic_addm_details.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/actions/runHistoricAddm'.sub('{managedDatabaseId}', managed_database_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]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(run_historic_addm_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#run_historic_addm') 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::DatabaseManagement::Models::HistoricAddmResult'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_awr_db_cpu_usages(managed_database_id, awr_db_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use summarize_awr_db_cpu_usages API.

Summarizes the AWR CPU resource limits and metrics for the specified database in AWR.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • awr_db_id (String) —

    The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/managedDatabaseId/awrDbs

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :inst_num (String) —

    The optional single value query parameter to filter the database instance number.

  • :begin_sn_id_greater_than_or_equal_to (Integer) —

    The optional greater than or equal to filter on the snapshot ID.

  • :end_sn_id_less_than_or_equal_to (Integer) —

    The optional less than or equal to query parameter to filter the snapshot ID.

  • :time_greater_than_or_equal_to (DateTime) —

    The optional greater than or equal to query parameter to filter the timestamp.

  • :time_less_than_or_equal_to (DateTime) —

    The optional less than or equal to query parameter to filter the timestamp.

  • :session_type (String) —

    The optional query parameter to filter ASH activities by FOREGROUND or BACKGROUND. (default to FOREGROUND) Allowed values are: FOREGROUND, BACKGROUND, ALL

  • :container_id (Integer) —

    The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/managedDatabaseId/awrDbSnapshotRanges

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in large paginated response. (default to 1000)

  • :sort_by (String) —

    The option to sort the AWR CPU usage summary data. (default to TIME_SAMPLED) Allowed values are: TIME_SAMPLED, AVG_VALUE

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Descending order is the default order. (default to DESC)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
10370
10371
10372
10373
10374
10375
10376
10377
10378
10379
10380
10381
10382
10383
10384
10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
 
# File 'lib/oci/database_management/db_management_client.rb', line 10349

def summarize_awr_db_cpu_usages(managed_database_id, awr_db_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#summarize_awr_db_cpu_usages.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling summarize_awr_db_cpu_usages." if managed_database_id.nil?
  raise "Missing the required parameter 'awr_db_id' when calling summarize_awr_db_cpu_usages." if awr_db_id.nil?

  if opts[:session_type] && !%w[FOREGROUND BACKGROUND ALL].include?(opts[:session_type])
    raise 'Invalid value for "session_type", must be one of FOREGROUND, BACKGROUND, ALL.'
  end

  if opts[:sort_by] && !%w[TIME_SAMPLED AVG_VALUE].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_SAMPLED, AVG_VALUE.'
  end

  if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'awr_db_id' must not be blank" if OCI::Internal::Util.blank_string?(awr_db_id)

  path = '/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbCpuUsages'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{awrDbId}', awr_db_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:instNum] = opts[:inst_num] if opts[:inst_num]
  query_params[:beginSnIdGreaterThanOrEqualTo] = opts[:begin_sn_id_greater_than_or_equal_to] if opts[:begin_sn_id_greater_than_or_equal_to]
  query_params[:endSnIdLessThanOrEqualTo] = opts[:end_sn_id_less_than_or_equal_to] if opts[:end_sn_id_less_than_or_equal_to]
  query_params[:timeGreaterThanOrEqualTo] = opts[:time_greater_than_or_equal_to] if opts[:time_greater_than_or_equal_to]
  query_params[:timeLessThanOrEqualTo] = opts[:time_less_than_or_equal_to] if opts[:time_less_than_or_equal_to]
  query_params[:sessionType] = opts[:session_type] if opts[:session_type]
  query_params[:containerId] = opts[:container_id] if opts[:container_id]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#summarize_awr_db_cpu_usages') 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::DatabaseManagement::Models::AwrDbCpuUsageCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_awr_db_metrics(managed_database_id, awr_db_id, name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use summarize_awr_db_metrics API.

Summarizes the metric samples for the specified database in the AWR. The metric samples are summarized based on the Time dimension for each metric.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • awr_db_id (String) —

    The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/managedDatabaseId/awrDbs

  • name (Array<String>) —

    The required multiple value query parameter to filter the entity name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :inst_num (String) —

    The optional single value query parameter to filter the database instance number.

  • :begin_sn_id_greater_than_or_equal_to (Integer) —

    The optional greater than or equal to filter on the snapshot ID.

  • :end_sn_id_less_than_or_equal_to (Integer) —

    The optional less than or equal to query parameter to filter the snapshot ID.

  • :time_greater_than_or_equal_to (DateTime) —

    The optional greater than or equal to query parameter to filter the timestamp.

  • :time_less_than_or_equal_to (DateTime) —

    The optional less than or equal to query parameter to filter the timestamp.

  • :container_id (Integer) —

    The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/managedDatabaseId/awrDbSnapshotRanges

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in large paginated response. (default to 1000)

  • :sort_by (String) —

    The option to sort the AWR time series summary data. (default to TIMESTAMP) Allowed values are: TIMESTAMP, NAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Descending order is the default order. (default to DESC)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



10458
10459
10460
10461
10462
10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
10485
10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
10507
10508
10509
10510
10511
10512
10513
10514
10515
10516
10517
10518
 
# File 'lib/oci/database_management/db_management_client.rb', line 10458

def summarize_awr_db_metrics(managed_database_id, awr_db_id, name, opts = {})
  logger.debug 'Calling operation DbManagementClient#summarize_awr_db_metrics.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling summarize_awr_db_metrics." if managed_database_id.nil?
  raise "Missing the required parameter 'awr_db_id' when calling summarize_awr_db_metrics." if awr_db_id.nil?
  raise "Missing the required parameter 'name' when calling summarize_awr_db_metrics." if name.nil?

  if opts[:sort_by] && !%w[TIMESTAMP NAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMESTAMP, NAME.'
  end

  if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'awr_db_id' must not be blank" if OCI::Internal::Util.blank_string?(awr_db_id)

  path = '/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbMetrics'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{awrDbId}', awr_db_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:name] = OCI::ApiClient.build_collection_params(name, :multi)
  query_params[:instNum] = opts[:inst_num] if opts[:inst_num]
  query_params[:beginSnIdGreaterThanOrEqualTo] = opts[:begin_sn_id_greater_than_or_equal_to] if opts[:begin_sn_id_greater_than_or_equal_to]
  query_params[:endSnIdLessThanOrEqualTo] = opts[:end_sn_id_less_than_or_equal_to] if opts[:end_sn_id_less_than_or_equal_to]
  query_params[:timeGreaterThanOrEqualTo] = opts[:time_greater_than_or_equal_to] if opts[:time_greater_than_or_equal_to]
  query_params[:timeLessThanOrEqualTo] = opts[:time_less_than_or_equal_to] if opts[:time_less_than_or_equal_to]
  query_params[:containerId] = opts[:container_id] if opts[:container_id]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#summarize_awr_db_metrics') 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::DatabaseManagement::Models::AwrDbMetricCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_awr_db_parameter_changes(managed_database_id, awr_db_id, name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use summarize_awr_db_parameter_changes API.

Summarizes the database parameter change history for one database parameter of the specified database in AWR. One change history record contains the previous value, the changed value, and the corresponding time range. If the database parameter value was changed multiple times within the time range, then multiple change history records are created for the same parameter. Note that this API only returns information on change history details for one database parameter. To get a list of all the database parameters whose values were changed during a specified time range, use the following API endpoint: /managedDatabases/managedDatabaseId/awrDbs/awrDbId/awrDbParameters

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • awr_db_id (String) —

    The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/managedDatabaseId/awrDbs

  • name (String) —

    The required single value query parameter to filter the entity name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :inst_num (String) —

    The optional single value query parameter to filter the database instance number.

  • :begin_sn_id_greater_than_or_equal_to (Integer) —

    The optional greater than or equal to filter on the snapshot ID.

  • :end_sn_id_less_than_or_equal_to (Integer) —

    The optional less than or equal to query parameter to filter the snapshot ID.

  • :time_greater_than_or_equal_to (DateTime) —

    The optional greater than or equal to query parameter to filter the timestamp.

  • :time_less_than_or_equal_to (DateTime) —

    The optional less than or equal to query parameter to filter the timestamp.

  • :container_id (Integer) —

    The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/managedDatabaseId/awrDbSnapshotRanges

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in large paginated response. (default to 1000)

  • :sort_by (String) —

    The option to sort the AWR database parameter change history data. (default to IS_CHANGED) Allowed values are: IS_CHANGED, NAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Descending order is the default order. (default to DESC)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



10568
10569
10570
10571
10572
10573
10574
10575
10576
10577
10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
10624
10625
10626
10627
10628
 
# File 'lib/oci/database_management/db_management_client.rb', line 10568

def summarize_awr_db_parameter_changes(managed_database_id, awr_db_id, name, opts = {})
  logger.debug 'Calling operation DbManagementClient#summarize_awr_db_parameter_changes.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling summarize_awr_db_parameter_changes." if managed_database_id.nil?
  raise "Missing the required parameter 'awr_db_id' when calling summarize_awr_db_parameter_changes." if awr_db_id.nil?
  raise "Missing the required parameter 'name' when calling summarize_awr_db_parameter_changes." if name.nil?

  if opts[:sort_by] && !%w[IS_CHANGED NAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of IS_CHANGED, NAME.'
  end

  if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'awr_db_id' must not be blank" if OCI::Internal::Util.blank_string?(awr_db_id)

  path = '/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbParameterChanges'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{awrDbId}', awr_db_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:name] = name
  query_params[:instNum] = opts[:inst_num] if opts[:inst_num]
  query_params[:beginSnIdGreaterThanOrEqualTo] = opts[:begin_sn_id_greater_than_or_equal_to] if opts[:begin_sn_id_greater_than_or_equal_to]
  query_params[:endSnIdLessThanOrEqualTo] = opts[:end_sn_id_less_than_or_equal_to] if opts[:end_sn_id_less_than_or_equal_to]
  query_params[:timeGreaterThanOrEqualTo] = opts[:time_greater_than_or_equal_to] if opts[:time_greater_than_or_equal_to]
  query_params[:timeLessThanOrEqualTo] = opts[:time_less_than_or_equal_to] if opts[:time_less_than_or_equal_to]
  query_params[:containerId] = opts[:container_id] if opts[:container_id]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#summarize_awr_db_parameter_changes') 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::DatabaseManagement::Models::AwrDbParameterChangeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_awr_db_parameters(managed_database_id, awr_db_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use summarize_awr_db_parameters API.

Summarizes the database parameter history for the specified database in AWR. This includes the list of database parameters, with information on whether the parameter values were modified within the query time range. Note that each database parameter is only listed once. Depending on the optional query parameters, the returned summary gets all the database parameters, which include:

  • Each parameter whose value was changed during the time range: (valueChanged ="Y")

  • Each parameter whose value was unchanged during the time range: (valueChanged ="N")

  • Each parameter whose value was changed at the system level during the time range: (valueChanged ="Y" and valueModified = "SYSTEM_MOD")

  • Each parameter whose value was unchanged during the time range, however, the value is not the default value: (valueChanged ="N" and valueDefault = "FALSE")

Note that this API does not return information on the number of times each database parameter has been changed within the time range. To get the database parameter value change history for a specific parameter, use the following API endpoint: /managedDatabases/managedDatabaseId/awrDbs/awrDbId/awrDbParameterChanges

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • awr_db_id (String) —

    The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/managedDatabaseId/awrDbs

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :inst_num (String) —

    The optional single value query parameter to filter the database instance number.

  • :begin_sn_id_greater_than_or_equal_to (Integer) —

    The optional greater than or equal to filter on the snapshot ID.

  • :end_sn_id_less_than_or_equal_to (Integer) —

    The optional less than or equal to query parameter to filter the snapshot ID.

  • :time_greater_than_or_equal_to (DateTime) —

    The optional greater than or equal to query parameter to filter the timestamp.

  • :time_less_than_or_equal_to (DateTime) —

    The optional less than or equal to query parameter to filter the timestamp.

  • :container_id (Integer) —

    The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/managedDatabaseId/awrDbSnapshotRanges

  • :name (Array<String>) —

    The optional multiple value query parameter to filter the entity name.

  • :name_contains (String) —

    The optional contains query parameter to filter the entity name by any part of the name.

  • :value_changed (String) —

    The optional query parameter to filter database parameters whose values were changed. (default to Y) Allowed values are: Y, N

  • :value_default (String) —

    The optional query parameter to filter the database parameters that had the default value in the last snapshot. Allowed values are: TRUE, FALSE

  • :value_modified (String) —

    The optional query parameter to filter the database parameters that had a modified value in the last snapshot. Allowed values are: MODIFIED, SYSTEM_MOD, FALSE

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in large paginated response. (default to 1000)

  • :sort_by (String) —

    The option to sort the AWR database parameter change history data. (default to IS_CHANGED) Allowed values are: IS_CHANGED, NAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Descending order is the default order. (default to DESC)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



10691
10692
10693
10694
10695
10696
10697
10698
10699
10700
10701
10702
10703
10704
10705
10706
10707
10708
10709
10710
10711
10712
10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
10749
10750
10751
10752
10753
10754
10755
10756
10757
10758
10759
10760
10761
10762
10763
10764
10765
10766
 
# File 'lib/oci/database_management/db_management_client.rb', line 10691

def summarize_awr_db_parameters(managed_database_id, awr_db_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#summarize_awr_db_parameters.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling summarize_awr_db_parameters." if managed_database_id.nil?
  raise "Missing the required parameter 'awr_db_id' when calling summarize_awr_db_parameters." if awr_db_id.nil?

  if opts[:value_changed] && !%w[Y N].include?(opts[:value_changed])
    raise 'Invalid value for "value_changed", must be one of Y, N.'
  end

  if opts[:value_default] && !%w[TRUE FALSE].include?(opts[:value_default])
    raise 'Invalid value for "value_default", must be one of TRUE, FALSE.'
  end

  if opts[:value_modified] && !%w[MODIFIED SYSTEM_MOD FALSE].include?(opts[:value_modified])
    raise 'Invalid value for "value_modified", must be one of MODIFIED, SYSTEM_MOD, FALSE.'
  end

  if opts[:sort_by] && !%w[IS_CHANGED NAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of IS_CHANGED, NAME.'
  end

  if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'awr_db_id' must not be blank" if OCI::Internal::Util.blank_string?(awr_db_id)

  path = '/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbParameters'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{awrDbId}', awr_db_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:instNum] = opts[:inst_num] if opts[:inst_num]
  query_params[:beginSnIdGreaterThanOrEqualTo] = opts[:begin_sn_id_greater_than_or_equal_to] if opts[:begin_sn_id_greater_than_or_equal_to]
  query_params[:endSnIdLessThanOrEqualTo] = opts[:end_sn_id_less_than_or_equal_to] if opts[:end_sn_id_less_than_or_equal_to]
  query_params[:timeGreaterThanOrEqualTo] = opts[:time_greater_than_or_equal_to] if opts[:time_greater_than_or_equal_to]
  query_params[:timeLessThanOrEqualTo] = opts[:time_less_than_or_equal_to] if opts[:time_less_than_or_equal_to]
  query_params[:containerId] = opts[:container_id] if opts[:container_id]
  query_params[:name] = OCI::ApiClient.build_collection_params(opts[:name], :multi) if opts[:name] && !opts[:name].empty?
  query_params[:nameContains] = opts[:name_contains] if opts[:name_contains]
  query_params[:valueChanged] = opts[:value_changed] if opts[:value_changed]
  query_params[:valueDefault] = opts[:value_default] if opts[:value_default]
  query_params[:valueModified] = opts[:value_modified] if opts[:value_modified]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#summarize_awr_db_parameters') 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::DatabaseManagement::Models::AwrDbParameterCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_awr_db_snapshot_ranges(managed_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use summarize_awr_db_snapshot_ranges API.

Summarizes the AWR snapshot ranges that contain continuous snapshots, for the specified Managed Database.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :name (String) —

    The optional single value query parameter to filter the entity name.

  • :time_greater_than_or_equal_to (DateTime) —

    The optional greater than or equal to query parameter to filter the timestamp.

  • :time_less_than_or_equal_to (DateTime) —

    The optional less than or equal to query parameter to filter the timestamp.

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :sort_by (String) —

    The option to sort the AWR summary data. (default to END_INTERVAL_TIME) Allowed values are: END_INTERVAL_TIME, NAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Descending order is the default order. (default to DESC)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



10801
10802
10803
10804
10805
10806
10807
10808
10809
10810
10811
10812
10813
10814
10815
10816
10817
10818
10819
10820
10821
10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
10837
10838
10839
10840
10841
10842
10843
10844
10845
10846
10847
10848
10849
10850
10851
10852
10853
10854
 
# File 'lib/oci/database_management/db_management_client.rb', line 10801

def summarize_awr_db_snapshot_ranges(managed_database_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#summarize_awr_db_snapshot_ranges.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling summarize_awr_db_snapshot_ranges." if managed_database_id.nil?

  if opts[:sort_by] && !%w[END_INTERVAL_TIME NAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of END_INTERVAL_TIME, NAME.'
  end

  if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges'.sub('{managedDatabaseId}', managed_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:timeGreaterThanOrEqualTo] = opts[:time_greater_than_or_equal_to] if opts[:time_greater_than_or_equal_to]
  query_params[:timeLessThanOrEqualTo] = opts[:time_less_than_or_equal_to] if opts[:time_less_than_or_equal_to]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#summarize_awr_db_snapshot_ranges') 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::DatabaseManagement::Models::AwrDbSnapshotRangeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_awr_db_sysstats(managed_database_id, awr_db_id, name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use summarize_awr_db_sysstats API.

Summarizes the AWR SYSSTAT sample data for the specified database in AWR. The statistical data is summarized based on the Time dimension for each statistic.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • awr_db_id (String) —

    The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/managedDatabaseId/awrDbs

  • name (Array<String>) —

    The required multiple value query parameter to filter the entity name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :inst_num (String) —

    The optional single value query parameter to filter the database instance number.

  • :begin_sn_id_greater_than_or_equal_to (Integer) —

    The optional greater than or equal to filter on the snapshot ID.

  • :end_sn_id_less_than_or_equal_to (Integer) —

    The optional less than or equal to query parameter to filter the snapshot ID.

  • :time_greater_than_or_equal_to (DateTime) —

    The optional greater than or equal to query parameter to filter the timestamp.

  • :time_less_than_or_equal_to (DateTime) —

    The optional less than or equal to query parameter to filter the timestamp.

  • :container_id (Integer) —

    The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/managedDatabaseId/awrDbSnapshotRanges

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in large paginated response. (default to 1000)

  • :sort_by (String) —

    The option to sort the data within a time period. (default to TIME_BEGIN) Allowed values are: TIME_BEGIN, NAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Descending order is the default order. (default to DESC)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



10900
10901
10902
10903
10904
10905
10906
10907
10908
10909
10910
10911
10912
10913
10914
10915
10916
10917
10918
10919
10920
10921
10922
10923
10924
10925
10926
10927
10928
10929
10930
10931
10932
10933
10934
10935
10936
10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
 
# File 'lib/oci/database_management/db_management_client.rb', line 10900

def summarize_awr_db_sysstats(managed_database_id, awr_db_id, name, opts = {})
  logger.debug 'Calling operation DbManagementClient#summarize_awr_db_sysstats.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling summarize_awr_db_sysstats." if managed_database_id.nil?
  raise "Missing the required parameter 'awr_db_id' when calling summarize_awr_db_sysstats." if awr_db_id.nil?
  raise "Missing the required parameter 'name' when calling summarize_awr_db_sysstats." if name.nil?

  if opts[:sort_by] && !%w[TIME_BEGIN NAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_BEGIN, NAME.'
  end

  if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'awr_db_id' must not be blank" if OCI::Internal::Util.blank_string?(awr_db_id)

  path = '/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbSysstats'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{awrDbId}', awr_db_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:name] = OCI::ApiClient.build_collection_params(name, :multi)
  query_params[:instNum] = opts[:inst_num] if opts[:inst_num]
  query_params[:beginSnIdGreaterThanOrEqualTo] = opts[:begin_sn_id_greater_than_or_equal_to] if opts[:begin_sn_id_greater_than_or_equal_to]
  query_params[:endSnIdLessThanOrEqualTo] = opts[:end_sn_id_less_than_or_equal_to] if opts[:end_sn_id_less_than_or_equal_to]
  query_params[:timeGreaterThanOrEqualTo] = opts[:time_greater_than_or_equal_to] if opts[:time_greater_than_or_equal_to]
  query_params[:timeLessThanOrEqualTo] = opts[:time_less_than_or_equal_to] if opts[:time_less_than_or_equal_to]
  query_params[:containerId] = opts[:container_id] if opts[:container_id]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#summarize_awr_db_sysstats') 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::DatabaseManagement::Models::AwrDbSysstatCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_awr_db_top_wait_events(managed_database_id, awr_db_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use summarize_awr_db_top_wait_events API.

Summarizes the AWR top wait events.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • awr_db_id (String) —

    The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/managedDatabaseId/awrDbs

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :inst_num (String) —

    The optional single value query parameter to filter the database instance number.

  • :begin_sn_id_greater_than_or_equal_to (Integer) —

    The optional greater than or equal to filter on the snapshot ID.

  • :end_sn_id_less_than_or_equal_to (Integer) —

    The optional less than or equal to query parameter to filter the snapshot ID.

  • :time_greater_than_or_equal_to (DateTime) —

    The optional greater than or equal to query parameter to filter the timestamp.

  • :time_less_than_or_equal_to (DateTime) —

    The optional less than or equal to query parameter to filter the timestamp.

  • :session_type (String) —

    The optional query parameter to filter ASH activities by FOREGROUND or BACKGROUND. (default to FOREGROUND) Allowed values are: FOREGROUND, BACKGROUND, ALL

  • :container_id (Integer) —

    The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/managedDatabaseId/awrDbSnapshotRanges

  • :top_n (Integer) —

    The optional query parameter to filter the number of top categories to be returned. (default to 10)

  • :sort_by (String) —

    The option to sort the AWR top event summary data. (default to WAITS_PERSEC) Allowed values are: WAITS_PERSEC, AVG_WAIT_TIME_PERSEC

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Descending order is the default order. (default to DESC)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
11039
11040
11041
11042
11043
11044
11045
11046
11047
11048
11049
11050
11051
11052
11053
11054
11055
11056
11057
11058
11059
11060
11061
11062
11063
11064
11065
11066
 
# File 'lib/oci/database_management/db_management_client.rb', line 11004

def summarize_awr_db_top_wait_events(managed_database_id, awr_db_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#summarize_awr_db_top_wait_events.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling summarize_awr_db_top_wait_events." if managed_database_id.nil?
  raise "Missing the required parameter 'awr_db_id' when calling summarize_awr_db_top_wait_events." if awr_db_id.nil?

  if opts[:session_type] && !%w[FOREGROUND BACKGROUND ALL].include?(opts[:session_type])
    raise 'Invalid value for "session_type", must be one of FOREGROUND, BACKGROUND, ALL.'
  end

  if opts[:sort_by] && !%w[WAITS_PERSEC AVG_WAIT_TIME_PERSEC].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of WAITS_PERSEC, AVG_WAIT_TIME_PERSEC.'
  end

  if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'awr_db_id' must not be blank" if OCI::Internal::Util.blank_string?(awr_db_id)

  path = '/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbTopWaitEvents'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{awrDbId}', awr_db_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:instNum] = opts[:inst_num] if opts[:inst_num]
  query_params[:beginSnIdGreaterThanOrEqualTo] = opts[:begin_sn_id_greater_than_or_equal_to] if opts[:begin_sn_id_greater_than_or_equal_to]
  query_params[:endSnIdLessThanOrEqualTo] = opts[:end_sn_id_less_than_or_equal_to] if opts[:end_sn_id_less_than_or_equal_to]
  query_params[:timeGreaterThanOrEqualTo] = opts[:time_greater_than_or_equal_to] if opts[:time_greater_than_or_equal_to]
  query_params[:timeLessThanOrEqualTo] = opts[:time_less_than_or_equal_to] if opts[:time_less_than_or_equal_to]
  query_params[:sessionType] = opts[:session_type] if opts[:session_type]
  query_params[:containerId] = opts[:container_id] if opts[:container_id]
  query_params[:topN] = opts[:top_n] if opts[:top_n]
  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]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#summarize_awr_db_top_wait_events') 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::DatabaseManagement::Models::AwrDbTopWaitEventCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_awr_db_wait_event_buckets(managed_database_id, awr_db_id, name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use summarize_awr_db_wait_event_buckets API.

Summarizes AWR wait event data into value buckets and frequency, for the specified database in the AWR.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • awr_db_id (String) —

    The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/managedDatabaseId/awrDbs

  • name (String) —

    The required single value query parameter to filter the entity name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :inst_num (String) —

    The optional single value query parameter to filter the database instance number.

  • :begin_sn_id_greater_than_or_equal_to (Integer) —

    The optional greater than or equal to filter on the snapshot ID.

  • :end_sn_id_less_than_or_equal_to (Integer) —

    The optional less than or equal to query parameter to filter the snapshot ID.

  • :time_greater_than_or_equal_to (DateTime) —

    The optional greater than or equal to query parameter to filter the timestamp.

  • :time_less_than_or_equal_to (DateTime) —

    The optional less than or equal to query parameter to filter the timestamp.

  • :num_bucket (Integer) —

    The number of buckets within the histogram. (default to 10)

  • :min_value (Float) —

    The minimum value of the histogram. (default to 0)

  • :max_value (Float) —

    The maximum value of the histogram.

  • :container_id (Integer) —

    The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/managedDatabaseId/awrDbSnapshotRanges

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in large paginated response. (default to 1000)

  • :sort_by (String) —

    The option to sort distribution data. (default to CATEGORY) Allowed values are: CATEGORY, PERCENTAGE

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



11115
11116
11117
11118
11119
11120
11121
11122
11123
11124
11125
11126
11127
11128
11129
11130
11131
11132
11133
11134
11135
11136
11137
11138
11139
11140
11141
11142
11143
11144
11145
11146
11147
11148
11149
11150
11151
11152
11153
11154
11155
11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
11178
 
# File 'lib/oci/database_management/db_management_client.rb', line 11115

def summarize_awr_db_wait_event_buckets(managed_database_id, awr_db_id, name, opts = {})
  logger.debug 'Calling operation DbManagementClient#summarize_awr_db_wait_event_buckets.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling summarize_awr_db_wait_event_buckets." if managed_database_id.nil?
  raise "Missing the required parameter 'awr_db_id' when calling summarize_awr_db_wait_event_buckets." if awr_db_id.nil?
  raise "Missing the required parameter 'name' when calling summarize_awr_db_wait_event_buckets." if name.nil?

  if opts[:sort_by] && !%w[CATEGORY PERCENTAGE].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of CATEGORY, PERCENTAGE.'
  end

  if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'awr_db_id' must not be blank" if OCI::Internal::Util.blank_string?(awr_db_id)

  path = '/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbWaitEventBuckets'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{awrDbId}', awr_db_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:name] = name
  query_params[:instNum] = opts[:inst_num] if opts[:inst_num]
  query_params[:beginSnIdGreaterThanOrEqualTo] = opts[:begin_sn_id_greater_than_or_equal_to] if opts[:begin_sn_id_greater_than_or_equal_to]
  query_params[:endSnIdLessThanOrEqualTo] = opts[:end_sn_id_less_than_or_equal_to] if opts[:end_sn_id_less_than_or_equal_to]
  query_params[:timeGreaterThanOrEqualTo] = opts[:time_greater_than_or_equal_to] if opts[:time_greater_than_or_equal_to]
  query_params[:timeLessThanOrEqualTo] = opts[:time_less_than_or_equal_to] if opts[:time_less_than_or_equal_to]
  query_params[:numBucket] = opts[:num_bucket] if opts[:num_bucket]
  query_params[:minValue] = opts[:min_value] if opts[:min_value]
  query_params[:maxValue] = opts[:max_value] if opts[:max_value]
  query_params[:containerId] = opts[:container_id] if opts[:container_id]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#summarize_awr_db_wait_event_buckets') 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::DatabaseManagement::Models::AwrDbWaitEventBucketCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_awr_db_wait_events(managed_database_id, awr_db_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use summarize_awr_db_wait_events API.

Summarizes the AWR wait event sample data for the specified database in the AWR. The event data is summarized based on the Time dimension for each event.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • awr_db_id (String) —

    The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/managedDatabaseId/awrDbs

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :inst_num (String) —

    The optional single value query parameter to filter the database instance number.

  • :begin_sn_id_greater_than_or_equal_to (Integer) —

    The optional greater than or equal to filter on the snapshot ID.

  • :end_sn_id_less_than_or_equal_to (Integer) —

    The optional less than or equal to query parameter to filter the snapshot ID.

  • :time_greater_than_or_equal_to (DateTime) —

    The optional greater than or equal to query parameter to filter the timestamp.

  • :time_less_than_or_equal_to (DateTime) —

    The optional less than or equal to query parameter to filter the timestamp.

  • :name (Array<String>) —

    The optional multiple value query parameter to filter the entity name.

  • :session_type (String) —

    The optional query parameter to filter ASH activities by FOREGROUND or BACKGROUND. (default to FOREGROUND) Allowed values are: FOREGROUND, BACKGROUND, ALL

  • :container_id (Integer) —

    The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/managedDatabaseId/awrDbSnapshotRanges

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in large paginated response. (default to 1000)

  • :sort_by (String) —

    The option to sort the data within a time period. (default to TIME_BEGIN) Allowed values are: TIME_BEGIN, NAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Descending order is the default order. (default to DESC)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



11226
11227
11228
11229
11230
11231
11232
11233
11234
11235
11236
11237
11238
11239
11240
11241
11242
11243
11244
11245
11246
11247
11248
11249
11250
11251
11252
11253
11254
11255
11256
11257
11258
11259
11260
11261
11262
11263
11264
11265
11266
11267
11268
11269
11270
11271
11272
11273
11274
11275
11276
11277
11278
11279
11280
11281
11282
11283
11284
11285
11286
11287
11288
11289
11290
 
# File 'lib/oci/database_management/db_management_client.rb', line 11226

def summarize_awr_db_wait_events(managed_database_id, awr_db_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#summarize_awr_db_wait_events.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling summarize_awr_db_wait_events." if managed_database_id.nil?
  raise "Missing the required parameter 'awr_db_id' when calling summarize_awr_db_wait_events." if awr_db_id.nil?

  if opts[:session_type] && !%w[FOREGROUND BACKGROUND ALL].include?(opts[:session_type])
    raise 'Invalid value for "session_type", must be one of FOREGROUND, BACKGROUND, ALL.'
  end

  if opts[:sort_by] && !%w[TIME_BEGIN NAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_BEGIN, NAME.'
  end

  if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'awr_db_id' must not be blank" if OCI::Internal::Util.blank_string?(awr_db_id)

  path = '/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbWaitEvents'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{awrDbId}', awr_db_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:instNum] = opts[:inst_num] if opts[:inst_num]
  query_params[:beginSnIdGreaterThanOrEqualTo] = opts[:begin_sn_id_greater_than_or_equal_to] if opts[:begin_sn_id_greater_than_or_equal_to]
  query_params[:endSnIdLessThanOrEqualTo] = opts[:end_sn_id_less_than_or_equal_to] if opts[:end_sn_id_less_than_or_equal_to]
  query_params[:timeGreaterThanOrEqualTo] = opts[:time_greater_than_or_equal_to] if opts[:time_greater_than_or_equal_to]
  query_params[:timeLessThanOrEqualTo] = opts[:time_less_than_or_equal_to] if opts[:time_less_than_or_equal_to]
  query_params[:name] = OCI::ApiClient.build_collection_params(opts[:name], :multi) if opts[:name] && !opts[:name].empty?
  query_params[:sessionType] = opts[:session_type] if opts[:session_type]
  query_params[:containerId] = opts[:container_id] if opts[:container_id]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#summarize_awr_db_wait_events') 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::DatabaseManagement::Models::AwrDbWaitEventCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_external_asm_metrics(external_asm_id, start_time, end_time, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use summarize_external_asm_metrics API.

Gets metrics for the external ASM specified by externalAsmId.

Parameters:

  • external_asm_id (String) —

    The OCID of the external ASM.

  • start_time (String) —

    The beginning of the time range set to retrieve metric data for the DB system and its members. Expressed in UTC in ISO-8601 format, which is yyyy-MM-dd'T'hh:mm:ss.sss'Z'.

  • end_time (String) —

    The end of the time range set to retrieve metric data for the DB system and its members. Expressed in UTC in ISO-8601 format, which is yyyy-MM-dd'T'hh:mm:ss.sss'Z'.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :filter_by_metric_names (String) —

    The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics.

Returns:



11320
11321
11322
11323
11324
11325
11326
11327
11328
11329
11330
11331
11332
11333
11334
11335
11336
11337
11338
11339
11340
11341
11342
11343
11344
11345
11346
11347
11348
11349
11350
11351
11352
11353
11354
11355
11356
11357
11358
11359
11360
11361
11362
11363
 
# File 'lib/oci/database_management/db_management_client.rb', line 11320

def summarize_external_asm_metrics(external_asm_id, start_time, end_time, opts = {})
  logger.debug 'Calling operation DbManagementClient#summarize_external_asm_metrics.' if logger

  raise "Missing the required parameter 'external_asm_id' when calling summarize_external_asm_metrics." if external_asm_id.nil?
  raise "Missing the required parameter 'start_time' when calling summarize_external_asm_metrics." if start_time.nil?
  raise "Missing the required parameter 'end_time' when calling summarize_external_asm_metrics." if end_time.nil?
  raise "Parameter value for 'external_asm_id' must not be blank" if OCI::Internal::Util.blank_string?(external_asm_id)

  path = '/externalAsms/{externalAsmId}/metrics'.sub('{externalAsmId}', external_asm_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:startTime] = start_time
  query_params[:endTime] = end_time
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:filterByMetricNames] = opts[:filter_by_metric_names] if opts[:filter_by_metric_names]

  # 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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#summarize_external_asm_metrics') 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::DatabaseManagement::Models::MetricsAggregationRangeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_external_cluster_metrics(external_cluster_id, start_time, end_time, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use summarize_external_cluster_metrics API.

Gets metrics for the external cluster specified by externalClusterId.

Parameters:

  • external_cluster_id (String) —

    The OCID of the external cluster.

  • start_time (String) —

    The beginning of the time range set to retrieve metric data for the DB system and its members. Expressed in UTC in ISO-8601 format, which is yyyy-MM-dd'T'hh:mm:ss.sss'Z'.

  • end_time (String) —

    The end of the time range set to retrieve metric data for the DB system and its members. Expressed in UTC in ISO-8601 format, which is yyyy-MM-dd'T'hh:mm:ss.sss'Z'.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :filter_by_metric_names (String) —

    The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics.

Returns:



11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
11408
11409
11410
11411
11412
11413
11414
11415
11416
11417
11418
11419
11420
11421
11422
11423
11424
11425
11426
11427
11428
11429
11430
11431
11432
11433
11434
11435
11436
 
# File 'lib/oci/database_management/db_management_client.rb', line 11393

def summarize_external_cluster_metrics(external_cluster_id, start_time, end_time, opts = {})
  logger.debug 'Calling operation DbManagementClient#summarize_external_cluster_metrics.' if logger

  raise "Missing the required parameter 'external_cluster_id' when calling summarize_external_cluster_metrics." if external_cluster_id.nil?
  raise "Missing the required parameter 'start_time' when calling summarize_external_cluster_metrics." if start_time.nil?
  raise "Missing the required parameter 'end_time' when calling summarize_external_cluster_metrics." if end_time.nil?
  raise "Parameter value for 'external_cluster_id' must not be blank" if OCI::Internal::Util.blank_string?(external_cluster_id)

  path = '/externalClusters/{externalClusterId}/metrics'.sub('{externalClusterId}', external_cluster_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:startTime] = start_time
  query_params[:endTime] = end_time
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:filterByMetricNames] = opts[:filter_by_metric_names] if opts[:filter_by_metric_names]

  # 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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#summarize_external_cluster_metrics') 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::DatabaseManagement::Models::MetricsAggregationRangeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_external_db_node_metrics(external_db_node_id, start_time, end_time, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use summarize_external_db_node_metrics API.

Gets metrics for the external DB node specified by externalDbNodeId.

Parameters:

  • external_db_node_id (String) —

    The OCID of the external database node.

  • start_time (String) —

    The beginning of the time range set to retrieve metric data for the DB system and its members. Expressed in UTC in ISO-8601 format, which is yyyy-MM-dd'T'hh:mm:ss.sss'Z'.

  • end_time (String) —

    The end of the time range set to retrieve metric data for the DB system and its members. Expressed in UTC in ISO-8601 format, which is yyyy-MM-dd'T'hh:mm:ss.sss'Z'.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :filter_by_metric_names (String) —

    The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics.

Returns:



11466
11467
11468
11469
11470
11471
11472
11473
11474
11475
11476
11477
11478
11479
11480
11481
11482
11483
11484
11485
11486
11487
11488
11489
11490
11491
11492
11493
11494
11495
11496
11497
11498
11499
11500
11501
11502
11503
11504
11505
11506
11507
11508
11509
 
# File 'lib/oci/database_management/db_management_client.rb', line 11466

def summarize_external_db_node_metrics(external_db_node_id, start_time, end_time, opts = {})
  logger.debug 'Calling operation DbManagementClient#summarize_external_db_node_metrics.' if logger

  raise "Missing the required parameter 'external_db_node_id' when calling summarize_external_db_node_metrics." if external_db_node_id.nil?
  raise "Missing the required parameter 'start_time' when calling summarize_external_db_node_metrics." if start_time.nil?
  raise "Missing the required parameter 'end_time' when calling summarize_external_db_node_metrics." if end_time.nil?
  raise "Parameter value for 'external_db_node_id' must not be blank" if OCI::Internal::Util.blank_string?(external_db_node_id)

  path = '/externalDbNodes/{externalDbNodeId}/metrics'.sub('{externalDbNodeId}', external_db_node_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:startTime] = start_time
  query_params[:endTime] = end_time
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:filterByMetricNames] = opts[:filter_by_metric_names] if opts[:filter_by_metric_names]

  # 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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#summarize_external_db_node_metrics') 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::DatabaseManagement::Models::MetricsAggregationRangeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_external_db_system_availability_metrics(external_db_system_id, start_time, end_time, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use summarize_external_db_system_availability_metrics API.

Gets availability metrics for the components present in the external DB system specified by externalDbSystemId.

Parameters:

  • external_db_system_id (String) —

    The OCID of the external DB system.

  • start_time (String) —

    The beginning of the time range set to retrieve metric data for the DB system and its members. Expressed in UTC in ISO-8601 format, which is yyyy-MM-dd'T'hh:mm:ss.sss'Z'.

  • end_time (String) —

    The end of the time range set to retrieve metric data for the DB system and its members. Expressed in UTC in ISO-8601 format, which is yyyy-MM-dd'T'hh:mm:ss.sss'Z'.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :filter_by_component_types (String) —

    The filter used to retrieve metrics for a specific set of component types by passing the desired component types separated by a comma. Note that, by default, the service returns metrics for all DB system component types.

Returns:



11539
11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
11567
11568
11569
11570
11571
11572
11573
11574
11575
11576
11577
11578
11579
11580
11581
11582
 
# File 'lib/oci/database_management/db_management_client.rb', line 11539

def summarize_external_db_system_availability_metrics(external_db_system_id, start_time, end_time, opts = {})
  logger.debug 'Calling operation DbManagementClient#summarize_external_db_system_availability_metrics.' if logger

  raise "Missing the required parameter 'external_db_system_id' when calling summarize_external_db_system_availability_metrics." if external_db_system_id.nil?
  raise "Missing the required parameter 'start_time' when calling summarize_external_db_system_availability_metrics." if start_time.nil?
  raise "Missing the required parameter 'end_time' when calling summarize_external_db_system_availability_metrics." if end_time.nil?
  raise "Parameter value for 'external_db_system_id' must not be blank" if OCI::Internal::Util.blank_string?(external_db_system_id)

  path = '/externalDbSystems/{externalDbSystemId}/availabilityMetrics'.sub('{externalDbSystemId}', external_db_system_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:startTime] = start_time
  query_params[:endTime] = end_time
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:filterByComponentTypes] = opts[:filter_by_component_types] if opts[:filter_by_component_types]

  # 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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#summarize_external_db_system_availability_metrics') 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::DatabaseManagement::Models::MetricsAggregationRangeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_external_listener_metrics(external_listener_id, start_time, end_time, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use summarize_external_listener_metrics API.

Gets metrics for the external listener specified by externalListenerId.

Parameters:

  • external_listener_id (String) —

    The OCID of the external listener.

  • start_time (String) —

    The beginning of the time range set to retrieve metric data for the DB system and its members. Expressed in UTC in ISO-8601 format, which is yyyy-MM-dd'T'hh:mm:ss.sss'Z'.

  • end_time (String) —

    The end of the time range set to retrieve metric data for the DB system and its members. Expressed in UTC in ISO-8601 format, which is yyyy-MM-dd'T'hh:mm:ss.sss'Z'.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

  • :filter_by_metric_names (String) —

    The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics.

Returns:



11612
11613
11614
11615
11616
11617
11618
11619
11620
11621
11622
11623
11624
11625
11626
11627
11628
11629
11630
11631
11632
11633
11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
11651
11652
11653
11654
11655
 
# File 'lib/oci/database_management/db_management_client.rb', line 11612

def summarize_external_listener_metrics(external_listener_id, start_time, end_time, opts = {})
  logger.debug 'Calling operation DbManagementClient#summarize_external_listener_metrics.' if logger

  raise "Missing the required parameter 'external_listener_id' when calling summarize_external_listener_metrics." if external_listener_id.nil?
  raise "Missing the required parameter 'start_time' when calling summarize_external_listener_metrics." if start_time.nil?
  raise "Missing the required parameter 'end_time' when calling summarize_external_listener_metrics." if end_time.nil?
  raise "Parameter value for 'external_listener_id' must not be blank" if OCI::Internal::Util.blank_string?(external_listener_id)

  path = '/externalListeners/{externalListenerId}/metrics'.sub('{externalListenerId}', external_listener_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:startTime] = start_time
  query_params[:endTime] = end_time
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:filterByMetricNames] = opts[:filter_by_metric_names] if opts[:filter_by_metric_names]

  # 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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#summarize_external_listener_metrics') 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::DatabaseManagement::Models::MetricsAggregationRangeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_job_executions_statuses(compartment_id, start_time, end_time, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use summarize_job_executions_statuses API.

Gets the number of job executions grouped by status for a job, Managed Database, or Database Group in a specific compartment. Only one of the parameters, jobId, managedDatabaseId, or managedDatabaseGroupId should be provided.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • start_time (String) —

    The start time of the time range to retrieve the status summary of job executions in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'".

  • end_time (String) —

    The end time of the time range to retrieve the status summary of job executions in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'".

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :id (String) —

    The identifier of the resource.

  • :managed_database_group_id (String) —

    The OCID of the Managed Database Group.

  • :managed_database_id (String) —

    The OCID of the Managed Database.

  • :name (String) —

    A filter to return only resources that match the entire name.

  • :sort_by (String) —

    The field to sort information by. Only one sortOrder can be used. The default sort order for u2018TIMECREATEDu2019 is descending and the default sort order for u2018NAMEu2019 is ascending. The u2018NAMEu2019 sort order is case-sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, NAME

  • :sort_order (String) —

    The option to sort information in ascending (u2018ASCu2019) or descending (u2018DESCu2019) order. Ascending order is the default order. (default to ASC)

Returns:



11689
11690
11691
11692
11693
11694
11695
11696
11697
11698
11699
11700
11701
11702
11703
11704
11705
11706
11707
11708
11709
11710
11711
11712
11713
11714
11715
11716
11717
11718
11719
11720
11721
11722
11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
 
# File 'lib/oci/database_management/db_management_client.rb', line 11689

def summarize_job_executions_statuses(compartment_id, start_time, end_time, opts = {})
  logger.debug 'Calling operation DbManagementClient#summarize_job_executions_statuses.' if logger

  raise "Missing the required parameter 'compartment_id' when calling summarize_job_executions_statuses." if compartment_id.nil?
  raise "Missing the required parameter 'start_time' when calling summarize_job_executions_statuses." if start_time.nil?
  raise "Missing the required parameter 'end_time' when calling summarize_job_executions_statuses." if end_time.nil?

  if opts[:sort_by] && !%w[TIMECREATED NAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, NAME.'
  end

  if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.'
  end

  path = '/jobExecutionsStatus'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:startTime] = start_time
  query_params[:endTime] = end_time
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:managedDatabaseGroupId] = opts[:managed_database_group_id] if opts[:managed_database_group_id]
  query_params[:managedDatabaseId] = opts[:managed_database_id] if opts[:managed_database_id]
  query_params[:name] = opts[:name] if opts[:name]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#summarize_job_executions_statuses') 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::DatabaseManagement::Models::JobExecutionsStatusSummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_managed_database_availability_metrics(managed_database_id, start_time, end_time, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use summarize_managed_database_availability_metrics API.

Gets the availability metrics related to managed database for the Oracle database specified by managedDatabaseId.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • start_time (String) —

    The start time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'".

  • end_time (String) —

    The end time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'".

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of records returned in the paginated response. (default to 10)

Returns:



11773
11774
11775
11776
11777
11778
11779
11780
11781
11782
11783
11784
11785
11786
11787
11788
11789
11790
11791
11792
11793
11794
11795
11796
11797
11798
11799
11800
11801
11802
11803
11804
11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
11815
 
# File 'lib/oci/database_management/db_management_client.rb', line 11773

def summarize_managed_database_availability_metrics(managed_database_id, start_time, end_time, opts = {})
  logger.debug 'Calling operation DbManagementClient#summarize_managed_database_availability_metrics.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling summarize_managed_database_availability_metrics." if managed_database_id.nil?
  raise "Missing the required parameter 'start_time' when calling summarize_managed_database_availability_metrics." if start_time.nil?
  raise "Missing the required parameter 'end_time' when calling summarize_managed_database_availability_metrics." if end_time.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/availabilityMetrics'.sub('{managedDatabaseId}', managed_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:startTime] = start_time
  query_params[:endTime] = end_time
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]

  # 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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#summarize_managed_database_availability_metrics') 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::DatabaseManagement::Models::MetricsAggregationRangeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_sql_plan_baselines(managed_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use summarize_sql_plan_baselines API.

Gets the number of SQL plan baselines aggregated by their attributes.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



11837
11838
11839
11840
11841
11842
11843
11844
11845
11846
11847
11848
11849
11850
11851
11852
11853
11854
11855
11856
11857
11858
11859
11860
11861
11862
11863
11864
11865
11866
11867
11868
11869
11870
11871
11872
11873
11874
 
# File 'lib/oci/database_management/db_management_client.rb', line 11837

def summarize_sql_plan_baselines(managed_database_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#summarize_sql_plan_baselines.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling summarize_sql_plan_baselines." if managed_database_id.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/sqlPlanBaselineStats'.sub('{managedDatabaseId}', managed_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#summarize_sql_plan_baselines') 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::DatabaseManagement::Models::SqlPlanBaselineAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_sql_plan_baselines_by_last_execution(managed_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use summarize_sql_plan_baselines_by_last_execution API.

Gets the number of SQL plan baselines aggregated by the age of their last execution in weeks.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :page (String) —

    The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



11896
11897
11898
11899
11900
11901
11902
11903
11904
11905
11906
11907
11908
11909
11910
11911
11912
11913
11914
11915
11916
11917
11918
11919
11920
11921
11922
11923
11924
11925
11926
11927
11928
11929
11930
11931
11932
11933
 
# File 'lib/oci/database_management/db_management_client.rb', line 11896

def summarize_sql_plan_baselines_by_last_execution(managed_database_id, opts = {})
  logger.debug 'Calling operation DbManagementClient#summarize_sql_plan_baselines_by_last_execution.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling summarize_sql_plan_baselines_by_last_execution." if managed_database_id.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)

  path = '/managedDatabases/{managedDatabaseId}/sqlPlanBaselineExecutionStats'.sub('{managedDatabaseId}', managed_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#summarize_sql_plan_baselines_by_last_execution') 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::DatabaseManagement::Models::SqlPlanBaselineAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#test_preferred_credential(managed_database_id, credential_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use test_preferred_credential API.

Tests the preferred credential.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • credential_name (String) —

    The name of the preferred credential.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



11954
11955
11956
11957
11958
11959
11960
11961
11962
11963
11964
11965
11966
11967
11968
11969
11970
11971
11972
11973
11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
11991
11992
 
# File 'lib/oci/database_management/db_management_client.rb', line 11954

def test_preferred_credential(managed_database_id, credential_name, opts = {})
  logger.debug 'Calling operation DbManagementClient#test_preferred_credential.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling test_preferred_credential." if managed_database_id.nil?
  raise "Missing the required parameter 'credential_name' when calling test_preferred_credential." if credential_name.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'credential_name' must not be blank" if OCI::Internal::Util.blank_string?(credential_name)

  path = '/managedDatabases/{managedDatabaseId}/preferredCredentials/{credentialName}/actions/test'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{credentialName}', credential_name.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 = @api_client.object_to_http_body(opts[:test_preferred_credential_details])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#test_preferred_credential') 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::DatabaseManagement::Models::TestPreferredCredentialStatus'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_db_management_private_endpoint(db_management_private_endpoint_id, update_db_management_private_endpoint_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_db_management_private_endpoint API.

Updates one or more attributes of a specific Database Management private endpoint.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



12017
12018
12019
12020
12021
12022
12023
12024
12025
12026
12027
12028
12029
12030
12031
12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
12046
12047
12048
12049
12050
12051
12052
12053
12054
12055
 
# File 'lib/oci/database_management/db_management_client.rb', line 12017

def update_db_management_private_endpoint(db_management_private_endpoint_id, update_db_management_private_endpoint_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#update_db_management_private_endpoint.' if logger

  raise "Missing the required parameter 'db_management_private_endpoint_id' when calling update_db_management_private_endpoint." if db_management_private_endpoint_id.nil?
  raise "Missing the required parameter 'update_db_management_private_endpoint_details' when calling update_db_management_private_endpoint." if update_db_management_private_endpoint_details.nil?
  raise "Parameter value for 'db_management_private_endpoint_id' must not be blank" if OCI::Internal::Util.blank_string?(db_management_private_endpoint_id)

  path = '/dbManagementPrivateEndpoints/{dbManagementPrivateEndpointId}'.sub('{dbManagementPrivateEndpointId}', db_management_private_endpoint_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_db_management_private_endpoint_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#update_db_management_private_endpoint') 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::DatabaseManagement::Models::DbManagementPrivateEndpoint'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_external_asm(external_asm_id, update_external_asm_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_external_asm API.

Updates the external ASM specified by externalAsmId.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



12081
12082
12083
12084
12085
12086
12087
12088
12089
12090
12091
12092
12093
12094
12095
12096
12097
12098
12099
12100
12101
12102
12103
12104
12105
12106
12107
12108
12109
12110
12111
12112
12113
12114
12115
12116
12117
12118
 
# File 'lib/oci/database_management/db_management_client.rb', line 12081

def update_external_asm(external_asm_id, update_external_asm_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#update_external_asm.' if logger

  raise "Missing the required parameter 'external_asm_id' when calling update_external_asm." if external_asm_id.nil?
  raise "Missing the required parameter 'update_external_asm_details' when calling update_external_asm." if update_external_asm_details.nil?
  raise "Parameter value for 'external_asm_id' must not be blank" if OCI::Internal::Util.blank_string?(external_asm_id)

  path = '/externalAsms/{externalAsmId}'.sub('{externalAsmId}', external_asm_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_external_asm_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#update_external_asm') 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_external_cluster(external_cluster_id, update_external_cluster_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_external_cluster API.

Updates the external cluster specified by externalClusterId.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



12144
12145
12146
12147
12148
12149
12150
12151
12152
12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
 
# File 'lib/oci/database_management/db_management_client.rb', line 12144

def update_external_cluster(external_cluster_id, update_external_cluster_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#update_external_cluster.' if logger

  raise "Missing the required parameter 'external_cluster_id' when calling update_external_cluster." if external_cluster_id.nil?
  raise "Missing the required parameter 'update_external_cluster_details' when calling update_external_cluster." if update_external_cluster_details.nil?
  raise "Parameter value for 'external_cluster_id' must not be blank" if OCI::Internal::Util.blank_string?(external_cluster_id)

  path = '/externalClusters/{externalClusterId}'.sub('{externalClusterId}', external_cluster_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_external_cluster_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#update_external_cluster') 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_external_cluster_instance(external_cluster_instance_id, update_external_cluster_instance_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_external_cluster_instance API.

Updates the external cluster instance specified by externalClusterInstanceId.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



12207
12208
12209
12210
12211
12212
12213
12214
12215
12216
12217
12218
12219
12220
12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
12236
12237
12238
12239
12240
12241
12242
12243
12244
 
# File 'lib/oci/database_management/db_management_client.rb', line 12207

def update_external_cluster_instance(external_cluster_instance_id, update_external_cluster_instance_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#update_external_cluster_instance.' if logger

  raise "Missing the required parameter 'external_cluster_instance_id' when calling update_external_cluster_instance." if external_cluster_instance_id.nil?
  raise "Missing the required parameter 'update_external_cluster_instance_details' when calling update_external_cluster_instance." if update_external_cluster_instance_details.nil?
  raise "Parameter value for 'external_cluster_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(external_cluster_instance_id)

  path = '/externalClusterInstances/{externalClusterInstanceId}'.sub('{externalClusterInstanceId}', external_cluster_instance_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_external_cluster_instance_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#update_external_cluster_instance') 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_external_db_node(external_db_node_id, update_external_db_node_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_external_db_node API.

Updates the external DB node specified by externalDbNodeId.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



12270
12271
12272
12273
12274
12275
12276
12277
12278
12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
12295
12296
12297
12298
12299
12300
12301
12302
12303
12304
12305
12306
12307
 
# File 'lib/oci/database_management/db_management_client.rb', line 12270

def update_external_db_node(external_db_node_id, update_external_db_node_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#update_external_db_node.' if logger

  raise "Missing the required parameter 'external_db_node_id' when calling update_external_db_node." if external_db_node_id.nil?
  raise "Missing the required parameter 'update_external_db_node_details' when calling update_external_db_node." if update_external_db_node_details.nil?
  raise "Parameter value for 'external_db_node_id' must not be blank" if OCI::Internal::Util.blank_string?(external_db_node_id)

  path = '/externalDbNodes/{externalDbNodeId}'.sub('{externalDbNodeId}', external_db_node_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_external_db_node_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#update_external_db_node') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_external_db_system(external_db_system_id, update_external_db_system_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_external_db_system API.

Updates the external DB system specified by externalDbSystemId.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



12333
12334
12335
12336
12337
12338
12339
12340
12341
12342
12343
12344
12345
12346
12347
12348
12349
12350
12351
12352
12353
12354
12355
12356
12357
12358
12359
12360
12361
12362
12363
12364
12365
12366
12367
12368
12369
12370
12371
 
# File 'lib/oci/database_management/db_management_client.rb', line 12333

def update_external_db_system(external_db_system_id, update_external_db_system_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#update_external_db_system.' if logger

  raise "Missing the required parameter 'external_db_system_id' when calling update_external_db_system." if external_db_system_id.nil?
  raise "Missing the required parameter 'update_external_db_system_details' when calling update_external_db_system." if update_external_db_system_details.nil?
  raise "Parameter value for 'external_db_system_id' must not be blank" if OCI::Internal::Util.blank_string?(external_db_system_id)

  path = '/externalDbSystems/{externalDbSystemId}'.sub('{externalDbSystemId}', external_db_system_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_external_db_system_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#update_external_db_system') 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::DatabaseManagement::Models::ExternalDbSystem'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_external_db_system_connector(external_db_system_connector_id, update_external_db_system_connector_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_external_db_system_connector API.

Updates the external connector specified by externalDbSystemConnectorId.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



12396
12397
12398
12399
12400
12401
12402
12403
12404
12405
12406
12407
12408
12409
12410
12411
12412
12413
12414
12415
12416
12417
12418
12419
12420
12421
12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
12432
12433
 
# File 'lib/oci/database_management/db_management_client.rb', line 12396

def update_external_db_system_connector(external_db_system_connector_id, update_external_db_system_connector_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#update_external_db_system_connector.' if logger

  raise "Missing the required parameter 'external_db_system_connector_id' when calling update_external_db_system_connector." if external_db_system_connector_id.nil?
  raise "Missing the required parameter 'update_external_db_system_connector_details' when calling update_external_db_system_connector." if update_external_db_system_connector_details.nil?
  raise "Parameter value for 'external_db_system_connector_id' must not be blank" if OCI::Internal::Util.blank_string?(external_db_system_connector_id)

  path = '/externalDbSystemConnectors/{externalDbSystemConnectorId}'.sub('{externalDbSystemConnectorId}', external_db_system_connector_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_external_db_system_connector_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#update_external_db_system_connector') 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_external_db_system_discovery(external_db_system_discovery_id, update_external_db_system_discovery_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_external_db_system_discovery API.

Updates the external DB system discovery specified by externalDbSystemDiscoveryId.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



12459
12460
12461
12462
12463
12464
12465
12466
12467
12468
12469
12470
12471
12472
12473
12474
12475
12476
12477
12478
12479
12480
12481
12482
12483
12484
12485
12486
12487
12488
12489
12490
12491
12492
12493
12494
12495
12496
12497
 
# File 'lib/oci/database_management/db_management_client.rb', line 12459

def update_external_db_system_discovery(external_db_system_discovery_id, update_external_db_system_discovery_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#update_external_db_system_discovery.' if logger

  raise "Missing the required parameter 'external_db_system_discovery_id' when calling update_external_db_system_discovery." if external_db_system_discovery_id.nil?
  raise "Missing the required parameter 'update_external_db_system_discovery_details' when calling update_external_db_system_discovery." if update_external_db_system_discovery_details.nil?
  raise "Parameter value for 'external_db_system_discovery_id' must not be blank" if OCI::Internal::Util.blank_string?(external_db_system_discovery_id)

  path = '/externalDbSystemDiscoveries/{externalDbSystemDiscoveryId}'.sub('{externalDbSystemDiscoveryId}', external_db_system_discovery_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_external_db_system_discovery_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#update_external_db_system_discovery') 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::DatabaseManagement::Models::ExternalDbSystemDiscovery'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_external_exadata_infrastructure(external_exadata_infrastructure_id, update_external_exadata_infrastructure_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_external_exadata_infrastructure API.

Updates the details for the Exadata infrastructure specified by externalExadataInfrastructureId.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



12529
12530
12531
12532
12533
12534
12535
12536
12537
12538
12539
12540
12541
12542
12543
12544
12545
12546
12547
12548
12549
12550
12551
12552
12553
12554
12555
12556
12557
12558
12559
12560
12561
12562
12563
12564
12565
12566
12567
12568
12569
 
# File 'lib/oci/database_management/db_management_client.rb', line 12529

def update_external_exadata_infrastructure(external_exadata_infrastructure_id, update_external_exadata_infrastructure_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#update_external_exadata_infrastructure.' if logger

  raise "Missing the required parameter 'external_exadata_infrastructure_id' when calling update_external_exadata_infrastructure." if external_exadata_infrastructure_id.nil?
  raise "Missing the required parameter 'update_external_exadata_infrastructure_details' when calling update_external_exadata_infrastructure." if update_external_exadata_infrastructure_details.nil?
  raise "Parameter value for 'external_exadata_infrastructure_id' must not be blank" if OCI::Internal::Util.blank_string?(external_exadata_infrastructure_id)

  path = '/externalExadataInfrastructures/{externalExadataInfrastructureId}'.sub('{externalExadataInfrastructureId}', external_exadata_infrastructure_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(update_external_exadata_infrastructure_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#update_external_exadata_infrastructure') 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::DatabaseManagement::Models::ExternalExadataInfrastructure'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_external_exadata_storage_connector(external_exadata_storage_connector_id, update_external_exadata_storage_connector_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_external_exadata_storage_connector API.

Updates the Exadata storage server connector specified by exadataStorageConnectorId.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



12595
12596
12597
12598
12599
12600
12601
12602
12603
12604
12605
12606
12607
12608
12609
12610
12611
12612
12613
12614
12615
12616
12617
12618
12619
12620
12621
12622
12623
12624
12625
12626
12627
12628
12629
12630
12631
12632
12633
 
# File 'lib/oci/database_management/db_management_client.rb', line 12595

def update_external_exadata_storage_connector(external_exadata_storage_connector_id, update_external_exadata_storage_connector_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#update_external_exadata_storage_connector.' if logger

  raise "Missing the required parameter 'external_exadata_storage_connector_id' when calling update_external_exadata_storage_connector." if external_exadata_storage_connector_id.nil?
  raise "Missing the required parameter 'update_external_exadata_storage_connector_details' when calling update_external_exadata_storage_connector." if update_external_exadata_storage_connector_details.nil?
  raise "Parameter value for 'external_exadata_storage_connector_id' must not be blank" if OCI::Internal::Util.blank_string?(external_exadata_storage_connector_id)

  path = '/externalExadataStorageConnectors/{externalExadataStorageConnectorId}'.sub('{externalExadataStorageConnectorId}', external_exadata_storage_connector_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_external_exadata_storage_connector_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#update_external_exadata_storage_connector') 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::DatabaseManagement::Models::ExternalExadataStorageConnector'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_external_listener(external_listener_id, update_external_listener_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_external_listener API.

Updates the external listener specified by externalListenerId.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



12659
12660
12661
12662
12663
12664
12665
12666
12667
12668
12669
12670
12671
12672
12673
12674
12675
12676
12677
12678
12679
12680
12681
12682
12683
12684
12685
12686
12687
12688
12689
12690
12691
12692
12693
12694
12695
12696
 
# File 'lib/oci/database_management/db_management_client.rb', line 12659

def update_external_listener(external_listener_id, update_external_listener_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#update_external_listener.' if logger

  raise "Missing the required parameter 'external_listener_id' when calling update_external_listener." if external_listener_id.nil?
  raise "Missing the required parameter 'update_external_listener_details' when calling update_external_listener." if update_external_listener_details.nil?
  raise "Parameter value for 'external_listener_id' must not be blank" if OCI::Internal::Util.blank_string?(external_listener_id)

  path = '/externalListeners/{externalListenerId}'.sub('{externalListenerId}', external_listener_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_external_listener_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#update_external_listener') 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

Note:

Click here to see an example of how to use update_job API.

Updates the details for the recurring scheduled job specified by jobId. Note that non-recurring (one time) jobs cannot be updated.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type Job



12722
12723
12724
12725
12726
12727
12728
12729
12730
12731
12732
12733
12734
12735
12736
12737
12738
12739
12740
12741
12742
12743
12744
12745
12746
12747
12748
12749
12750
12751
12752
12753
12754
12755
12756
12757
12758
12759
12760
 
# File 'lib/oci/database_management/db_management_client.rb', line 12722

def update_job(job_id, update_job_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#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.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#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::DatabaseManagement::Models::Job'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_managed_database_group(managed_database_group_id, update_managed_database_group_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_managed_database_group API.

Updates the Managed Database Group specified by managedDatabaseGroupId.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



12786
12787
12788
12789
12790
12791
12792
12793
12794
12795
12796
12797
12798
12799
12800
12801
12802
12803
12804
12805
12806
12807
12808
12809
12810
12811
12812
12813
12814
12815
12816
12817
12818
12819
12820
12821
12822
12823
12824
 
# File 'lib/oci/database_management/db_management_client.rb', line 12786

def update_managed_database_group(managed_database_group_id, update_managed_database_group_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#update_managed_database_group.' if logger

  raise "Missing the required parameter 'managed_database_group_id' when calling update_managed_database_group." if managed_database_group_id.nil?
  raise "Missing the required parameter 'update_managed_database_group_details' when calling update_managed_database_group." if update_managed_database_group_details.nil?
  raise "Parameter value for 'managed_database_group_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_group_id)

  path = '/managedDatabaseGroups/{managedDatabaseGroupId}'.sub('{managedDatabaseGroupId}', managed_database_group_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_managed_database_group_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#update_managed_database_group') 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::DatabaseManagement::Models::ManagedDatabaseGroup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_preferred_credential(managed_database_id, credential_name, update_preferred_credential_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_preferred_credential API.

Updates the preferred credential based on the credentialName.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • credential_name (String) —

    The name of the preferred credential.

  • update_preferred_credential_details (OCI::DatabaseManagement::Models::UpdatePreferredCredentialDetails) —

    The details required to update preferred credential.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



12851
12852
12853
12854
12855
12856
12857
12858
12859
12860
12861
12862
12863
12864
12865
12866
12867
12868
12869
12870
12871
12872
12873
12874
12875
12876
12877
12878
12879
12880
12881
12882
12883
12884
12885
12886
12887
12888
12889
12890
12891
 
# File 'lib/oci/database_management/db_management_client.rb', line 12851

def update_preferred_credential(managed_database_id, credential_name, update_preferred_credential_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#update_preferred_credential.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling update_preferred_credential." if managed_database_id.nil?
  raise "Missing the required parameter 'credential_name' when calling update_preferred_credential." if credential_name.nil?
  raise "Missing the required parameter 'update_preferred_credential_details' when calling update_preferred_credential." if update_preferred_credential_details.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'credential_name' must not be blank" if OCI::Internal::Util.blank_string?(credential_name)

  path = '/managedDatabases/{managedDatabaseId}/preferredCredentials/{credentialName}'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{credentialName}', credential_name.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_preferred_credential_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#update_preferred_credential') 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::DatabaseManagement::Models::PreferredCredential'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_tablespace(managed_database_id, tablespace_name, update_tablespace_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_tablespace API.

Updates the attributes of the tablespace specified by tablespaceName within the Managed Database specified by managedDatabaseId.

Parameters:

  • managed_database_id (String) —

    The OCID of the Managed Database.

  • tablespace_name (String) —

    The name of the tablespace.

  • update_tablespace_details (OCI::DatabaseManagement::Models::UpdateTablespaceDetails) —

    The details required to update a tablespace.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



12912
12913
12914
12915
12916
12917
12918
12919
12920
12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931
12932
12933
12934
12935
12936
12937
12938
12939
12940
12941
12942
12943
12944
12945
12946
12947
12948
12949
12950
12951
 
# File 'lib/oci/database_management/db_management_client.rb', line 12912

def update_tablespace(managed_database_id, tablespace_name, update_tablespace_details, opts = {})
  logger.debug 'Calling operation DbManagementClient#update_tablespace.' if logger

  raise "Missing the required parameter 'managed_database_id' when calling update_tablespace." if managed_database_id.nil?
  raise "Missing the required parameter 'tablespace_name' when calling update_tablespace." if tablespace_name.nil?
  raise "Missing the required parameter 'update_tablespace_details' when calling update_tablespace." if update_tablespace_details.nil?
  raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id)
  raise "Parameter value for 'tablespace_name' must not be blank" if OCI::Internal::Util.blank_string?(tablespace_name)

  path = '/managedDatabases/{managedDatabaseId}/tablespaces/{tablespaceName}'.sub('{managedDatabaseId}', managed_database_id.to_s).sub('{tablespaceName}', tablespace_name.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 = @api_client.object_to_http_body(update_tablespace_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbManagementClient#update_tablespace') 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::DatabaseManagement::Models::Tablespace'
    )
  end
  # rubocop:enable Metrics/BlockLength
end