Class: OCI::DatabaseToolsRuntime::DatabaseToolsRuntimeClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_tools_runtime/database_tools_runtime_client.rb

Overview

Use the Database Tools Runtime API to connect to databases through Database Tools Connections.

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) ⇒ DatabaseToolsRuntimeClient

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



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

def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil)
  # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers)
  # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals
  # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then
  # pass it to this constructor.
  #
  # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid
  # so try and load the config from the default file.
  config = OCI::Config.validate_and_build_config_with_signer(config, signer)

  signer = OCI::Signer.config_file_auth_builder(config) if signer.nil?

  @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings)
  @retry_config = retry_config

  if endpoint
    @endpoint = endpoint + '/20230222'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "DatabaseToolsRuntimeClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



15
16
17
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 15

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 19

def endpoint
  @endpoint
end

#region ⇒ String

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

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 29

def region
  @region
end

#retry_config ⇒ OCI::Retry::RetryConfig (readonly)

The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries

Returns:



25
26
27
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#cancel_work_request(work_request_id, opts = {}) ⇒ Response

Note:

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

Attempts to cancel the specified work request.

Parameters:

  • work_request_id (String) —

    The ID of the asynchronous 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.

  • :if_match (String) —

    If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation's current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

Returns:

  • (Response) —

    A Response object with data of type nil



119
120
121
122
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
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 119

def cancel_work_request(work_request_id, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#cancel_work_request.' if logger

  raise "Missing the required parameter 'work_request_id' when calling cancel_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]
  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: 'DatabaseToolsRuntimeClient#cancel_work_request') 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

#create_credential(database_tools_connection_id, create_credential_details, opts = {}) ⇒ Response

Note:

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

Creates a credential for the user specified by the key.

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) —

    If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation's current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

Returns:



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 182

