Class: OCI::Wlms::WeblogicManagementServiceClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/wlms/weblogic_management_service_client.rb

Overview

WebLogic Management Service is an OCI service that enables a unified view and management of WebLogic domains in Oracle Cloud Infrastructure. Features include on-demand patching of WebLogic domains, rollback of the last applied patch, discovery and management of WebLogic instances on a compute host.

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

Creates a new WeblogicManagementServiceClient. Notes: If a config is not specified, then the global OCI.config will be used.

This client is not thread-safe

Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the region. A region may be specified in the config or via or the region parameter. If specified in both, then the region parameter will be used.

Parameters:

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

    A Config object.

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

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

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

    The fully qualified endpoint URL

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

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

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

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

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

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



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

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

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

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

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

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



17
18
19
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 17

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 21

def endpoint
  @endpoint
end

#region ⇒ String

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

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 31

def region
  @region
end

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

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

Returns:



27
28
29
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 27

def retry_config
  @retry_config
end

Instance Method Details

#change_wls_domain_compartment(wls_domain_id, change_wls_domain_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a WebLogic domain into a different compartment within the same tenancy.

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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

def change_wls_domain_compartment(wls_domain_id, change_wls_domain_compartment_details, opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#change_wls_domain_compartment.' if logger

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

  path = '/wlsDomains/{wlsDomainId}/actions/changeCompartment'.sub('{wlsDomainId}', wls_domain_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(change_wls_domain_compartment_details)

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

#create_agreement_record(create_agreement_record_details, wls_domain_id, opts = {}) ⇒ Response

Note:

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

Creates a terms of use agreement record for a WebLogic domain.

Parameters:

  • create_agreement_record_details (OCI::Wlms::Models::CreateAgreementRecordDetails) —

    This object represents the fields to create a terms of use agreement record.

  • wls_domain_id (String) —

    The OCID of the WebLogic domain.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

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

Returns:



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 198

def create_agreement_record(create_agreement_record_details, wls_domain_id, opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#create_agreement_record.' if logger

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

  path = '/wlsDomains/{wlsDomainId}/agreementRecords'.sub('{wlsDomainId}', wls_domain_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(create_agreement_record_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'WeblogicManagementServiceClient#create_agreement_record') 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::Wlms::Models::AgreementRecord'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_wls_domain(wls_domain_id, opts = {}) ⇒ Response

Note:

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

Delete the WebLogic domain.

Parameters:

  • wls_domain_id (String) —

    The OCID of the WebLogic domain.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 269

def delete_wls_domain(wls_domain_id, opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#delete_wls_domain.' if logger

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

  path = '/wlsDomains/{wlsDomainId}'.sub('{wlsDomainId}', wls_domain_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#get_agreement(opts = {}) ⇒ Response

Note:

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

Returns the terms and conditions of use agreement.

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:



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 325

def get_agreement(opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#get_agreement.' if logger


  path = '/agreement'
  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: 'WeblogicManagementServiceClient#get_agreement') 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::Wlms::Models::Agreement'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_managed_instance(managed_instance_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified managed instance.

Parameters:

  • managed_instance_id (String) —

    The OCID of the instance.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 378

def get_managed_instance(managed_instance_id, opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#get_managed_instance.' if logger

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

  path = '/managedInstances/{managedInstanceId}'.sub('{managedInstanceId}', managed_instance_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#get_managed_instance_server(managed_instance_id, server_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified server in a managed instance.

Parameters:

  • managed_instance_id (String) —

    The OCID of the instance.

  • server_id (String) —

    The unique identifier of a server.

    Note: Not an OCID.

  • 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:



437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 437

def get_managed_instance_server(managed_instance_id, server_id, opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#get_managed_instance_server.' if logger

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

  path = '/managedInstances/{managedInstanceId}/servers/{serverId}'.sub('{managedInstanceId}', managed_instance_id.to_s).sub('{serverId}', server_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#get_wls_domain(wls_domain_id, opts = {}) ⇒ Response

Note:

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

Gets a specific WebLogic domain.

Parameters:

  • wls_domain_id (String) —

    The OCID of the WebLogic domain.

  • 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:



494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 494

def get_wls_domain(wls_domain_id, opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#get_wls_domain.' if logger

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

  path = '/wlsDomains/{wlsDomainId}'.sub('{wlsDomainId}', wls_domain_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: 'WeblogicManagementServiceClient#get_wls_domain') 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::Wlms::Models::WlsDomain'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_wls_domain_credential(wls_domain_id, credential_type, opts = {}) ⇒ Response

Note:

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

Gets WebLogic and Node Manager credentials of a specific WebLogic domain.

Parameters:

  • wls_domain_id (String) —

    The OCID of the WebLogic domain.

  • credential_type (String) —

    The type of the credentials. Allowed values are: weblogicAdminUser, nodemanagerUser

  • 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:



551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 551

def get_wls_domain_credential(wls_domain_id, credential_type, opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#get_wls_domain_credential.' if logger

  raise "Missing the required parameter 'wls_domain_id' when calling get_wls_domain_credential." if wls_domain_id.nil?
  raise "Missing the required parameter 'credential_type' when calling get_wls_domain_credential." if credential_type.nil?
  unless %w[weblogicAdminUser nodemanagerUser].include?(credential_type)
    raise "Invalid value for 'credential_type', must be one of weblogicAdminUser, nodemanagerUser."
  end
  raise "Parameter value for 'wls_domain_id' must not be blank" if OCI::Internal::Util.blank_string?(wls_domain_id)
  raise "Parameter value for 'credential_type' must not be blank" if OCI::Internal::Util.blank_string?(credential_type)

  path = '/wlsDomains/{wlsDomainId}/credentials/{credentialType}'.sub('{wlsDomainId}', wls_domain_id.to_s).sub('{credentialType}', credential_type.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: 'WeblogicManagementServiceClient#get_wls_domain_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::Wlms::Models::WlsDomainCredential'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_wls_domain_server(wls_domain_id, server_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified server in a WebLogic domain.

Parameters:

  • wls_domain_id (String) —

    The OCID of the WebLogic domain.

  • server_id (String) —

    The unique identifier of a server.

    Note: Not an OCID.

  • 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:



615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 615

def get_wls_domain_server(wls_domain_id, server_id, opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#get_wls_domain_server.' if logger

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

  path = '/wlsDomains/{wlsDomainId}/servers/{serverId}'.sub('{wlsDomainId}', wls_domain_id.to_s).sub('{serverId}', server_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#get_wls_domain_server_backup(wls_domain_id, server_id, backup_id, opts = {}) ⇒ Response

Note:

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

Get details of specific backup for the WebLogic Domain.

Parameters:

  • wls_domain_id (String) —

    The OCID of the WebLogic domain.

  • server_id (String) —

    The unique identifier of a server.

    Note: Not an OCID.

  • backup_id (String) —

    The unique identifier of the backup.

    Note: Not an OCID.

  • 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:



680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 680

def get_wls_domain_server_backup(wls_domain_id, server_id, backup_id, opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#get_wls_domain_server_backup.' if logger

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

  path = '/wlsDomains/{wlsDomainId}/servers/{serverId}/backups/{backupId}'.sub('{wlsDomainId}', wls_domain_id.to_s).sub('{serverId}', server_id.to_s).sub('{backupId}', backup_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: 'WeblogicManagementServiceClient#get_wls_domain_server_backup') 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::Wlms::Models::Backup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_wls_domain_server_backup_content(wls_domain_id, server_id, backup_id, opts = {}) ⇒ Response

Note:

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

Get details of specific backup for the WebLogic Domain.

Parameters:

  • wls_domain_id (String) —

    The OCID of the WebLogic domain.

  • server_id (String) —

    The unique identifier of a server.

    Note: Not an OCID.

  • backup_id (String) —

    The unique identifier of the backup.

    Note: Not an OCID.

  • 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:



747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 747

def get_wls_domain_server_backup_content(wls_domain_id, server_id, backup_id, opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#get_wls_domain_server_backup_content.' if logger

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

  path = '/wlsDomains/{wlsDomainId}/servers/{serverId}/backups/{backupId}/content'.sub('{wlsDomainId}', wls_domain_id.to_s).sub('{serverId}', server_id.to_s).sub('{backupId}', backup_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: 'WeblogicManagementServiceClient#get_wls_domain_server_backup_content') 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::Wlms::Models::BackupContent'
    )
  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 details of a work request.

Parameters:

  • work_request_id (String) —

    The OCID of the asynchronous work request.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 806

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

#install_latest_patches_on_wls_domain(wls_domain_id, install_latest_patches_on_wls_domain_details, opts = {}) ⇒ Response

Note:

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

Install the latest patches on a WebLogic domain.

Parameters:

  • wls_domain_id (String) —

    The OCID of the WebLogic domain.

  • install_latest_patches_on_wls_domain_details (OCI::Wlms::Models::InstallLatestPatchesOnWlsDomainDetails) —

    Information for the operation to install latest patches to a WebLogic domain.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 874

def install_latest_patches_on_wls_domain(wls_domain_id, install_latest_patches_on_wls_domain_details, opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#install_latest_patches_on_wls_domain.' if logger

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

  path = '/wlsDomains/{wlsDomainId}/actions/installLatestPatches'.sub('{wlsDomainId}', wls_domain_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(install_latest_patches_on_wls_domain_details)

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

#list_agreement_records(wls_domain_id, opts = {}) ⇒ Response

Note:

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

List the terms of use agreement record for the WebLogic domain.

Parameters:

  • wls_domain_id (String) —

    The OCID of the WebLogic domain.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :limit (Integer) —

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

  • :page (String) —

    The page token that represents the page at which to start retrieving results. The token is usually retrieved from a previous List call.

  • :sort_order (String) —

    The sort order is either 'ASC' or 'DESC'. (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field by which to sort the resource. 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) Allowed values are: timeCreated, displayName

Returns:



942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 942

def list_agreement_records(wls_domain_id, opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#list_agreement_records.' if logger

  raise "Missing the required parameter 'wls_domain_id' when calling list_agreement_records." if wls_domain_id.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  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 'wls_domain_id' must not be blank" if OCI::Internal::Util.blank_string?(wls_domain_id)

  path = '/wlsDomains/{wlsDomainId}/agreementRecords'.sub('{wlsDomainId}', wls_domain_id.to_s)
  operation_signing_strategy = :standard

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

  # 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: 'WeblogicManagementServiceClient#list_agreement_records') 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::Wlms::Models::AgreementRecordCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_applicable_patches(wls_domain_id, opts = {}) ⇒ Response

Note:

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

Gets the latest patches that can be installed to the WebLogic domains.

Parameters:

  • wls_domain_id (String) —

    The OCID of the WebLogic domain.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

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

  • :limit (Integer) —

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

  • :page (String) —

    The page token that represents the page at which to start retrieving results. The token is usually retrieved from a previous List call.

  • :sort_order (String) —

    The sort order is either 'ASC' or 'DESC'. (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field by which to sort the resource. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified, displayName is default. (default to displayName) Allowed values are: displayName

Returns:



1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 1024

def list_applicable_patches(wls_domain_id, opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#list_applicable_patches.' if logger

  raise "Missing the required parameter 'wls_domain_id' when calling list_applicable_patches." if wls_domain_id.nil?

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

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

  path = '/wlsDomains/{wlsDomainId}/applicablePatches'.sub('{wlsDomainId}', wls_domain_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'WeblogicManagementServiceClient#list_applicable_patches') 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::Wlms::Models::ApplicablePatchCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_managed_instance_scan_results(managed_instance_id, opts = {}) ⇒ Response

Note:

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

Gets all the scan results for all WebLogic servers in the managed instance.

Parameters:

  • managed_instance_id (String) —

    The OCID of the instance.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :limit (Integer) —

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

  • :page (String) —

    The page token that represents the page at which to start retrieving results. The token is usually retrieved from a previous List call.

  • :sort_order (String) —

    The sort order is either 'ASC' or 'DESC'. (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field by which to sort the resource. Only one sort order may be provided. Default order for timeOfServerCheck is descending. Default order for serverName is ascending. If no value is specified, timeOfServerCheck is default. (default to timeOfServerCheck) Allowed values are: timeOfServerCheck, serverName

  • :wls_domain_id (String) —

    The OCID of the WebLogic domain.

  • :server_name (String) —

    The name of the server.

Returns:



1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
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
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 1105

def list_managed_instance_scan_results(managed_instance_id, opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#list_managed_instance_scan_results.' if logger

  raise "Missing the required parameter 'managed_instance_id' when calling list_managed_instance_scan_results." if managed_instance_id.nil?

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

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

  path = '/managedInstances/{managedInstanceId}/scanResults'.sub('{managedInstanceId}', managed_instance_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:wlsDomainId] = opts[:wls_domain_id] if opts[:wls_domain_id]
  query_params[:serverName] = opts[:server_name] if opts[:server_name]

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'WeblogicManagementServiceClient#list_managed_instance_scan_results') 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::Wlms::Models::ScanResultCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_managed_instance_server_installed_patches(managed_instance_id, server_id, opts = {}) ⇒ Response

Note:

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

Gets a list of installed patches on a server in a managed instance.

Parameters:

  • managed_instance_id (String) —

    The OCID of the instance.

  • server_id (String) —

    The unique identifier of a server.

    Note: Not an OCID.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :limit (Integer) —

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

  • :page (String) —

    The page token that represents the page at which to start retrieving results. The token is usually retrieved from a previous List call.

  • :sort_order (String) —

    The sort order is either 'ASC' or 'DESC'. (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field by which to sort the resource. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified, displayName is default. (default to displayName) Allowed values are: displayName

Returns:



1187
1188
1189
1190
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
1233
1234
1235
1236
1237
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 1187

def list_managed_instance_server_installed_patches(managed_instance_id, server_id, opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#list_managed_instance_server_installed_patches.' if logger

  raise "Missing the required parameter 'managed_instance_id' when calling list_managed_instance_server_installed_patches." if managed_instance_id.nil?
  raise "Missing the required parameter 'server_id' when calling list_managed_instance_server_installed_patches." if server_id.nil?

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

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

  path = '/managedInstances/{managedInstanceId}/servers/{serverId}/installedPatches'.sub('{managedInstanceId}', managed_instance_id.to_s).sub('{serverId}', server_id.to_s)
  operation_signing_strategy = :standard

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

  # 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: 'WeblogicManagementServiceClient#list_managed_instance_server_installed_patches') 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::Wlms::Models::InstalledPatchCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_managed_instance_servers(managed_instance_id, opts = {}) ⇒ Response

Note:

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

Gets list of servers in a specific managed instance.

Parameters:

  • managed_instance_id (String) —

    The OCID of the instance.

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

    the optional parameters

Options Hash (opts):

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

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

  • :name (String) —

    The name of the resource.

  • :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.

  • :limit (Integer) —

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

  • :page (String) —

    The page token that represents the page at which to start retrieving results. The token is usually retrieved from a previous List call.

  • :sort_order (String) —

    The sort order is either 'ASC' or 'DESC'. (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field by which to sort the resource. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending. If no value is specified, timeCreated is default. (default to timeCreated) Allowed values are: timeCreated, name

Returns:



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
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 1273

def list_managed_instance_servers(managed_instance_id, opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#list_managed_instance_servers.' if logger

  raise "Missing the required parameter 'managed_instance_id' when calling list_managed_instance_servers." if managed_instance_id.nil?

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

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

  path = '/managedInstances/{managedInstanceId}/servers'.sub('{managedInstanceId}', managed_instance_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:name] = opts[:name] if opts[:name]
  query_params[: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]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

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

#list_managed_instances(opts = {}) ⇒ Response

Note:

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

Lists managed instances that match the specified compartment or managed instance OCID. Filter the list against a variety of criteria including but not limited to its name, status and compartment.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :compartment_id (String) —

    The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment.

  • :display_name (String) —

    The display name.

  • :id (String) —

    The OCID of the instance.

  • :plugin_status (String) —

    The plugin status of the managed instance.

    Allowed values are: ACTIVE, INACTIVE

  • :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.

  • :limit (Integer) —

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

  • :page (String) —

    The page token that represents the page at which to start retrieving results. The token is usually retrieved from a previous List call.

  • :sort_order (String) —

    The sort order is either 'ASC' or 'DESC'. (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field by which to sort the resource. 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) Allowed values are: timeCreated, displayName

Returns:



1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 1366

def list_managed_instances(opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#list_managed_instances.' if logger


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

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

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

  path = '/managedInstances'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:pluginStatus] = opts[:plugin_status] if opts[:plugin_status]
  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]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

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

#list_required_policies(opts = {}) ⇒ Response

Note:

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

Gets all the required policies for the WebLogic Management Service.

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:



1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 1440

def list_required_policies(opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#list_required_policies.' if logger


  path = '/requiredPolicies'
  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: 'WeblogicManagementServiceClient#list_required_policies') 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::Wlms::Models::RequiredPolicyCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_wls_domain_credentials(wls_domain_id, opts = {}) ⇒ Response

Note:

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

Gets domain credentials of a specific domain.

Parameters:

  • wls_domain_id (String) —

    The OCID of the WebLogic domain.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

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

Returns:



1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 1499

def list_wls_domain_credentials(wls_domain_id, opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#list_wls_domain_credentials.' if logger

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

  path = '/wlsDomains/{wlsDomainId}/credentials'.sub('{wlsDomainId}', wls_domain_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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'WeblogicManagementServiceClient#list_wls_domain_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::Wlms::Models::WlsDomainCredentialCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_wls_domain_scan_results(wls_domain_id, opts = {}) ⇒ Response

Note:

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

Get all scan results for a server in a specific WebLogic domain.

Parameters:

  • wls_domain_id (String) —

    The OCID of the WebLogic domain.

  • 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

  • :server_name (String) —

    The name of the server.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :limit (Integer) —

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

  • :page (String) —

    The page token that represents the page at which to start retrieving results. The token is usually retrieved from a previous List call.

  • :sort_order (String) —

    The sort order is either 'ASC' or 'DESC'. (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field by which to sort the resource. Only one sort order may be provided. Default order for timeOfServerCheck is descending. Default order for serverName is ascending. If no value is specified, timeOfServerCheck is default. (default to timeOfServerCheck) Allowed values are: timeOfServerCheck, serverName

Returns:



1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 1567

def list_wls_domain_scan_results(wls_domain_id, opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#list_wls_domain_scan_results.' if logger

  raise "Missing the required parameter 'wls_domain_id' when calling list_wls_domain_scan_results." if wls_domain_id.nil?

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

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

  path = '/wlsDomains/{wlsDomainId}/scanResults'.sub('{wlsDomainId}', wls_domain_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:serverName] = opts[:server_name] if opts[:server_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: 'WeblogicManagementServiceClient#list_wls_domain_scan_results') 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::Wlms::Models::ScanResultCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_wls_domain_server_backups(wls_domain_id, server_id, opts = {}) ⇒ Response

Note:

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

Gets a list of backups for the server of a specific WebLogic Domain.

Parameters:

  • wls_domain_id (String) —

    The OCID of the WebLogic domain.

  • server_id (String) —

    The unique identifier of a server.

    Note: Not an OCID.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :limit (Integer) —

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

  • :page (String) —

    The page token that represents the page at which to start retrieving results. The token is usually retrieved from a previous List call.

  • :sort_order (String) —

    The sort order is either 'ASC' or 'DESC'. (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field by which to sort the resource. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified, timeCreated is default. (default to timeCreated) Allowed values are: timeCreated

Returns:



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

def list_wls_domain_server_backups(wls_domain_id, server_id, opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#list_wls_domain_server_backups.' if logger

  raise "Missing the required parameter 'wls_domain_id' when calling list_wls_domain_server_backups." if wls_domain_id.nil?
  raise "Missing the required parameter 'server_id' when calling list_wls_domain_server_backups." if server_id.nil?

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

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

  path = '/wlsDomains/{wlsDomainId}/servers/{serverId}/backups'.sub('{wlsDomainId}', wls_domain_id.to_s).sub('{serverId}', server_id.to_s)
  operation_signing_strategy = :standard

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

  # 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: 'WeblogicManagementServiceClient#list_wls_domain_server_backups') 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::Wlms::Models::BackupCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_wls_domain_server_installed_patches(wls_domain_id, server_id, opts = {}) ⇒ Response

Note:

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

Gets a list of installed patches on a server for a domain.

Parameters:

  • wls_domain_id (String) —

    The OCID of the WebLogic domain.

  • server_id (String) —

    The unique identifier of a server.

    Note: Not an OCID.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :limit (Integer) —

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

  • :page (String) —

    The page token that represents the page at which to start retrieving results. The token is usually retrieved from a previous List call.

  • :sort_order (String) —

    The sort order is either 'ASC' or 'DESC'. (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field by which to sort the resource. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified, displayName is default. (default to displayName) Allowed values are: displayName

Returns:



1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 1730

def list_wls_domain_server_installed_patches(wls_domain_id, server_id, opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#list_wls_domain_server_installed_patches.' if logger

  raise "Missing the required parameter 'wls_domain_id' when calling list_wls_domain_server_installed_patches." if wls_domain_id.nil?
  raise "Missing the required parameter 'server_id' when calling list_wls_domain_server_installed_patches." if server_id.nil?

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

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

  path = '/wlsDomains/{wlsDomainId}/servers/{serverId}/installedPatches'.sub('{wlsDomainId}', wls_domain_id.to_s).sub('{serverId}', server_id.to_s)
  operation_signing_strategy = :standard

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

  # 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: 'WeblogicManagementServiceClient#list_wls_domain_server_installed_patches') 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::Wlms::Models::InstalledPatchCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_wls_domain_servers(wls_domain_id, opts = {}) ⇒ Response

Note:

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

Gets list of servers in a specific WebLogic domain.

Parameters:

  • wls_domain_id (String) —

    The OCID of the WebLogic domain.

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

    the optional parameters

Options Hash (opts):

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

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

  • :name (String) —

    The name of the resource.

  • :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.

  • :limit (Integer) —

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

  • :page (String) —

    The page token that represents the page at which to start retrieving results. The token is usually retrieved from a previous List call.

  • :sort_order (String) —

    The sort order is either 'ASC' or 'DESC'. (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field by which to sort the resource. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending. If no value is specified, timeCreated is default. (default to timeCreated) Allowed values are: timeCreated, name

Returns:



1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 1816

def list_wls_domain_servers(wls_domain_id, opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#list_wls_domain_servers.' if logger

  raise "Missing the required parameter 'wls_domain_id' when calling list_wls_domain_servers." if wls_domain_id.nil?

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

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

  path = '/wlsDomains/{wlsDomainId}/servers'.sub('{wlsDomainId}', wls_domain_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:name] = opts[:name] if opts[:name]
  query_params[: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]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

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

#list_wls_domains(opts = {}) ⇒ Response

Note:

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

Gets all WebLogic domains in a given compartment.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :compartment_id (String) —

    The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment.

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

  • :display_name (String) —

    The display name.

  • :id (String) —

    The OCID of the WebLogic domain.

  • :weblogic_version (String) —

    A filter to return WebLogic domains based on the WebLogic version.

    Allowed values are: v12.2.1.4, v14.1.1.0, v14.1.2.0

  • :middleware_type (String) —

    A filter to return WebLogic domains based on the type of middleware of the WebLogic domain.

    Allowed values are: FMW, WLS

  • :patch_readiness_status (String) —

    A filter to return domains based on the patch readiness status.

  • :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.

  • :limit (Integer) —

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

  • :page (String) —

    The page token that represents the page at which to start retrieving results. The token is usually retrieved from a previous List call.

  • :sort_order (String) —

    The sort order is either 'ASC' or 'DESC'. (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field by which to sort the resource. 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) Allowed values are: timeCreated, displayName

Returns:



1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 1917

def list_wls_domains(opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#list_wls_domains.' if logger


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

  if opts[:weblogic_version] && !%w[v12.2.1.4 v14.1.1.0 v14.1.2.0].include?(opts[:weblogic_version])
    raise 'Invalid value for "weblogic_version", must be one of v12.2.1.4, v14.1.1.0, v14.1.2.0.'
  end

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

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

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

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

  path = '/wlsDomains'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:weblogicVersion] = opts[:weblogic_version] if opts[:weblogic_version]
  query_params[:middlewareType] = opts[:middleware_type] if opts[:middleware_type]
  query_params[:patchReadinessStatus] = opts[:patch_readiness_status] if opts[:patch_readiness_status]
  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]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'WeblogicManagementServiceClient#list_wls_domains') 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::Wlms::Models::WlsDomainCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_wls_domains_sharing_middlewares(wls_domain_id, opts = {}) ⇒ Response

Note:

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

Gets a list of WebLogic domains that share middleware with a specific domain.

Parameters:

  • wls_domain_id (String) —

    The OCID of the WebLogic domain.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :limit (Integer) —

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

  • :page (String) —

    The page token that represents the page at which to start retrieving results. The token is usually retrieved from a previous List call.

  • :sort_order (String) —

    The sort order is either 'ASC' or 'DESC'. (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field by which to sort the resource. 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) Allowed values are: timeCreated, displayName

Returns:



2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 2017

def list_wls_domains_sharing_middlewares(wls_domain_id, opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#list_wls_domains_sharing_middlewares.' if logger

  raise "Missing the required parameter 'wls_domain_id' when calling list_wls_domains_sharing_middlewares." if wls_domain_id.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  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 'wls_domain_id' must not be blank" if OCI::Internal::Util.blank_string?(wls_domain_id)

  path = '/wlsDomains/{wlsDomainId}/wlsDomainsSharingMiddleware'.sub('{wlsDomainId}', wls_domain_id.to_s)
  operation_signing_strategy = :standard

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

  # 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: 'WeblogicManagementServiceClient#list_wls_domains_sharing_middlewares') 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::Wlms::Models::WlsDomainCollection'
    )
  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.

Lists the errors for a work request.

Allowed values are: timestamp

Parameters:

  • work_request_id (String) —

    The OCID of the asynchronous work request.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :page (String) —

    The page token that represents the page at which to start retrieving results. The token is usually retrieved from a previous List call.

  • :limit (Integer) —

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

  • :sort_by (String) —

    The field to sort by. Default order for timestamp is descending. (default to timestamp)

  • :sort_order (String) —

    The sort order is either 'ASC' or 'DESC'. (default to ASC) Allowed values are: ASC, DESC

Returns:



2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 2091

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

  raise "Missing the required parameter 'work_request_id' when calling list_work_request_errors." if work_request_id.nil?

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

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

  path = '/workRequests/{workRequestId}/errors'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

Lists the logs for a work request.

Allowed values are: timestamp

Parameters:

  • work_request_id (String) —

    The OCID of the asynchronous work request.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :page (String) —

    The page token that represents the page at which to start retrieving results. The token is usually retrieved from a previous List call.

  • :limit (Integer) —

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

  • :sort_by (String) —

    The field to sort by. Default order for timestamp is descending. (default to timestamp)

  • :sort_order (String) —

    The sort order is either 'ASC' or 'DESC'. (default to ASC) Allowed values are: ASC, DESC

Returns:



2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 2165

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

  raise "Missing the required parameter 'work_request_id' when calling list_work_request_logs." if work_request_id.nil?

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

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

  path = '/workRequests/{workRequestId}/logs'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#list_work_requests(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

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :compartment_id (String) —

    The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment.

  • :work_request_id (String) —

    The OCID of the asynchronous work request.

  • :status (String) —

    A filter to return only the resources that match the given lifecycle state.

  • :resource_id (String) —

    The OCID of the resource affected by the work request.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :page (String) —

    The page token that represents the page at which to start retrieving results. The token is usually retrieved from a previous List call.

  • :limit (Integer) —

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

  • :sort_order (String) —

    The sort order is either 'ASC' or 'DESC'. (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. Default order for timeAccepted is descending. (default to timeAccepted)

Returns:



2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 2244

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


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

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

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

  path = '/workRequests'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:workRequestId] = opts[:work_request_id] if opts[:work_request_id]
  query_params[:status] = opts[:status] if opts[:status]
  query_params[:resourceId] = opts[:resource_id] if opts[:resource_id]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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: 'WeblogicManagementServiceClient#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::Wlms::Models::WorkRequestSummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



96
97
98
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 96

def logger
  @api_client.config.logger
end

#restart_wls_domain(wls_domain_id, restart_wls_domain_details, opts = {}) ⇒ Response

Note:

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

Restarts all the servers in the WebLogic domains. Servers that are already stopped are ignored.

Parameters:

  • wls_domain_id (String) —

    The OCID of the WebLogic domain.

  • restart_wls_domain_details (OCI::Wlms::Models::RestartWlsDomainDetails) —

    Information for the operation to restart the WebLogic domain.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 2330

def restart_wls_domain(wls_domain_id, restart_wls_domain_details, opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#restart_wls_domain.' if logger

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

  path = '/wlsDomains/{wlsDomainId}/actions/restart'.sub('{wlsDomainId}', wls_domain_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(restart_wls_domain_details)

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

#restore_wls_domain(wls_domain_id, restore_wls_domain_details, opts = {}) ⇒ Response

Note:

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

Restore a domain from backup. If the backup contains a MIDDLEWARE asset, then the middleware of the domain, including patches, will be restored.

Parameters:

  • wls_domain_id (String) —

    The OCID of the WebLogic domain.

  • restore_wls_domain_details (OCI::Wlms::Models::RestoreWlsDomainDetails) —

    Information for the operation to restore WebLogic domain from the backup.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 2401

def restore_wls_domain(wls_domain_id, restore_wls_domain_details, opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#restore_wls_domain.' if logger

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

  path = '/wlsDomains/{wlsDomainId}/actions/restore'.sub('{wlsDomainId}', wls_domain_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(restore_wls_domain_details)

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

#scan_managed_instance(managed_instance_id, opts = {}) ⇒ Response

Note:

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

Scans a managed instance for WebLogic domains.

Parameters:

  • managed_instance_id (String) —

    The OCID of the instance.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

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

  • :if_match (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 2471

def scan_managed_instance(managed_instance_id, opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#scan_managed_instance.' if logger

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

  path = '/managedInstances/{managedInstanceId}/actions/scan'.sub('{managedInstanceId}', managed_instance_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#scan_wls_domain(wls_domain_id, opts = {}) ⇒ Response

Note:

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

Runs a series of checks in the WebLogic domain.

Parameters:

  • wls_domain_id (String) —

    The OCID of the WebLogic domain.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 2540

def scan_wls_domain(wls_domain_id, opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#scan_wls_domain.' if logger

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

  path = '/wlsDomains/{wlsDomainId}/actions/scan'.sub('{wlsDomainId}', wls_domain_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#set_restart_order(wls_domain_id, set_restart_order_details, opts = {}) ⇒ Response

Note:

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

Sets restart order of servers in specific WebLogic domain.

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

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

Returns:



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
2645
2646
2647
2648
2649
2650
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 2610

def set_restart_order(wls_domain_id, set_restart_order_details, opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#set_restart_order.' if logger

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

  path = '/wlsDomains/{wlsDomainId}/actions/setRestartOrder'.sub('{wlsDomainId}', wls_domain_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(set_restart_order_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'WeblogicManagementServiceClient#set_restart_order') 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::Wlms::Models::ServerCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#start_wls_domain(wls_domain_id, opts = {}) ⇒ Response

Note:

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

Starts all the servers in the WebLogic domain. Servers that are already started are ignored.

Parameters:

  • wls_domain_id (String) —

    The OCID of the WebLogic domain.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
2713
2714
2715
2716
2717
2718
2719
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 2681

def start_wls_domain(wls_domain_id, opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#start_wls_domain.' if logger

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

  path = '/wlsDomains/{wlsDomainId}/actions/start'.sub('{wlsDomainId}', wls_domain_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#stop_wls_domain(wls_domain_id, stop_wls_domain_details, opts = {}) ⇒ Response

Note:

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

Stops all the servers in the WebLogic domain. Servers that are already stopped are ignored.

Parameters:

  • wls_domain_id (String) —

    The OCID of the WebLogic domain.

  • stop_wls_domain_details (OCI::Wlms::Models::StopWlsDomainDetails) —

    Information for the stop WebLogic domain operation

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
2785
2786
2787
2788
2789
2790
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 2751

def stop_wls_domain(wls_domain_id, stop_wls_domain_details, opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#stop_wls_domain.' if logger

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

  path = '/wlsDomains/{wlsDomainId}/actions/stop'.sub('{wlsDomainId}', wls_domain_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(stop_wls_domain_details)

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

#summarize_resource_inventory(compartment_id, opts = {}) ⇒ Response

Note:

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

Gets the data to be shown in the Overview page of the service in a given compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



2811
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
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 2811

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

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

  path = '/resourceInventory'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'WeblogicManagementServiceClient#summarize_resource_inventory') 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::Wlms::Models::ResourceInventory'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_managed_instance(managed_instance_id, update_managed_instance_details, opts = {}) ⇒ Response

Note:

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

Updates the specified managed instance information, such as discovery interval and domain search path.

Parameters:

  • managed_instance_id (String) —

    The OCID of the instance.

  • update_managed_instance_details (OCI::Wlms::Models::UpdateManagedInstanceDetails) —

    Provides the informaton used to update a managed instance.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

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

  • :if_match (String) —

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

Returns:



2879
2880
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
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 2879

def update_managed_instance(managed_instance_id, update_managed_instance_details, opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#update_managed_instance.' if logger

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

  path = '/managedInstances/{managedInstanceId}'.sub('{managedInstanceId}', managed_instance_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(update_managed_instance_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'WeblogicManagementServiceClient#update_managed_instance') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Wlms::Models::ManagedInstance'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_wls_domain(wls_domain_id, update_wls_domain_details, opts = {}) ⇒ Response

Note:

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

Updates a specific WebLogic domain.

Parameters:

  • wls_domain_id (String) —

    The OCID of the WebLogic domain.

  • update_wls_domain_details (OCI::Wlms::Models::UpdateWlsDomainDetails) —

    The new details required to update the WebLogic domain.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



2945
2946
2947
2948
2949
2950
2951
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
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 2945

def update_wls_domain(wls_domain_id, update_wls_domain_details, opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#update_wls_domain.' if logger

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

  path = '/wlsDomains/{wlsDomainId}'.sub('{wlsDomainId}', wls_domain_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(update_wls_domain_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'WeblogicManagementServiceClient#update_wls_domain') 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::Wlms::Models::WlsDomain'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_wls_domain_credential(wls_domain_id, credential_type, update_wls_domain_credential_details, opts = {}) ⇒ Response

Note:

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

Updates WebLogic domain credentials of specific WebLogic domain.

Parameters:

  • wls_domain_id (String) —

    The OCID of the WebLogic domain.

  • credential_type (String) —

    The type of the credentials. Allowed values are: weblogicAdminUser, nodemanagerUser

  • update_wls_domain_credential_details (OCI::Wlms::Models::UpdateWlsDomainCredentialDetails) —

    The WebLogic domain 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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
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
 
# File 'lib/oci/wlms/weblogic_management_service_client.rb', line 3011

def update_wls_domain_credential(wls_domain_id, credential_type, update_wls_domain_credential_details, opts = {})
  logger.debug 'Calling operation WeblogicManagementServiceClient#update_wls_domain_credential.' if logger

  raise "Missing the required parameter 'wls_domain_id' when calling update_wls_domain_credential." if wls_domain_id.nil?
  raise "Missing the required parameter 'credential_type' when calling update_wls_domain_credential." if credential_type.nil?
  unless %w[weblogicAdminUser nodemanagerUser].include?(credential_type)
    raise "Invalid value for 'credential_type', must be one of weblogicAdminUser, nodemanagerUser."
  end
  raise "Missing the required parameter 'update_wls_domain_credential_details' when calling update_wls_domain_credential." if update_wls_domain_credential_details.nil?
  raise "Parameter value for 'wls_domain_id' must not be blank" if OCI::Internal::Util.blank_string?(wls_domain_id)
  raise "Parameter value for 'credential_type' must not be blank" if OCI::Internal::Util.blank_string?(credential_type)

  path = '/wlsDomains/{wlsDomainId}/credentials/{credentialType}'.sub('{wlsDomainId}', wls_domain_id.to_s).sub('{credentialType}', credential_type.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(update_wls_domain_credential_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'WeblogicManagementServiceClient#update_wls_domain_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::Wlms::Models::WlsDomainCredential'
    )
  end
  # rubocop:enable Metrics/BlockLength
end