def create_credential(database_tools_connection_id, create_credential_details, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#create_credential.' if logger

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

  path = '/databaseToolsConnections/{databaseToolsConnectionId}/credentials'.sub('{databaseToolsConnectionId}', database_tools_connection_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(create_credential_details)

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

#create_credential_execute_grantee(database_tools_connection_id, credential_key, create_credential_execute_grantee_details, opts = {}) ⇒ Response

Note:

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

Grants the EXECUTE privilege on the credential to the user specified by the key.

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) —

    If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation's current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

Returns:



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 248

def create_credential_execute_grantee(database_tools_connection_id, credential_key, create_credential_execute_grantee_details, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#create_credential_execute_grantee.' if logger

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

  path = '/databaseToolsConnections/{databaseToolsConnectionId}/credentials/{credentialKey}/executeGrantees'.sub('{databaseToolsConnectionId}', database_tools_connection_id.to_s).sub('{credentialKey}', credential_key.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(create_credential_execute_grantee_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseToolsRuntimeClient#create_credential_execute_grantee') 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::DatabaseToolsRuntime::Models::CredentialExecuteGrantee'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_credential_public_synonym(database_tools_connection_id, credential_key, create_credential_public_synonym_details, opts = {}) ⇒ Response

Note:

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

Creates a public synonym for the given credentials

Parameters:

  • database_tools_connection_id (String) —

    The OCID of a Database Tools connection.

  • credential_key (String) —

    The name of the credential

  • create_credential_public_synonym_details (OCI::DatabaseToolsRuntime::Models::CreateCredentialPublicSynonymDetails) —

    The payload to create a public synonym for the given credentials.

  • 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) —

    If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation's current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

Returns:



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 316

def create_credential_public_synonym(database_tools_connection_id, credential_key, create_credential_public_synonym_details, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#create_credential_public_synonym.' if logger

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

  path = '/databaseToolsConnections/{databaseToolsConnectionId}/credentials/{credentialKey}/publicSynonyms'.sub('{databaseToolsConnectionId}', database_tools_connection_id.to_s).sub('{credentialKey}', credential_key.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(create_credential_public_synonym_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseToolsRuntimeClient#create_credential_public_synonym') 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::DatabaseToolsRuntime::Models::CredentialPublicSynonym'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_database_tools_database_api_gateway_config_pool(database_tools_database_api_gateway_config_id, create_database_tools_database_api_gateway_config_pool_details, opts = {}) ⇒ Response

Note:

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

Create a Database Tools database API gateway config pool 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.

    Accepted characters: ASCII alphanumerics plus underscore (U+005F LOW LINE "_") and dash (U+002D HYPHEN-MINUS "-")

Returns:



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 383

def create_database_tools_database_api_gateway_config_pool(database_tools_database_api_gateway_config_id, create_database_tools_database_api_gateway_config_pool_details, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#create_database_tools_database_api_gateway_config_pool.' if logger

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

  path = '/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools'.sub('{databaseToolsDatabaseApiGatewayConfigId}', database_tools_database_api_gateway_config_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_database_tools_database_api_gateway_config_pool_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseToolsRuntimeClient#create_database_tools_database_api_gateway_config_pool') 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::DatabaseToolsRuntime::Models::DatabaseToolsDatabaseApiGatewayConfigPool'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_database_tools_database_api_gateway_config_pool_api_spec(database_tools_database_api_gateway_config_id, pool_key, create_database_tools_database_api_gateway_config_pool_api_spec_details, opts = {}) ⇒ Response

Note:

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

Create a Database Tools database API gateway config API spec 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.

    Accepted characters: ASCII alphanumerics plus underscore (U+005F LOW LINE "_") and dash (U+002D HYPHEN-MINUS "-")

Returns:



450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 450

def create_database_tools_database_api_gateway_config_pool_api_spec(database_tools_database_api_gateway_config_id, pool_key, create_database_tools_database_api_gateway_config_pool_api_spec_details, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#create_database_tools_database_api_gateway_config_pool_api_spec.' if logger

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

  path = '/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools/{poolKey}/apiSpecs'.sub('{databaseToolsDatabaseApiGatewayConfigId}', database_tools_database_api_gateway_config_id.to_s).sub('{poolKey}', pool_key.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_database_tools_database_api_gateway_config_pool_api_spec_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseToolsRuntimeClient#create_database_tools_database_api_gateway_config_pool_api_spec') 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::DatabaseToolsRuntime::Models::DatabaseToolsDatabaseApiGatewayConfigPoolApiSpec'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_database_tools_database_api_gateway_config_pool_auto_api_spec(database_tools_database_api_gateway_config_id, pool_key, create_database_tools_database_api_gateway_config_pool_auto_api_spec_details, opts = {}) ⇒ Response

Note:

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

Create a Database Tools database API gateway config auto API spec 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.

    Accepted characters: ASCII alphanumerics plus underscore (U+005F LOW LINE "_") and dash (U+002D HYPHEN-MINUS "-")

Returns:



519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 519

def create_database_tools_database_api_gateway_config_pool_auto_api_spec(database_tools_database_api_gateway_config_id, pool_key, create_database_tools_database_api_gateway_config_pool_auto_api_spec_details, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#create_database_tools_database_api_gateway_config_pool_auto_api_spec.' if logger

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

  path = '/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools/{poolKey}/autoApiSpecs'.sub('{databaseToolsDatabaseApiGatewayConfigId}', database_tools_database_api_gateway_config_id.to_s).sub('{poolKey}', pool_key.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_database_tools_database_api_gateway_config_pool_auto_api_spec_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseToolsRuntimeClient#create_database_tools_database_api_gateway_config_pool_auto_api_spec') 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::DatabaseToolsRuntime::Models::DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_credential(database_tools_connection_id, credential_key, opts = {}) ⇒ Response

Note:

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

Delete credential

Parameters:

  • database_tools_connection_id (String) —

    The OCID of a Database Tools connection.

  • credential_key (String) —

    The name of the 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) —

    If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation's current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

Returns:

  • (Response) —

    A Response object with data of type nil



587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 587

def delete_credential(database_tools_connection_id, credential_key, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#delete_credential.' if logger

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

  path = '/databaseToolsConnections/{databaseToolsConnectionId}/credentials/{credentialKey}'.sub('{databaseToolsConnectionId}', database_tools_connection_id.to_s).sub('{credentialKey}', credential_key.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: 'DatabaseToolsRuntimeClient#delete_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

#delete_credential_execute_grantee(database_tools_connection_id, credential_key, execute_grantee_key, opts = {}) ⇒ Response

Note:

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

Delete execute grantee

Parameters:

  • database_tools_connection_id (String) —

    The OCID of a Database Tools connection.

  • credential_key (String) —

    The name of the credential

  • execute_grantee_key (String) —

    The name of the user granted the EXECUTE privilege on the 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) —

    If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation's current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

Returns:

  • (Response) —

    A Response object with data of type nil



653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 653

def delete_credential_execute_grantee(database_tools_connection_id, credential_key, execute_grantee_key, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#delete_credential_execute_grantee.' if logger

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

  path = '/databaseToolsConnections/{databaseToolsConnectionId}/credentials/{credentialKey}/executeGrantees/{executeGranteeKey}'.sub('{databaseToolsConnectionId}', database_tools_connection_id.to_s).sub('{credentialKey}', credential_key.to_s).sub('{executeGranteeKey}', execute_grantee_key.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: 'DatabaseToolsRuntimeClient#delete_credential_execute_grantee') 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_credential_public_synonym(database_tools_connection_id, credential_key, public_synonym_key, opts = {}) ⇒ Response

Note:

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

Deletes the public synonym

Parameters:

  • database_tools_connection_id (String) —

    The OCID of a Database Tools connection.

  • credential_key (String) —

    The name of the credential

  • public_synonym_key (String) —

    The name of the public synonym for the 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) —

    If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation's current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

Returns:

  • (Response) —

    A Response object with data of type nil



721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 721

def delete_credential_public_synonym(database_tools_connection_id, credential_key, public_synonym_key, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#delete_credential_public_synonym.' if logger

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

  path = '/databaseToolsConnections/{databaseToolsConnectionId}/credentials/{credentialKey}/publicSynonyms/{publicSynonymKey}'.sub('{databaseToolsConnectionId}', database_tools_connection_id.to_s).sub('{credentialKey}', credential_key.to_s).sub('{publicSynonymKey}', public_synonym_key.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: 'DatabaseToolsRuntimeClient#delete_credential_public_synonym') 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_database_tools_database_api_gateway_config_pool(database_tools_database_api_gateway_config_id, pool_key, opts = {}) ⇒ Response

Note:

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

Deletes the specified Database Tools database API gateway config pool resource.

Parameters:

  • database_tools_database_api_gateway_config_id (String) —

    The OCID of a Database Tools database API gateway config.

  • pool_key (String) —

    The key of the pool config.

  • 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) —

    If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation's current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 788

def delete_database_tools_database_api_gateway_config_pool(database_tools_database_api_gateway_config_id, pool_key, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#delete_database_tools_database_api_gateway_config_pool.' if logger

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

  path = '/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools/{poolKey}'.sub('{databaseToolsDatabaseApiGatewayConfigId}', database_tools_database_api_gateway_config_id.to_s).sub('{poolKey}', pool_key.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: 'DatabaseToolsRuntimeClient#delete_database_tools_database_api_gateway_config_pool') 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_database_tools_database_api_gateway_config_pool_api_spec(database_tools_database_api_gateway_config_id, pool_key, api_spec_key, opts = {}) ⇒ Response

Note:

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

Deletes the specified Database Tools database API gateway config API spec resource.

Parameters:

  • database_tools_database_api_gateway_config_id (String) —

    The OCID of a Database Tools database API gateway config.

  • pool_key (String) —

    The key of the pool config.

  • api_spec_key (String) —

    The key of the API spec config.

  • 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) —

    If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation's current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 854

def delete_database_tools_database_api_gateway_config_pool_api_spec(database_tools_database_api_gateway_config_id, pool_key, api_spec_key, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#delete_database_tools_database_api_gateway_config_pool_api_spec.' if logger

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

  path = '/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools/{poolKey}/apiSpecs/{apiSpecKey}'.sub('{databaseToolsDatabaseApiGatewayConfigId}', database_tools_database_api_gateway_config_id.to_s).sub('{poolKey}', pool_key.to_s).sub('{apiSpecKey}', api_spec_key.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: 'DatabaseToolsRuntimeClient#delete_database_tools_database_api_gateway_config_pool_api_spec') 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_database_tools_database_api_gateway_config_pool_auto_api_spec(database_tools_database_api_gateway_config_id, pool_key, auto_api_spec_key, opts = {}) ⇒ Response

Note:

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

Deletes the specified Database Tools database API gateway config auto API spec resource.

Parameters:

  • database_tools_database_api_gateway_config_id (String) —

    The OCID of a Database Tools database API gateway config.

  • pool_key (String) —

    The key of the pool config.

  • auto_api_spec_key (String) —

    The key of the auto API spec config.

  • 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) —

    If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation's current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 922

def delete_database_tools_database_api_gateway_config_pool_auto_api_spec(database_tools_database_api_gateway_config_id, pool_key, auto_api_spec_key, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#delete_database_tools_database_api_gateway_config_pool_auto_api_spec.' if logger

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

  path = '/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools/{poolKey}/autoApiSpecs/{autoApiSpecKey}'.sub('{databaseToolsDatabaseApiGatewayConfigId}', database_tools_database_api_gateway_config_id.to_s).sub('{poolKey}', pool_key.to_s).sub('{autoApiSpecKey}', auto_api_spec_key.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: 'DatabaseToolsRuntimeClient#delete_database_tools_database_api_gateway_config_pool_auto_api_spec') 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

#execute_sql_database_tools_connection(database_tools_connection_id, execute_sql_database_tools_connection_details, opts = {}) ⇒ Response

Note:

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

Execute statements on a database tools connection.

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) —

    If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation's current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

Returns:



990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 990

def execute_sql_database_tools_connection(database_tools_connection_id, execute_sql_database_tools_connection_details, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#execute_sql_database_tools_connection.' if logger

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

  path = '/databaseToolsConnections/{databaseToolsConnectionId}/actions/executeSql'.sub('{databaseToolsConnectionId}', database_tools_connection_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(execute_sql_database_tools_connection_details)

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

#get_credential(database_tools_connection_id, credential_key, opts = {}) ⇒ Response

Note:

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

Get a credential

Parameters:

  • database_tools_connection_id (String) —

    The OCID of a Database Tools connection.

  • credential_key (String) —

    The name of the 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) —

    If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation's current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

Returns:



1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 1055

def get_credential(database_tools_connection_id, credential_key, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#get_credential.' if logger

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

  path = '/databaseToolsConnections/{databaseToolsConnectionId}/credentials/{credentialKey}'.sub('{databaseToolsConnectionId}', database_tools_connection_id.to_s).sub('{credentialKey}', credential_key.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: 'DatabaseToolsRuntimeClient#get_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::DatabaseToolsRuntime::Models::Credential'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_credential_execute_grantee(database_tools_connection_id, credential_key, execute_grantee_key, opts = {}) ⇒ Response

Note:

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

Get a credential execute grantee

Parameters:

  • database_tools_connection_id (String) —

    The OCID of a Database Tools connection.

  • credential_key (String) —

    The name of the credential

  • execute_grantee_key (String) —

    The name of the user granted the EXECUTE privilege on the 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) —

    If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation's current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

Returns:



1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
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
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 1122

def get_credential_execute_grantee(database_tools_connection_id, credential_key, execute_grantee_key, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#get_credential_execute_grantee.' if logger

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

  path = '/databaseToolsConnections/{databaseToolsConnectionId}/credentials/{credentialKey}/executeGrantees/{executeGranteeKey}'.sub('{databaseToolsConnectionId}', database_tools_connection_id.to_s).sub('{credentialKey}', credential_key.to_s).sub('{executeGranteeKey}', execute_grantee_key.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: 'DatabaseToolsRuntimeClient#get_credential_execute_grantee') 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::DatabaseToolsRuntime::Models::CredentialExecuteGrantee'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_credential_public_synonym(database_tools_connection_id, credential_key, public_synonym_key, opts = {}) ⇒ Response

Note:

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

Get a public synonym

Parameters:

  • database_tools_connection_id (String) —

    The OCID of a Database Tools connection.

  • credential_key (String) —

    The name of the credential

  • public_synonym_key (String) —

    The name of the public synonym for the 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) —

    If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation's current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

Returns:



1191
1192
1193
1194
1195
1196
1197
1198
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
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 1191

def get_credential_public_synonym(database_tools_connection_id, credential_key, public_synonym_key, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#get_credential_public_synonym.' if logger

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

  path = '/databaseToolsConnections/{databaseToolsConnectionId}/credentials/{credentialKey}/publicSynonyms/{publicSynonymKey}'.sub('{databaseToolsConnectionId}', database_tools_connection_id.to_s).sub('{credentialKey}', credential_key.to_s).sub('{publicSynonymKey}', public_synonym_key.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: 'DatabaseToolsRuntimeClient#get_credential_public_synonym') 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::DatabaseToolsRuntime::Models::CredentialPublicSynonym'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_database_tools_database_api_gateway_config_content(database_tools_database_api_gateway_config_id, opts = {}, &block) ⇒ Response

Note:

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

Get the content of a Database Tools database API gateway config

Parameters:

  • database_tools_database_api_gateway_config_id (String) —

    The OCID of a Database Tools database API gateway config.

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

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

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) —

    If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation's current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

  • :if_none_match (String) —

    For conditional requests. In the GET call for a resource, set the If-None-Match header to the value of the ETag from a previous GET (or POST or PUT) response for that resource. The server will return with either a 304 Not Modified response if the resource has not changed, or a 200 OK response with the updated representation.

  • :response_target (String, IO) —

    Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

  • (Response) —

    A Response object with data of type String if response_target and block are not given, otherwise with nil data



1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
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
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 1266

def get_database_tools_database_api_gateway_config_content(database_tools_database_api_gateway_config_id, opts = {}, &block)
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#get_database_tools_database_api_gateway_config_content.' if logger

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

  path = '/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/content'.sub('{databaseToolsDatabaseApiGatewayConfigId}', database_tools_database_api_gateway_config_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseToolsRuntimeClient#get_database_tools_database_api_gateway_config_content') do
    if !block.nil?
      @api_client.call_api(
        :GET,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @api_client.call_api(
          :GET,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @api_client.call_api(
            :GET,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            operation_signing_strategy: operation_signing_strategy,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @api_client.call_api(
        :GET,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#get_database_tools_database_api_gateway_config_global(database_tools_database_api_gateway_config_id, global_key, opts = {}) ⇒ Response

Note:

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

Get a Database Tools database API gateway config global resource

Parameters:

  • database_tools_database_api_gateway_config_id (String) —

    The OCID of a Database Tools database API gateway config.

  • global_key (String) —

    The key of the global config.

  • 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) —

    If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation's current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

Returns:



1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 1375

def get_database_tools_database_api_gateway_config_global(database_tools_database_api_gateway_config_id, global_key, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#get_database_tools_database_api_gateway_config_global.' if logger

  raise "Missing the required parameter 'database_tools_database_api_gateway_config_id' when calling get_database_tools_database_api_gateway_config_global." if database_tools_database_api_gateway_config_id.nil?
  raise "Missing the required parameter 'global_key' when calling get_database_tools_database_api_gateway_config_global." if global_key.nil?
  unless OCI::DatabaseToolsRuntime::Models::DATABASE_API_GATEWAY_CONFIG_GLOBAL_KEY_ENUM.include?(global_key)
    raise 'Invalid value for "global_key", must be one of the values in OCI::DatabaseToolsRuntime::Models::DATABASE_API_GATEWAY_CONFIG_GLOBAL_KEY_ENUM.'
  end

  raise "Parameter value for 'database_tools_database_api_gateway_config_id' must not be blank" if OCI::Internal::Util.blank_string?(database_tools_database_api_gateway_config_id)
  raise "Parameter value for 'global_key' must not be blank" if OCI::Internal::Util.blank_string?(global_key)

  path = '/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/globals/{globalKey}'.sub('{databaseToolsDatabaseApiGatewayConfigId}', database_tools_database_api_gateway_config_id.to_s).sub('{globalKey}', global_key.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: 'DatabaseToolsRuntimeClient#get_database_tools_database_api_gateway_config_global') 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::DatabaseToolsRuntime::Models::DatabaseToolsDatabaseApiGatewayConfigGlobal'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_database_tools_database_api_gateway_config_pool(database_tools_database_api_gateway_config_id, pool_key, opts = {}) ⇒ Response

Note:

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

Get a Database Tools database API gateway config pool resource

Parameters:

  • database_tools_database_api_gateway_config_id (String) —

    The OCID of a Database Tools database API gateway config.

  • pool_key (String) —

    The key of the pool config.

  • 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) —

    If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation's current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

Returns:



1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 1445

def get_database_tools_database_api_gateway_config_pool(database_tools_database_api_gateway_config_id, pool_key, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#get_database_tools_database_api_gateway_config_pool.' if logger

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

  path = '/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools/{poolKey}'.sub('{databaseToolsDatabaseApiGatewayConfigId}', database_tools_database_api_gateway_config_id.to_s).sub('{poolKey}', pool_key.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: 'DatabaseToolsRuntimeClient#get_database_tools_database_api_gateway_config_pool') 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::DatabaseToolsRuntime::Models::DatabaseToolsDatabaseApiGatewayConfigPool'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_database_tools_database_api_gateway_config_pool_api_spec(database_tools_database_api_gateway_config_id, pool_key, api_spec_key, opts = {}) ⇒ Response

Note:

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

Get a Database Tools database API gateway config API spec resource

Parameters:

  • database_tools_database_api_gateway_config_id (String) —

    The OCID of a Database Tools database API gateway config.

  • pool_key (String) —

    The key of the pool config.

  • api_spec_key (String) —

    The key of the API spec config.

  • 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) —

    If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation's current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

Returns:



1512
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
1551
1552
1553
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 1512

def get_database_tools_database_api_gateway_config_pool_api_spec(database_tools_database_api_gateway_config_id, pool_key, api_spec_key, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#get_database_tools_database_api_gateway_config_pool_api_spec.' if logger

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

  path = '/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools/{poolKey}/apiSpecs/{apiSpecKey}'.sub('{databaseToolsDatabaseApiGatewayConfigId}', database_tools_database_api_gateway_config_id.to_s).sub('{poolKey}', pool_key.to_s).sub('{apiSpecKey}', api_spec_key.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: 'DatabaseToolsRuntimeClient#get_database_tools_database_api_gateway_config_pool_api_spec') 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::DatabaseToolsRuntime::Models::DatabaseToolsDatabaseApiGatewayConfigPoolApiSpec'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_database_tools_database_api_gateway_config_pool_auto_api_spec(database_tools_database_api_gateway_config_id, pool_key, auto_api_spec_key, opts = {}) ⇒ Response

Note:

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

Get a Database Tools database API gateway config auto API spec resource

Parameters:

  • database_tools_database_api_gateway_config_id (String) —

    The OCID of a Database Tools database API gateway config.

  • pool_key (String) —

    The key of the pool config.

  • auto_api_spec_key (String) —

    The key of the auto API spec config.

  • 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) —

    If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation's current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

Returns:



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
1615
1616
1617
1618
1619
1620
1621
1622
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 1581

def get_database_tools_database_api_gateway_config_pool_auto_api_spec(database_tools_database_api_gateway_config_id, pool_key, auto_api_spec_key, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#get_database_tools_database_api_gateway_config_pool_auto_api_spec.' if logger

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

  path = '/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools/{poolKey}/autoApiSpecs/{autoApiSpecKey}'.sub('{databaseToolsDatabaseApiGatewayConfigId}', database_tools_database_api_gateway_config_id.to_s).sub('{poolKey}', pool_key.to_s).sub('{autoApiSpecKey}', auto_api_spec_key.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: 'DatabaseToolsRuntimeClient#get_database_tools_database_api_gateway_config_pool_auto_api_spec') 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::DatabaseToolsRuntime::Models::DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_property_set(database_tools_connection_id, property_set_key, opts = {}) ⇒ Response

Note:

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

Get a property set

Parameters:

  • database_tools_connection_id (String) —

    The OCID of a Database Tools connection.

  • property_set_key (String) —

    The name of the property set

  • 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) —

    If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation's current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

Returns:



1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 1649

def get_property_set(database_tools_connection_id, property_set_key, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#get_property_set.' if logger

  raise "Missing the required parameter 'database_tools_connection_id' when calling get_property_set." if database_tools_connection_id.nil?
  raise "Missing the required parameter 'property_set_key' when calling get_property_set." if property_set_key.nil?
  unless OCI::DatabaseToolsRuntime::Models::PROPERTY_SET_KEY_ENUM.include?(property_set_key)
    raise 'Invalid value for "property_set_key", must be one of the values in OCI::DatabaseToolsRuntime::Models::PROPERTY_SET_KEY_ENUM.'
  end

  raise "Parameter value for 'database_tools_connection_id' must not be blank" if OCI::Internal::Util.blank_string?(database_tools_connection_id)
  raise "Parameter value for 'property_set_key' must not be blank" if OCI::Internal::Util.blank_string?(property_set_key)

  path = '/databaseToolsConnections/{databaseToolsConnectionId}/propertySets/{propertySetKey}'.sub('{databaseToolsConnectionId}', database_tools_connection_id.to_s).sub('{propertySetKey}', property_set_key.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: 'DatabaseToolsRuntimeClient#get_property_set') 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::DatabaseToolsRuntime::Models::PropertySet'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_user_credential(database_tools_connection_id, user_key, credential_key, opts = {}) ⇒ Response

Note:

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

Get a user credential

Parameters:

  • database_tools_connection_id (String) —

    The OCID of a Database Tools connection.

  • user_key (String) —

    The name of the database user.

  • credential_key (String) —

    The name of the 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) —

    If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation's current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

Returns:



1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 1720

def get_user_credential(database_tools_connection_id, user_key, credential_key, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#get_user_credential.' if logger

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

  path = '/databaseToolsConnections/{databaseToolsConnectionId}/users/{userKey}/credentials/{credentialKey}'.sub('{databaseToolsConnectionId}', database_tools_connection_id.to_s).sub('{userKey}', user_key.to_s).sub('{credentialKey}', credential_key.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: 'DatabaseToolsRuntimeClient#get_user_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::DatabaseToolsRuntime::Models::UserCredential'
    )
  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 specified work request.

Parameters:

  • work_request_id (String) —

    The ID of the asynchronous 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:



1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 1779

def get_work_request(work_request_id, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#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: 'DatabaseToolsRuntimeClient#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::DatabaseToolsRuntime::Models::WorkRequest'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_credential_execute_grantees(database_tools_connection_id, credential_key, opts = {}) ⇒ Response

Note:

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

Get a list of all execute grantees

Parameters:

  • database_tools_connection_id (String) —

    The OCID of a Database Tools connection.

  • credential_key (String) —

    The name of the 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) —

    If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation's current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

  • :limit (Integer) —

    The maximum number of items to return. (default to 10)

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to ASC)

Returns:



1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 1845

def list_credential_execute_grantees(database_tools_connection_id, credential_key, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#list_credential_execute_grantees.' if logger

  raise "Missing the required parameter 'database_tools_connection_id' when calling list_credential_execute_grantees." if database_tools_connection_id.nil?
  raise "Missing the required parameter 'credential_key' when calling list_credential_execute_grantees." if credential_key.nil?

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

  path = '/databaseToolsConnections/{databaseToolsConnectionId}/credentials/{credentialKey}/executeGrantees'.sub('{databaseToolsConnectionId}', database_tools_connection_id.to_s).sub('{credentialKey}', credential_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # 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: 'DatabaseToolsRuntimeClient#list_credential_execute_grantees') 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::DatabaseToolsRuntime::Models::CredentialExecuteGranteeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_credential_public_synonyms(database_tools_connection_id, credential_key, opts = {}) ⇒ Response

Note:

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

Get a list of all public synonyms for the given credential

Parameters:

  • database_tools_connection_id (String) —

    The OCID of a Database Tools connection.

  • credential_key (String) —

    The name of the 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) —

    If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation's current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

  • :limit (Integer) —

    The maximum number of items to return. (default to 10)

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to ASC)

Returns:



1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 1921

def list_credential_public_synonyms(database_tools_connection_id, credential_key, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#list_credential_public_synonyms.' if logger

  raise "Missing the required parameter 'database_tools_connection_id' when calling list_credential_public_synonyms." if database_tools_connection_id.nil?
  raise "Missing the required parameter 'credential_key' when calling list_credential_public_synonyms." if credential_key.nil?

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

  path = '/databaseToolsConnections/{databaseToolsConnectionId}/credentials/{credentialKey}/publicSynonyms'.sub('{databaseToolsConnectionId}', database_tools_connection_id.to_s).sub('{credentialKey}', credential_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # 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: 'DatabaseToolsRuntimeClient#list_credential_public_synonyms') 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::DatabaseToolsRuntime::Models::CredentialPublicSynonymCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_credentials(database_tools_connection_id, opts = {}) ⇒ Response

Note:

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

Returns a paginated list of CredentialSummary for the specified request.

Parameters:

  • database_tools_connection_id (String) —

    The OCID of a Database Tools connection.

  • 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) —

    If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation's current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

  • :limit (Integer) —

    The maximum number of items to return. (default to 10)

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to ASC)

Returns:



1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 1996

def list_credentials(database_tools_connection_id, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#list_credentials.' if logger

  raise "Missing the required parameter 'database_tools_connection_id' when calling list_credentials." if database_tools_connection_id.nil?

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

  path = '/databaseToolsConnections/{databaseToolsConnectionId}/credentials'.sub('{databaseToolsConnectionId}', database_tools_connection_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # 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: 'DatabaseToolsRuntimeClient#list_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::DatabaseToolsRuntime::Models::CredentialCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_database_tools_database_api_gateway_config_advanced_properties(opts = {}) ⇒ Response

Note:

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

Returns list of database API gateway config setting descriptions to be provided as advanced properties.

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 2057

def list_database_tools_database_api_gateway_config_advanced_properties(opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#list_database_tools_database_api_gateway_config_advanced_properties.' if logger


  path = '/databaseToolsDatabaseApiGatewayConfigAdvancedProperties'
  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: 'DatabaseToolsRuntimeClient#list_database_tools_database_api_gateway_config_advanced_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::DatabaseToolsRuntime::Models::DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_database_tools_database_api_gateway_config_pool_api_specs(database_tools_database_api_gateway_config_id, pool_key, opts = {}) ⇒ Response

Note:

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

Returns a list of Database Tools database API gateway config API spec resources Allowed values are: timeCreated, displayName

Parameters:

  • database_tools_database_api_gateway_config_id (String) —

    The OCID of a Database Tools database API gateway config.

  • pool_key (String) —

    The key of the pool config.

  • 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 return only resources that match the entire specified display name.

  • :limit (Integer) —

    The maximum number of items to return. (default to 10)

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to ASC)

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. (default to timeCreated)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
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
2168
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 2117

def list_database_tools_database_api_gateway_config_pool_api_specs(database_tools_database_api_gateway_config_id, pool_key, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#list_database_tools_database_api_gateway_config_pool_api_specs.' if logger

  raise "Missing the required parameter 'database_tools_database_api_gateway_config_id' when calling list_database_tools_database_api_gateway_config_pool_api_specs." if database_tools_database_api_gateway_config_id.nil?
  raise "Missing the required parameter 'pool_key' when calling list_database_tools_database_api_gateway_config_pool_api_specs." if pool_key.nil?

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

  if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.'
  end
  raise "Parameter value for 'database_tools_database_api_gateway_config_id' must not be blank" if OCI::Internal::Util.blank_string?(database_tools_database_api_gateway_config_id)
  raise "Parameter value for 'pool_key' must not be blank" if OCI::Internal::Util.blank_string?(pool_key)

  path = '/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools/{poolKey}/apiSpecs'.sub('{databaseToolsDatabaseApiGatewayConfigId}', database_tools_database_api_gateway_config_id.to_s).sub('{poolKey}', pool_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[: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: 'DatabaseToolsRuntimeClient#list_database_tools_database_api_gateway_config_pool_api_specs') 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::DatabaseToolsRuntime::Models::DatabaseToolsDatabaseApiGatewayConfigPoolApiSpecCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_database_tools_database_api_gateway_config_pool_auto_api_specs(database_tools_database_api_gateway_config_id, pool_key, opts = {}) ⇒ Response

Note:

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

Returns a list of Database Tools database API gateway config auto API spec resources Allowed values are: timeCreated, displayName

Parameters:

  • database_tools_database_api_gateway_config_id (String) —

    The OCID of a Database Tools database API gateway config.

  • pool_key (String) —

    The key of the pool config.

  • 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 return only resources that match the entire specified display name.

  • :limit (Integer) —

    The maximum number of items to return. (default to 10)

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to ASC)

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. (default to timeCreated)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



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
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 2194

def list_database_tools_database_api_gateway_config_pool_auto_api_specs(database_tools_database_api_gateway_config_id, pool_key, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#list_database_tools_database_api_gateway_config_pool_auto_api_specs.' if logger

  raise "Missing the required parameter 'database_tools_database_api_gateway_config_id' when calling list_database_tools_database_api_gateway_config_pool_auto_api_specs." if database_tools_database_api_gateway_config_id.nil?
  raise "Missing the required parameter 'pool_key' when calling list_database_tools_database_api_gateway_config_pool_auto_api_specs." if pool_key.nil?

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

  if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.'
  end
  raise "Parameter value for 'database_tools_database_api_gateway_config_id' must not be blank" if OCI::Internal::Util.blank_string?(database_tools_database_api_gateway_config_id)
  raise "Parameter value for 'pool_key' must not be blank" if OCI::Internal::Util.blank_string?(pool_key)

  path = '/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools/{poolKey}/autoApiSpecs'.sub('{databaseToolsDatabaseApiGatewayConfigId}', database_tools_database_api_gateway_config_id.to_s).sub('{poolKey}', pool_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[: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: 'DatabaseToolsRuntimeClient#list_database_tools_database_api_gateway_config_pool_auto_api_specs') 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::DatabaseToolsRuntime::Models::DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_database_tools_database_api_gateway_config_pools(database_tools_database_api_gateway_config_id, opts = {}) ⇒ Response

Note:

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

Returns a list of Database Tools database API gateway config pool resources Allowed values are: timeCreated, displayName

Parameters:

  • database_tools_database_api_gateway_config_id (String) —

    The OCID of a Database Tools database API gateway config.

  • 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 return only resources that match the entire specified display name.

  • :limit (Integer) —

    The maximum number of items to return. (default to 10)

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to ASC)

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. (default to timeCreated)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 2270

def list_database_tools_database_api_gateway_config_pools(database_tools_database_api_gateway_config_id, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#list_database_tools_database_api_gateway_config_pools.' if logger

  raise "Missing the required parameter 'database_tools_database_api_gateway_config_id' when calling list_database_tools_database_api_gateway_config_pools." if database_tools_database_api_gateway_config_id.nil?

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

  if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.'
  end
  raise "Parameter value for 'database_tools_database_api_gateway_config_id' must not be blank" if OCI::Internal::Util.blank_string?(database_tools_database_api_gateway_config_id)

  path = '/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools'.sub('{databaseToolsDatabaseApiGatewayConfigId}', database_tools_database_api_gateway_config_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[: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: 'DatabaseToolsRuntimeClient#list_database_tools_database_api_gateway_config_pools') 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::DatabaseToolsRuntime::Models::DatabaseToolsDatabaseApiGatewayConfigPoolCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_user_credentials(database_tools_connection_id, user_key, opts = {}) ⇒ Response

Note:

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

Returns a paginated list of user UserCredentialSummary for the specified request.

Parameters:

  • database_tools_connection_id (String) —

    The OCID of a Database Tools connection.

  • user_key (String) —

    The name of the database user.

  • 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) —

    If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation's current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

  • :limit (Integer) —

    The maximum number of items to return. (default to 10)

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to ASC)

Returns:



2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
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
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 2349

def list_user_credentials(database_tools_connection_id, user_key, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#list_user_credentials.' if logger

  raise "Missing the required parameter 'database_tools_connection_id' when calling list_user_credentials." if database_tools_connection_id.nil?
  raise "Missing the required parameter 'user_key' when calling list_user_credentials." if user_key.nil?

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

  path = '/databaseToolsConnections/{databaseToolsConnectionId}/users/{userKey}/credentials'.sub('{databaseToolsConnectionId}', database_tools_connection_id.to_s).sub('{userKey}', user_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # 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: 'DatabaseToolsRuntimeClient#list_user_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::DatabaseToolsRuntime::Models::UserCredentialCollection'
    )
  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 the specified work request.

Allowed values are: timeCreated, displayName

Parameters:

  • work_request_id (String) —

    The ID of the asynchronous 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.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to ASC)

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. (default to timeCreated)

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of items to return. (default to 10)

Returns:



2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
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
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 2420

def list_work_request_errors(work_request_id, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#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_order] && !OCI::DatabaseToolsRuntime::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseToolsRuntime::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.'
  end
  raise "Parameter value for '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[: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: 'DatabaseToolsRuntimeClient#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::DatabaseToolsRuntime::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 the specified work request.

Allowed values are: timeCreated, displayName

Parameters:

  • work_request_id (String) —

    The ID of the asynchronous 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.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to ASC)

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. (default to timeCreated)

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of items to return. (default to 10)

Returns:



2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 2493

def list_work_request_logs(work_request_id, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#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_order] && !OCI::DatabaseToolsRuntime::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseToolsRuntime::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.'
  end
  raise "Parameter value for '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[: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: 'DatabaseToolsRuntimeClient#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::DatabaseToolsRuntime::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.

Lists the work requests in a compartment.

Allowed values are: timeAccepted, timeUpdated, timeFinished

Parameters:

  • compartment_id (String) —

    The ID of the compartment in which to list resources.

  • 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_identifier (String) —

    The OCID of the resource.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to ASC)

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. If no value is specified timeAccepted is default. (default to timeAccepted)

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of items to return. (default to 10)

  • :operation_type (Array<String>) —

    The work request operation type. Allowed values are: EXECUTE_SQL, EXECUTE_SQL_SCHEDULED_DELETION

  • :created_by_principal_id (String) —

    A filter to return only work requests initiated by the specified principal OCID.

  • :status (Array<String>) —

    A filter to return only work requests with one of the specified status values. Allowed values are: ACCEPTED, IN_PROGRESS, FAILED, SUCCEEDED, CANCELING, CANCELED, WAITING

Returns:



2572
2573
2574
2575
2576
2577
2578
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
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 2572

def list_work_requests(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#list_work_requests.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_work_requests." if compartment_id.nil?

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

  if opts[:sort_by] && !%w[timeAccepted timeUpdated timeFinished].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeAccepted, timeUpdated, timeFinished.'
  end


  operation_type_allowable_values = %w[EXECUTE_SQL EXECUTE_SQL_SCHEDULED_DELETION]
  if opts[:operation_type] && !opts[:operation_type].empty?
    opts[:operation_type].each do |val_to_check|
      unless operation_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "operation_type", must be one of EXECUTE_SQL, EXECUTE_SQL_SCHEDULED_DELETION.'
      end
    end
  end


  status_allowable_values = %w[ACCEPTED IN_PROGRESS FAILED SUCCEEDED CANCELING CANCELED WAITING]
  if opts[:status] && !opts[:status].empty?
    opts[:status].each do |val_to_check|
      unless status_allowable_values.include?(val_to_check)
        raise 'Invalid value for "status", must be one of ACCEPTED, IN_PROGRESS, FAILED, SUCCEEDED, CANCELING, CANCELED, WAITING.'
      end
    end
  end

  path = '/workRequests'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:resourceIdentifier] = opts[:resource_identifier] if opts[:resource_identifier]
  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]
  query_params[:operationType] = OCI::ApiClient.build_collection_params(opts[:operation_type], :multi) if opts[:operation_type] && !opts[:operation_type].empty?
  query_params[:createdByPrincipalId] = opts[:created_by_principal_id] if opts[:created_by_principal_id]
  query_params[:status] = OCI::ApiClient.build_collection_params(opts[:status], :multi) if opts[:status] && !opts[:status].empty?

  # 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: 'DatabaseToolsRuntimeClient#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::DatabaseToolsRuntime::Models::WorkRequestCollection'
    )
  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.



94
95
96
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 94

def logger
  @api_client.config.logger
end

#update_credential(database_tools_connection_id, credential_key, update_credential_details, opts = {}) ⇒ Response

Note:

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

Update a credential

Parameters:

  • database_tools_connection_id (String) —

    The OCID of a Database Tools connection.

  • credential_key (String) —

    The name of the credential

  • update_credential_details (OCI::DatabaseToolsRuntime::Models::UpdateCredentialDetails) —

    The information to be updated.

  • 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) —

    If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation's current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

Returns:



2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 2672

def update_credential(database_tools_connection_id, credential_key, update_credential_details, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#update_credential.' if logger

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

  path = '/databaseToolsConnections/{databaseToolsConnectionId}/credentials/{credentialKey}'.sub('{databaseToolsConnectionId}', database_tools_connection_id.to_s).sub('{credentialKey}', credential_key.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_credential_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseToolsRuntimeClient#update_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::DatabaseToolsRuntime::Models::Credential'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_database_tools_database_api_gateway_config_global(database_tools_database_api_gateway_config_id, global_key, update_database_tools_database_api_gateway_config_global_details, opts = {}) ⇒ Response

Note:

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

Update a Database Tools database API gateway config global 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.

  • :if_match (String) —

    If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation's current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

Returns:



2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 2740

def update_database_tools_database_api_gateway_config_global(database_tools_database_api_gateway_config_id, global_key, update_database_tools_database_api_gateway_config_global_details, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#update_database_tools_database_api_gateway_config_global.' if logger

  raise "Missing the required parameter 'database_tools_database_api_gateway_config_id' when calling update_database_tools_database_api_gateway_config_global." if database_tools_database_api_gateway_config_id.nil?
  raise "Missing the required parameter 'global_key' when calling update_database_tools_database_api_gateway_config_global." if global_key.nil?
  unless OCI::DatabaseToolsRuntime::Models::DATABASE_API_GATEWAY_CONFIG_GLOBAL_KEY_ENUM.include?(global_key)
    raise 'Invalid value for "global_key", must be one of the values in OCI::DatabaseToolsRuntime::Models::DATABASE_API_GATEWAY_CONFIG_GLOBAL_KEY_ENUM.'
  end

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

  path = '/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/globals/{globalKey}'.sub('{databaseToolsDatabaseApiGatewayConfigId}', database_tools_database_api_gateway_config_id.to_s).sub('{globalKey}', global_key.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_database_tools_database_api_gateway_config_global_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseToolsRuntimeClient#update_database_tools_database_api_gateway_config_global') 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::DatabaseToolsRuntime::Models::DatabaseToolsDatabaseApiGatewayConfigGlobal'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_database_tools_database_api_gateway_config_pool(database_tools_database_api_gateway_config_id, pool_key, update_database_tools_database_api_gateway_config_pool_details, opts = {}) ⇒ Response

Note:

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

Update a Database Tools database API gateway config pool 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.

  • :if_match (String) —

    If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation's current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

Returns:



2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 2812

def update_database_tools_database_api_gateway_config_pool(database_tools_database_api_gateway_config_id, pool_key, update_database_tools_database_api_gateway_config_pool_details, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#update_database_tools_database_api_gateway_config_pool.' if logger

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

  path = '/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools/{poolKey}'.sub('{databaseToolsDatabaseApiGatewayConfigId}', database_tools_database_api_gateway_config_id.to_s).sub('{poolKey}', pool_key.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_database_tools_database_api_gateway_config_pool_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseToolsRuntimeClient#update_database_tools_database_api_gateway_config_pool') 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::DatabaseToolsRuntime::Models::DatabaseToolsDatabaseApiGatewayConfigPool'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_database_tools_database_api_gateway_config_pool_api_spec(database_tools_database_api_gateway_config_id, pool_key, api_spec_key, update_database_tools_database_api_gateway_config_pool_api_spec_details, opts = {}) ⇒ Response

Note:

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

Update a Database Tools database API gateway config API spec 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.

  • :if_match (String) —

    If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation's current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

Returns:



2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 2881

def update_database_tools_database_api_gateway_config_pool_api_spec(database_tools_database_api_gateway_config_id, pool_key, api_spec_key, update_database_tools_database_api_gateway_config_pool_api_spec_details, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#update_database_tools_database_api_gateway_config_pool_api_spec.' if logger

  raise "Missing the required parameter 'database_tools_database_api_gateway_config_id' when calling update_database_tools_database_api_gateway_config_pool_api_spec." if database_tools_database_api_gateway_config_id.nil?
  raise "Missing the required parameter 'pool_key' when calling update_database_tools_database_api_gateway_config_pool_api_spec." if pool_key.nil?
  raise "Missing the required parameter 'api_spec_key' when calling update_database_tools_database_api_gateway_config_pool_api_spec." if api_spec_key.nil?
  raise "Missing the required parameter 'update_database_tools_database_api_gateway_config_pool_api_spec_details' when calling update_database_tools_database_api_gateway_config_pool_api_spec." if update_database_tools_database_api_gateway_config_pool_api_spec_details.nil?
  raise "Parameter value for 'database_tools_database_api_gateway_config_id' must not be blank" if OCI::Internal::Util.blank_string?(database_tools_database_api_gateway_config_id)
  raise "Parameter value for 'pool_key' must not be blank" if OCI::Internal::Util.blank_string?(pool_key)
  raise "Parameter value for 'api_spec_key' must not be blank" if OCI::Internal::Util.blank_string?(api_spec_key)

  path = '/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools/{poolKey}/apiSpecs/{apiSpecKey}'.sub('{databaseToolsDatabaseApiGatewayConfigId}', database_tools_database_api_gateway_config_id.to_s).sub('{poolKey}', pool_key.to_s).sub('{apiSpecKey}', api_spec_key.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_database_tools_database_api_gateway_config_pool_api_spec_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseToolsRuntimeClient#update_database_tools_database_api_gateway_config_pool_api_spec') 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::DatabaseToolsRuntime::Models::DatabaseToolsDatabaseApiGatewayConfigPoolApiSpec'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_database_tools_database_api_gateway_config_pool_auto_api_spec(database_tools_database_api_gateway_config_id, pool_key, auto_api_spec_key, update_database_tools_database_api_gateway_config_pool_auto_api_spec_details, opts = {}) ⇒ Response

Note:

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

Update a Database Tools database API gateway config auto API spec 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.

  • :if_match (String) —

    If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation's current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

Returns:



2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 2952

def update_database_tools_database_api_gateway_config_pool_auto_api_spec(database_tools_database_api_gateway_config_id, pool_key, auto_api_spec_key, update_database_tools_database_api_gateway_config_pool_auto_api_spec_details, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#update_database_tools_database_api_gateway_config_pool_auto_api_spec.' if logger

  raise "Missing the required parameter 'database_tools_database_api_gateway_config_id' when calling update_database_tools_database_api_gateway_config_pool_auto_api_spec." if database_tools_database_api_gateway_config_id.nil?
  raise "Missing the required parameter 'pool_key' when calling update_database_tools_database_api_gateway_config_pool_auto_api_spec." if pool_key.nil?
  raise "Missing the required parameter 'auto_api_spec_key' when calling update_database_tools_database_api_gateway_config_pool_auto_api_spec." if auto_api_spec_key.nil?
  raise "Missing the required parameter 'update_database_tools_database_api_gateway_config_pool_auto_api_spec_details' when calling update_database_tools_database_api_gateway_config_pool_auto_api_spec." if update_database_tools_database_api_gateway_config_pool_auto_api_spec_details.nil?
  raise "Parameter value for 'database_tools_database_api_gateway_config_id' must not be blank" if OCI::Internal::Util.blank_string?(database_tools_database_api_gateway_config_id)
  raise "Parameter value for 'pool_key' must not be blank" if OCI::Internal::Util.blank_string?(pool_key)
  raise "Parameter value for 'auto_api_spec_key' must not be blank" if OCI::Internal::Util.blank_string?(auto_api_spec_key)

  path = '/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools/{poolKey}/autoApiSpecs/{autoApiSpecKey}'.sub('{databaseToolsDatabaseApiGatewayConfigId}', database_tools_database_api_gateway_config_id.to_s).sub('{poolKey}', pool_key.to_s).sub('{autoApiSpecKey}', auto_api_spec_key.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_database_tools_database_api_gateway_config_pool_auto_api_spec_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseToolsRuntimeClient#update_database_tools_database_api_gateway_config_pool_auto_api_spec') 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::DatabaseToolsRuntime::Models::DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_property_set(database_tools_connection_id, property_set_key, update_property_set_details, opts = {}) ⇒ Response

Note:

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

Update a property set

Parameters:

  • database_tools_connection_id (String) —

    The OCID of a Database Tools connection.

  • property_set_key (String) —

    The name of the property set

  • update_property_set_details (OCI::DatabaseToolsRuntime::Models::UpdatePropertySetDetails) —

    The information to be updated.

  • 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) —

    If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation's current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

Returns:



3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
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
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 3022

def update_property_set(database_tools_connection_id, property_set_key, update_property_set_details, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#update_property_set.' if logger

  raise "Missing the required parameter 'database_tools_connection_id' when calling update_property_set." if database_tools_connection_id.nil?
  raise "Missing the required parameter 'property_set_key' when calling update_property_set." if property_set_key.nil?
  unless OCI::DatabaseToolsRuntime::Models::PROPERTY_SET_KEY_ENUM.include?(property_set_key)
    raise 'Invalid value for "property_set_key", must be one of the values in OCI::DatabaseToolsRuntime::Models::PROPERTY_SET_KEY_ENUM.'
  end

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

  path = '/databaseToolsConnections/{databaseToolsConnectionId}/propertySets/{propertySetKey}'.sub('{databaseToolsConnectionId}', database_tools_connection_id.to_s).sub('{propertySetKey}', property_set_key.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_property_set_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseToolsRuntimeClient#update_property_set') 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::DatabaseToolsRuntime::Models::PropertySet'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#validate_database_tools_connection(database_tools_connection_id, validate_database_tools_connection_details, opts = {}) ⇒ Response

Note:

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

Validates the specified Database Tools connection.

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) —

    If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation's current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

Returns:



3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 3093

def validate_database_tools_connection(database_tools_connection_id, validate_database_tools_connection_details, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#validate_database_tools_connection.' if logger

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

  path = '/databaseToolsConnections/{databaseToolsConnectionId}/actions/validateConnection'.sub('{databaseToolsConnectionId}', database_tools_connection_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(validate_database_tools_connection_details)

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

#validate_database_tools_identity_credential(database_tools_identity_id, validate_database_tools_identity_credential_details, opts = {}) ⇒ Response

Note:

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

Validates the Database Tools identity credentials by establishing a connection to the customer database and executing the dbms_cloud.send_request to validate the credential.

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) —

    If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation's current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
 
# File 'lib/oci/database_tools_runtime/database_tools_runtime_client.rb', line 3160

def validate_database_tools_identity_credential(database_tools_identity_id, validate_database_tools_identity_credential_details, opts = {})
  logger.debug 'Calling operation DatabaseToolsRuntimeClient#validate_database_tools_identity_credential.' if logger

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

  path = '/databaseToolsIdentities/{databaseToolsIdentityId}/actions/validateCredential'.sub('{databaseToolsIdentityId}', database_tools_identity_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(validate_database_tools_identity_credential_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseToolsRuntimeClient#validate_database_tools_identity_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::DatabaseToolsRuntime::Models::ValidateDatabaseToolsIdentityCredentialResult'
    )
  end
  # rubocop:enable Metrics/BlockLength
end