Class: OCI::Jms::JavaManagementServiceClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/jms/java_management_service_client.rb

Overview

The APIs for the Fleet Management feature of Java Management Service to monitor and manage the usage of Java in your enterprise. Use these APIs to manage fleets, configure managed instances to report to fleets, and gain insights into the Java workloads running on these instances by carrying out basic and advanced features.

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

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

This client is not thread-safe

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

Parameters:

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

    A Config object.

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

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

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

    The fully qualified endpoint URL

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

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

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

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

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

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



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

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

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

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

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

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



15
16
17
 
# File 'lib/oci/jms/java_management_service_client.rb', line 15

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/jms/java_management_service_client.rb', line 19

def endpoint
  @endpoint
end

#region ⇒ String

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

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/jms/java_management_service_client.rb', line 29

def region
  @region
end

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

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

Returns:



25
26
27
 
# File 'lib/oci/jms/java_management_service_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#add_fleet_installation_sites(fleet_id, add_fleet_installation_sites_details, opts = {}) ⇒ Response

Note:

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

Add Java installation sites in a Fleet.

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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_retry_token (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



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

def add_fleet_installation_sites(fleet_id, add_fleet_installation_sites_details, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#add_fleet_installation_sites.' if logger

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

  path = '/fleets/{fleetId}/actions/addInstallationSites'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(add_fleet_installation_sites_details)

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

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

Note:

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

Deletes the work request specified by an identifier.

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.

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



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/oci/jms/java_management_service_client.rb', line 187

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

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

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

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

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

  post_body = nil

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

#change_fleet_compartment(fleet_id, change_fleet_compartment_details, opts = {}) ⇒ Response

Note:

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

Move a specified Fleet into the compartment identified in the POST form. When provided, If-Match is checked against ETag values of the resource.

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/oci/jms/java_management_service_client.rb', line 255

def change_fleet_compartment(fleet_id, change_fleet_compartment_details, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#change_fleet_compartment.' if logger

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

  path = '/fleets/{fleetId}/actions/changeCompartment'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(change_fleet_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'JavaManagementServiceClient#change_fleet_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_blocklist(fleet_id, create_blocklist_details, opts = {}) ⇒ Response

Note:

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

Add a new record to the fleet blocklist.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



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

def create_blocklist(fleet_id, create_blocklist_details, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#create_blocklist.' if logger

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

  path = '/fleets/{fleetId}/blocklists'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(create_blocklist_details)

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

#create_drs_file(fleet_id, create_drs_file_details, opts = {}) ⇒ Response

Note:

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

Request to perform validation of the DRS file and create the file to the Object Storage.

Parameters:

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

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

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/oci/jms/java_management_service_client.rb', line 391

def create_drs_file(fleet_id, create_drs_file_details, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#create_drs_file.' if logger

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

  path = '/fleets/{fleetId}/drsFiles'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(create_drs_file_details)

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

#create_fleet(create_fleet_details, opts = {}) ⇒ Response

Note:

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

Create a new Fleet using the information provided.

inventoryLog is now a required parameter for CreateFleet API. Update existing applications using this API before July 15, 2022 to ensure the applications continue to work. See the Service Change Notice for more details. Migrate existing fleets using the UpdateFleet API to set the inventoryLog parameter.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/oci/jms/java_management_service_client.rb', line 461

def create_fleet(create_fleet_details, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#create_fleet.' if logger

  raise "Missing the required parameter 'create_fleet_details' when calling create_fleet." if create_fleet_details.nil?

  path = '/fleets'
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(create_fleet_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'JavaManagementServiceClient#create_fleet') 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_jms_plugin(create_jms_plugin_details, opts = {}) ⇒ Response

Note:

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

Registers an agent's JmsPlugin, optionally attaching to an existing fleet of the tenancy. JmsPlugins registered fleet-less are created with lifecycle state INACTIVE. For the operation to be authorized, the agent must exist, and the authorized user requires JMS_PLUGIN_CREATE permission for the agent's compartment.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



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

def create_jms_plugin(create_jms_plugin_details, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#create_jms_plugin.' if logger

  raise "Missing the required parameter 'create_jms_plugin_details' when calling create_jms_plugin." if create_jms_plugin_details.nil?

  path = '/jmsPlugins'
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(create_jms_plugin_details)

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

#delete_blocklist(fleet_id, blocklist_key, opts = {}) ⇒ Response

Note:

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

Deletes the blocklist record specified by an identifier.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

  • blocklist_key (String) —

    The unique identifier of the blocklist record.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



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

def delete_blocklist(fleet_id, blocklist_key, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#delete_blocklist.' if logger

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

  path = '/fleets/{fleetId}/blocklists/{blocklistKey}'.sub('{fleetId}', fleet_id.to_s).sub('{blocklistKey}', blocklist_key.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#delete_crypto_analysis_result(fleet_id, crypto_analysis_result_id, opts = {}) ⇒ Response

Note:

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

Deletes the metadata for the result of a Crypto event analysis. The actual report shall remain in the object storage.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

  • crypto_analysis_result_id (String) —

    The OCID of the analysis result.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
 
# File 'lib/oci/jms/java_management_service_client.rb', line 649

def delete_crypto_analysis_result(fleet_id, crypto_analysis_result_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#delete_crypto_analysis_result.' if logger

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

  path = '/fleets/{fleetId}/cryptoAnalysisResults/{cryptoAnalysisResultId}'.sub('{fleetId}', fleet_id.to_s).sub('{cryptoAnalysisResultId}', crypto_analysis_result_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#delete_drs_file(fleet_id, drs_file_key, opts = {}) ⇒ Response

Note:

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

Request to delete the DRS file from the Object Storage.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

  • drs_file_key (String) —

    The unique identifier of the DRS File in Object Storage.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
 
# File 'lib/oci/jms/java_management_service_client.rb', line 713

def delete_drs_file(fleet_id, drs_file_key, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#delete_drs_file.' if logger

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

  path = '/fleets/{fleetId}/drsFiles/{drsFileKey}'.sub('{fleetId}', fleet_id.to_s).sub('{drsFileKey}', drs_file_key.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#delete_fleet(fleet_id, opts = {}) ⇒ Response

Note:

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

Deletes the Fleet specified by an identifier.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
 
# File 'lib/oci/jms/java_management_service_client.rb', line 775

def delete_fleet(fleet_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#delete_fleet.' if logger

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

  path = '/fleets/{fleetId}'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#delete_java_migration_analysis_result(fleet_id, java_migration_analysis_result_id, opts = {}) ⇒ Response

Note:

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

Delete the Java migration analysis result. The actual report will remain in the Object Storage bucket.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

  • java_migration_analysis_result_id (String) —

    The OCID of the analysis result.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
 
# File 'lib/oci/jms/java_management_service_client.rb', line 836

def delete_java_migration_analysis_result(fleet_id, java_migration_analysis_result_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#delete_java_migration_analysis_result.' if logger

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

  path = '/fleets/{fleetId}/javaMigrationAnalysisResults/{javaMigrationAnalysisResultId}'.sub('{fleetId}', fleet_id.to_s).sub('{javaMigrationAnalysisResultId}', java_migration_analysis_result_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#delete_jms_plugin(jms_plugin_id, opts = {}) ⇒ Response

Note:

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

Deletes a JmsPlugin. The JmsPlugin may be visible for some time with state DELETED. Deleted plugins will not be able to communicate with the JMS service.

Parameters:

  • jms_plugin_id (String) —

    The OCID of the JmsPlugin.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
 
# File 'lib/oci/jms/java_management_service_client.rb', line 900

def delete_jms_plugin(jms_plugin_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#delete_jms_plugin.' if logger

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

  path = '/jmsPlugins/{jmsPluginId}'.sub('{jmsPluginId}', jms_plugin_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#delete_performance_tuning_analysis_result(fleet_id, performance_tuning_analysis_result_id, opts = {}) ⇒ Response

Note:

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

Deletes only the metadata of the Performance Tuning Analysis result, but the file remains in the object storage.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

  • performance_tuning_analysis_result_id (String) —

    The OCID of the performance tuning analysis result.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
 
# File 'lib/oci/jms/java_management_service_client.rb', line 961

def delete_performance_tuning_analysis_result(fleet_id, performance_tuning_analysis_result_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#delete_performance_tuning_analysis_result.' if logger

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

  path = '/fleets/{fleetId}/performanceTuningAnalysisResults/{performanceTuningAnalysisResultId}'.sub('{fleetId}', fleet_id.to_s).sub('{performanceTuningAnalysisResultId}', performance_tuning_analysis_result_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#disable_drs(fleet_id, disable_drs_details, opts = {}) ⇒ Response

Note:

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

Request to disable the DRS in the selected target in the Fleet.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

  • disable_drs_details (OCI::Jms::Models::DisableDrsDetails) —

    Detail information to disable DRS

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

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

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



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
 
# File 'lib/oci/jms/java_management_service_client.rb', line 1031

def disable_drs(fleet_id, disable_drs_details, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#disable_drs.' if logger

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

  path = '/fleets/{fleetId}/actions/disableDrs'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(disable_drs_details)

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

#enable_drs(fleet_id, enable_drs_details, opts = {}) ⇒ Response

Note:

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

Request to enable the DRS in the selected target in the Fleet.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

  • enable_drs_details (OCI::Jms::Models::EnableDrsDetails) —

    Detail information to enable DRS

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

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

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



1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
 
# File 'lib/oci/jms/java_management_service_client.rb', line 1102

def enable_drs(fleet_id, enable_drs_details, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#enable_drs.' if logger

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

  path = '/fleets/{fleetId}/actions/enableDrs'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(enable_drs_details)

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

#generate_agent_deploy_script(fleet_id, generate_agent_deploy_script_details, opts = {}, &block) ⇒ Response

Note:

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

Generates Agent Deploy Script for Fleet using the information provided.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

  • generate_agent_deploy_script_details (OCI::Jms::Models::GenerateAgentDeployScriptDetails) —

    Attributes to generate the agent deploy script for a Fleet.

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

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :response_target (String, IO) —

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

Returns:

  • (Response) —

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



1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
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
1238
1239
1240
1241
1242
1243
1244
 
# File 'lib/oci/jms/java_management_service_client.rb', line 1163

def generate_agent_deploy_script(fleet_id, generate_agent_deploy_script_details, opts = {}, &block)
  logger.debug 'Calling operation JavaManagementServiceClient#generate_agent_deploy_script.' if logger

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

  path = '/fleets/{fleetId}/actions/generateAgentDeployScript'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(generate_agent_deploy_script_details)

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

#generate_agent_installer_configuration(generate_agent_installer_configuration_details, opts = {}, &block) ⇒ Response

Note:

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

Generates the agent installer configuration using the information provided.

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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.

  • :response_target (String, IO) —

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

Returns:

  • (Response) —

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



1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
 
# File 'lib/oci/jms/java_management_service_client.rb', line 1265

def generate_agent_installer_configuration(generate_agent_installer_configuration_details, opts = {}, &block)
  logger.debug 'Calling operation JavaManagementServiceClient#generate_agent_installer_configuration.' if logger

  raise "Missing the required parameter 'generate_agent_installer_configuration_details' when calling generate_agent_installer_configuration." if generate_agent_installer_configuration_details.nil?

  path = '/agentInstallers/actions/generateAgentInstallerConfiguration'
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(generate_agent_installer_configuration_details)

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

#generate_load_pipeline_script(fleet_id, generate_load_pipeline_script_details, opts = {}, &block) ⇒ Response

Note:

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

Generates Load Pipeline Script

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

  • generate_load_pipeline_script_details (OCI::Jms::Models::GenerateLoadPipelineScriptDetails) —

    Attributes to generate the load pipeline script.

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

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :response_target (String, IO) —

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

Returns:

  • (Response) —

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



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
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
 
# File 'lib/oci/jms/java_management_service_client.rb', line 1366

def generate_load_pipeline_script(fleet_id, generate_load_pipeline_script_details, opts = {}, &block)
  logger.debug 'Calling operation JavaManagementServiceClient#generate_load_pipeline_script.' if logger

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

  path = '/fleets/{fleetId}/actions/generateLoadPipelineScript'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(generate_load_pipeline_script_details)

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

#get_crypto_analysis_result(fleet_id, crypto_analysis_result_id, opts = {}) ⇒ Response

Note:

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

Retrieve the metadata for the result of a Crypto event analysis.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

  • crypto_analysis_result_id (String) —

    The OCID of the analysis result.

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



1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
 
# File 'lib/oci/jms/java_management_service_client.rb', line 1466

def get_crypto_analysis_result(fleet_id, crypto_analysis_result_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#get_crypto_analysis_result.' if logger

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

  path = '/fleets/{fleetId}/cryptoAnalysisResults/{cryptoAnalysisResultId}'.sub('{fleetId}', fleet_id.to_s).sub('{cryptoAnalysisResultId}', crypto_analysis_result_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: 'JavaManagementServiceClient#get_crypto_analysis_result') 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::Jms::Models::CryptoAnalysisResult'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_drs_file(fleet_id, drs_file_key, opts = {}) ⇒ Response

Note:

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

Get the detail about the created DRS file in the Fleet.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

  • drs_file_key (String) —

    The unique identifier of the DRS File in Object Storage.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :page (String) —

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

Returns:



1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
 
# File 'lib/oci/jms/java_management_service_client.rb', line 1524

def get_drs_file(fleet_id, drs_file_key, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#get_drs_file.' if logger

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

  path = '/fleets/{fleetId}/drsFiles/{drsFileKey}'.sub('{fleetId}', fleet_id.to_s).sub('{drsFileKey}', drs_file_key.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#get_export_setting(fleet_id, opts = {}) ⇒ Response

Note:

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

Returns export setting for the specified fleet.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

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



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

def get_export_setting(fleet_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#get_export_setting.' if logger

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

  path = '/fleets/{fleetId}/exportSetting'.sub('{fleetId}', fleet_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: 'JavaManagementServiceClient#get_export_setting') 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::Jms::Models::ExportSetting'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_export_status(fleet_id, opts = {}) ⇒ Response

Note:

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

Returns last export status for the specified fleet.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

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



1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
 
# File 'lib/oci/jms/java_management_service_client.rb', line 1635

def get_export_status(fleet_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#get_export_status.' if logger

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

  path = '/fleets/{fleetId}/exportStatus'.sub('{fleetId}', fleet_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: 'JavaManagementServiceClient#get_export_status') 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::Jms::Models::ExportStatus'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_fleet(fleet_id, opts = {}) ⇒ Response

Note:

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

Retrieve a Fleet with the specified identifier.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

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



1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
 
# File 'lib/oci/jms/java_management_service_client.rb', line 1689

def get_fleet(fleet_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#get_fleet.' if logger

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

  path = '/fleets/{fleetId}'.sub('{fleetId}', fleet_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: 'JavaManagementServiceClient#get_fleet') 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::Jms::Models::Fleet'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_fleet_advanced_feature_configuration(fleet_id, opts = {}) ⇒ Response

Note:

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

Returns Fleet level advanced feature configuration.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

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



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
1781
1782
1783
1784
1785
1786
1787
 
# File 'lib/oci/jms/java_management_service_client.rb', line 1750

def get_fleet_advanced_feature_configuration(fleet_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#get_fleet_advanced_feature_configuration.' if logger

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

  path = '/fleets/{fleetId}/advancedFeatureConfiguration'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#get_fleet_agent_configuration(fleet_id, opts = {}) ⇒ Response

Note:

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

Retrieve a Fleet Agent Configuration for the specified Fleet.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

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



1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
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
 
# File 'lib/oci/jms/java_management_service_client.rb', line 1805

def get_fleet_agent_configuration(fleet_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#get_fleet_agent_configuration.' if logger

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

  path = '/fleets/{fleetId}/agentConfiguration'.sub('{fleetId}', fleet_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: 'JavaManagementServiceClient#get_fleet_agent_configuration') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Jms::Models::FleetAgentConfiguration'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_java_family(family_version, opts = {}) ⇒ Response

Note:

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

Returns metadata associated with a specific Java release family.

Parameters:

  • family_version (String) —

    Unique Java family version identifier.

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



1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
 
# File 'lib/oci/jms/java_management_service_client.rb', line 1860

def get_java_family(family_version, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#get_java_family.' if logger

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

  path = '/javaFamilies/{familyVersion}'.sub('{familyVersion}', family_version.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: 'JavaManagementServiceClient#get_java_family') 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::Jms::Models::JavaFamily'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_java_migration_analysis_result(fleet_id, java_migration_analysis_result_id, opts = {}) ⇒ Response

Note:

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

Retrieve Java Migration Analysis result.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

  • java_migration_analysis_result_id (String) —

    The OCID of the analysis result.

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



1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
 
# File 'lib/oci/jms/java_management_service_client.rb', line 1915

def get_java_migration_analysis_result(fleet_id, java_migration_analysis_result_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#get_java_migration_analysis_result.' if logger

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

  path = '/fleets/{fleetId}/javaMigrationAnalysisResults/{javaMigrationAnalysisResultId}'.sub('{fleetId}', fleet_id.to_s).sub('{javaMigrationAnalysisResultId}', java_migration_analysis_result_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: 'JavaManagementServiceClient#get_java_migration_analysis_result') 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::Jms::Models::JavaMigrationAnalysisResult'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_java_release(release_version, opts = {}) ⇒ Response

Note:

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

Returns detail of a Java release.

Parameters:

  • release_version (String) —

    Unique Java release version identifier

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



1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
 
# File 'lib/oci/jms/java_management_service_client.rb', line 1971

def get_java_release(release_version, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#get_java_release.' if logger

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

  path = '/javaReleases/{releaseVersion}'.sub('{releaseVersion}', release_version.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: 'JavaManagementServiceClient#get_java_release') 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::Jms::Models::JavaRelease'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_jms_plugin(jms_plugin_id, opts = {}) ⇒ Response

Note:

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

Returns the JmsPlugin.

Parameters:

  • jms_plugin_id (String) —

    The OCID of the JmsPlugin.

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



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
 
# File 'lib/oci/jms/java_management_service_client.rb', line 2025

def get_jms_plugin(jms_plugin_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#get_jms_plugin.' if logger

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

  path = '/jmsPlugins/{jmsPluginId}'.sub('{jmsPluginId}', jms_plugin_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: 'JavaManagementServiceClient#get_jms_plugin') 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::Jms::Models::JmsPlugin'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_performance_tuning_analysis_result(fleet_id, performance_tuning_analysis_result_id, opts = {}) ⇒ Response

Note:

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

Retrieve metadata of the Performance Tuning Analysis result.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

  • performance_tuning_analysis_result_id (String) —

    The OCID of the performance tuning analysis result.

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



2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
 
# File 'lib/oci/jms/java_management_service_client.rb', line 2080

def get_performance_tuning_analysis_result(fleet_id, performance_tuning_analysis_result_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#get_performance_tuning_analysis_result.' if logger

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

  path = '/fleets/{fleetId}/performanceTuningAnalysisResults/{performanceTuningAnalysisResultId}'.sub('{fleetId}', fleet_id.to_s).sub('{performanceTuningAnalysisResultId}', performance_tuning_analysis_result_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: 'JavaManagementServiceClient#get_performance_tuning_analysis_result') 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::Jms::Models::PerformanceTuningAnalysisResult'
    )
  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.

Retrieve the details of a work request with the specified ID.

Parameters:

  • work_request_id (String) —

    The OCID of the asynchronous work request.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
 
# File 'lib/oci/jms/java_management_service_client.rb', line 2136

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

#list_agent_installers(opts = {}) ⇒ Response

Note:

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

Returns a list of the agent installer information.

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 in which to list resources.

  • :fleet_id (String) —

    The ID of the Fleet.

  • :platform_architecture (String) —

    The platform architecture for the agent installer.

  • :os_family (String) —

    The OS family for the agent installer.

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

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

  • :sort_by (String) —

    The field to sort the agent installer. Only one sort order can be provided. Default order for agentInstallerId, osFamily, platformArchitecture is ascending. If no value is specified agentInstallerId is default. (default to agentInstallerId)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
 
# File 'lib/oci/jms/java_management_service_client.rb', line 2202

def list_agent_installers(opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#list_agent_installers.' if logger


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

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

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

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

  path = '/agentInstallers'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:fleetId] = opts[:fleet_id] if opts[:fleet_id]
  query_params[:platformArchitecture] = opts[:platform_architecture] if opts[:platform_architecture]
  query_params[:osFamily] = opts[:os_family] if opts[:os_family]
  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: 'JavaManagementServiceClient#list_agent_installers') 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::Jms::Models::AgentInstallerCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_announcements(opts = {}) ⇒ Response

Note:

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

Return a list of AnnouncementSummary items

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

  • :summary_contains (String) —

    Filter the list with summary contains the given value.

  • :time_start (DateTime) —

    The start of the time period during which resources are searched (formatted according to RFC3339).

  • :time_end (DateTime) —

    The end of the time period during which resources are searched (formatted according to RFC3339).

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

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

  • :sort_by (String) —

    The field to sort AnnouncementSummary by. Only one sort order may be provided. If no value is specified timeReleased is default. (default to timeReleased)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
 
# File 'lib/oci/jms/java_management_service_client.rb', line 2287

def list_announcements(opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#list_announcements.' if logger


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

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

  path = '/announcements'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:summaryContains] = opts[:summary_contains] if opts[:summary_contains]
  query_params[:timeStart] = opts[:time_start] if opts[:time_start]
  query_params[:timeEnd] = opts[:time_end] if opts[:time_end]
  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: 'JavaManagementServiceClient#list_announcements') 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::Jms::Models::AnnouncementCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_blocklists(fleet_id, opts = {}) ⇒ Response

Note:

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

Returns a list of blocklist entities contained by a fleet.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

  • 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

  • :operation (String) —

    The operation type.

  • :managed_instance_id (String) —

    The Fleet-unique identifier of the related managed instance.

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

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

  • :sort_by (String) —

    The field used to sort blocklist records. Only one sort order may be provided. Default order for operation is ascending. If no value is specified, operation is default. (default to operation)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
 
# File 'lib/oci/jms/java_management_service_client.rb', line 2364

def list_blocklists(fleet_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#list_blocklists.' if logger

  raise "Missing the required parameter 'fleet_id' when calling list_blocklists." if fleet_id.nil?

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

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

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

  path = '/fleets/{fleetId}/blocklists'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#list_crypto_analysis_results(fleet_id, opts = {}) ⇒ Response

Note:

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

Lists the results of a Crypto event analysis.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

  • 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

  • :aggregation_mode (String) —

    The aggregation mode of the crypto event analysis result. (default to managedInstance)

  • :managed_instance_id (String) —

    The Fleet-unique identifier of the related managed instance.

  • :host_name (String) —

    The host OCID of the managed instance. (default to hostName)

  • :non_compliant_finding_count (Integer) —

    Non Compliant Finding Count of CryptoAnalysis Report.

  • :non_compliant_finding_count_greater_than (Integer) —

    Non Compliant Finding Count of CryptoAnalysis Report.

  • :finding_count (Integer) —

    FindingCount of CryptoAnalysis Report.

  • :finding_count_greater_than (Integer) —

    FindingCount of CryptoAnalysis Report.

  • :time_start (DateTime) —

    The start of the time period during which resources are searched (formatted according to RFC3339).

  • :time_end (DateTime) —

    The end of the time period during which resources are searched (formatted according to RFC3339).

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

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

  • :sort_by (String) —

    The field to sort crypto event analysis results. Only one sort order can be provided. Default order for timeCreated, and jreVersion is descending. Default order for managedInstanceId, jreDistribution, jreVendor and osName is ascending. If no value is specified timeCreated is default. (default to timeCreated)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
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
2510
2511
2512
2513
2514
 
# File 'lib/oci/jms/java_management_service_client.rb', line 2453

def list_crypto_analysis_results(fleet_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#list_crypto_analysis_results.' if logger

  raise "Missing the required parameter 'fleet_id' when calling list_crypto_analysis_results." if fleet_id.nil?

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

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

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

  path = '/fleets/{fleetId}/cryptoAnalysisResults'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:aggregationMode] = opts[:aggregation_mode] if opts[:aggregation_mode]
  query_params[:managedInstanceId] = opts[:managed_instance_id] if opts[:managed_instance_id]
  query_params[:hostName] = opts[:host_name] if opts[:host_name]
  query_params[:nonCompliantFindingCount] = opts[:non_compliant_finding_count] if opts[:non_compliant_finding_count]
  query_params[:nonCompliantFindingCountGreaterThan] = opts[:non_compliant_finding_count_greater_than] if opts[:non_compliant_finding_count_greater_than]
  query_params[:findingCount] = opts[:finding_count] if opts[:finding_count]
  query_params[:findingCountGreaterThan] = opts[:finding_count_greater_than] if opts[:finding_count_greater_than]
  query_params[:timeStart] = opts[:time_start] if opts[:time_start]
  query_params[:timeEnd] = opts[:time_end] if opts[:time_end]
  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: 'JavaManagementServiceClient#list_crypto_analysis_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::Jms::Models::CryptoAnalysisResultCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_drs_files(fleet_id, opts = {}) ⇒ Response

Note:

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

List the details about the created DRS files in the Fleet.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

  • 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 representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.

  • :sort_order (String) —

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

  • :sort_by (String) —

    The field that sorts the DRS details results. Only one sort order can be provided. The default order for drsFileKey is descending. If no value is specified, then drsFileKey is default. (default to drsFileKey)

Returns:



2539
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
2579
2580
2581
2582
2583
2584
2585
2586
2587
 
# File 'lib/oci/jms/java_management_service_client.rb', line 2539

def list_drs_files(fleet_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#list_drs_files.' if logger

  raise "Missing the required parameter 'fleet_id' when calling list_drs_files." if fleet_id.nil?

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

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

  path = '/fleets/{fleetId}/drsFiles'.sub('{fleetId}', fleet_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: 'JavaManagementServiceClient#list_drs_files') 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::Jms::Models::DrsFileCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_fleet_diagnoses(fleet_id, opts = {}) ⇒ Response

Note:

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

List potential diagnoses that would put a fleet into FAILED or NEEDS_ATTENTION lifecycle state.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

  • 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

  • :limit (Integer) —

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

  • :page (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
 
# File 'lib/oci/jms/java_management_service_client.rb', line 2608

def list_fleet_diagnoses(fleet_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#list_fleet_diagnoses.' if logger

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

  path = '/fleets/{fleetId}/diagnoses'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#list_fleet_errors(opts = {}) ⇒ Response

Note:

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

Returns a list of fleet errors that describe all detected errors.

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 in which to list resources.

  • :compartment_id_in_subtree (BOOLEAN) —

    Flag to determine whether the info should be gathered only in the compartment or in the compartment and its subcompartments. (default to false)

  • :fleet_id (String) —

    The ID of the Fleet.

  • :time_first_seen_less_than_or_equal_to (DateTime) —

    If specified, only errors with a first seen time earlier than this parameter will be included in the search (formatted according to RFC3339).

  • :time_first_seen_greater_than_or_equal_to (DateTime) —

    If specified, only errors with a first seen time later than this parameter will be included in the search (formatted according to RFC3339).

  • :time_last_seen_less_than_or_equal_to (DateTime) —

    If specified, only errors with a last seen time earlier than this parameter will be included in the search (formatted according to RFC3339).

  • :time_last_seen_greater_than_or_equal_to (DateTime) —

    If specified, only errors with a last seen time later than this parameter will be included in the search (formatted according to RFC3339).

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_by (String) —

    The field to sort FleetError. Only one sort order may be provided. Default order is descending. If no value is specified timeLastSeen is default. (default to TIME_LAST_SEEN)

  • :sort_order (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
 
# File 'lib/oci/jms/java_management_service_client.rb', line 2679

def list_fleet_errors(opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#list_fleet_errors.' if logger


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

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

  path = '/fleetErrors'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:fleetId] = opts[:fleet_id] if opts[:fleet_id]
  query_params[:timeFirstSeenLessThanOrEqualTo] = opts[:time_first_seen_less_than_or_equal_to] if opts[:time_first_seen_less_than_or_equal_to]
  query_params[:timeFirstSeenGreaterThanOrEqualTo] = opts[:time_first_seen_greater_than_or_equal_to] if opts[:time_first_seen_greater_than_or_equal_to]
  query_params[:timeLastSeenLessThanOrEqualTo] = opts[:time_last_seen_less_than_or_equal_to] if opts[:time_last_seen_less_than_or_equal_to]
  query_params[:timeLastSeenGreaterThanOrEqualTo] = opts[:time_last_seen_greater_than_or_equal_to] if opts[:time_last_seen_greater_than_or_equal_to]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

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

  post_body = nil

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

#list_fleets(opts = {}) ⇒ Response

Note:

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

Returns a list of all the Fleets contained by a compartment. The query parameter compartmentId is required unless the query parameter id is specified.

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 in which to list resources.

  • :id (String) —

    The ID.

  • :lifecycle_state (String) —

    The state of the lifecycle.

  • :display_name (String) —

    The display name.

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

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

  • :sort_by (String) —

    The field to sort Fleets. Only one sort order may be provided. Default order for timeCreated, approximateJreCount, approximateInstallationCount, approximateApplicationCount and approximateManagedInstanceCount is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. (default to timeCreated)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :display_name_contains (String) —

    Filter the list with displayName contains the given value.

Returns:



2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
 
# File 'lib/oci/jms/java_management_service_client.rb', line 2767

def list_fleets(opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#list_fleets.' if logger


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

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

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

  path = '/fleets'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains]

  # Header Params
  header_params = {}
  header_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: 'JavaManagementServiceClient#list_fleets') 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::Jms::Models::FleetCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_installation_sites(fleet_id, opts = {}) ⇒ Response

Note:

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

List Java installation sites in a Fleet filtered by query parameters.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

  • 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

  • :jre_vendor (String) —

    The vendor of the related Java Runtime.

  • :jre_distribution (String) —

    The distribution of the related Java Runtime.

  • :jre_version (String) —

    The version of the related Java Runtime.

  • :installation_path (String) —

    The file system path of the installation.

  • :application_id (String) —

    The Fleet-unique identifier of the related application.

  • :managed_instance_id (String) —

    The Fleet-unique identifier of the related managed instance.

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

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

  • :sort_by (String) —

    The field to sort installation sites. Only one sort order may be provided. Default order for timeLastSeen, and jreVersion, approximateApplicationCount is descending. Default order for managedInstanceId, jreDistribution, jreVendor and osName is ascending. If no value is specified managedInstanceId is default. (default to managedInstanceId)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :os_family (Array<String>) —

    The operating system type. Allowed values are: LINUX, WINDOWS, MACOS, UNKNOWN

  • :jre_security_status (String) —

    The security status of the Java Runtime.

  • :path_contains (String) —

    Filter the list with path contains the given value.

  • :time_start (DateTime) —

    The start of the time period during which resources are searched (formatted according to RFC3339).

  • :time_end (DateTime) —

    The end of the time period during which resources are searched (formatted according to RFC3339).

Returns:



2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
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
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
 
# File 'lib/oci/jms/java_management_service_client.rb', line 2861

def list_installation_sites(fleet_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#list_installation_sites.' if logger

  raise "Missing the required parameter 'fleet_id' when calling list_installation_sites." if fleet_id.nil?

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

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


  os_family_allowable_values = %w[LINUX WINDOWS MACOS UNKNOWN]
  if opts[:os_family] && !opts[:os_family].empty?
    opts[:os_family].each do |val_to_check|
      unless os_family_allowable_values.include?(val_to_check)
        raise 'Invalid value for "os_family", must be one of LINUX, WINDOWS, MACOS, UNKNOWN.'
      end
    end
  end

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

  path = '/fleets/{fleetId}/installationSites'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:jreVendor] = opts[:jre_vendor] if opts[:jre_vendor]
  query_params[:jreDistribution] = opts[:jre_distribution] if opts[:jre_distribution]
  query_params[:jreVersion] = opts[:jre_version] if opts[:jre_version]
  query_params[:installationPath] = opts[:installation_path] if opts[:installation_path]
  query_params[:applicationId] = opts[:application_id] if opts[:application_id]
  query_params[:managedInstanceId] = opts[:managed_instance_id] if opts[:managed_instance_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:osFamily] = OCI::ApiClient.build_collection_params(opts[:os_family], :multi) if opts[:os_family] && !opts[:os_family].empty?
  query_params[:jreSecurityStatus] = opts[:jre_security_status] if opts[:jre_security_status]
  query_params[:pathContains] = opts[:path_contains] if opts[:path_contains]
  query_params[:timeStart] = opts[:time_start] if opts[:time_start]
  query_params[:timeEnd] = opts[:time_end] if opts[:time_end]

  # Header Params
  header_params = {}
  header_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: 'JavaManagementServiceClient#list_installation_sites') 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::Jms::Models::InstallationSiteCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_java_families(opts = {}) ⇒ Response

Note:

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

Returns a list of the Java release family information. A Java release family is typically a major version in the Java version identifier.

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

  • :family_version (String) —

    The version identifier for the Java family.

  • :display_name (String) —

    The display name for the Java family.

  • :is_supported_version (BOOLEAN) —

    Filter the Java Release Family versions by support status.

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

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

  • :sort_by (String) —

    If no value is specified familyVersion is default. (default to familyVersion)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
 
# File 'lib/oci/jms/java_management_service_client.rb', line 2961

def list_java_families(opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#list_java_families.' if logger


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

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

  path = '/javaFamilies'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:familyVersion] = opts[:family_version] if opts[:family_version]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:isSupportedVersion] = opts[:is_supported_version] if !opts[:is_supported_version].nil?
  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: 'JavaManagementServiceClient#list_java_families') 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::Jms::Models::JavaFamilyCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_java_migration_analysis_results(fleet_id, opts = {}) ⇒ Response

Note:

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

Lists the results of a Java migration analysis.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

  • 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

  • :managed_instance_id (String) —

    The Fleet-unique identifier of the related managed instance.

  • :host_name (String) —

    The host OCID of the managed instance. (default to hostName)

  • :application_name (String) —

    The name of the application.

  • :time_start (DateTime) —

    The start of the time period during which resources are searched (formatted according to RFC3339).

  • :time_end (DateTime) —

    The end of the time period during which resources are searched (formatted according to RFC3339).

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

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

  • :sort_by (String) —

    The field that sorts the Java migration analysis results. Only one sort order can be provided. The default order for timeCreated, managedInstanceId and workRequestId is descending. If no value is specified, then timeCreated is default. (default to timeCreated)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
 
# File 'lib/oci/jms/java_management_service_client.rb', line 3040

def list_java_migration_analysis_results(fleet_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#list_java_migration_analysis_results.' if logger

  raise "Missing the required parameter 'fleet_id' when calling list_java_migration_analysis_results." if fleet_id.nil?

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

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

  path = '/fleets/{fleetId}/javaMigrationAnalysisResults'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:managedInstanceId] = opts[:managed_instance_id] if opts[:managed_instance_id]
  query_params[:hostName] = opts[:host_name] if opts[:host_name]
  query_params[:applicationName] = opts[:application_name] if opts[:application_name]
  query_params[:timeStart] = opts[:time_start] if opts[:time_start]
  query_params[:timeEnd] = opts[:time_end] if opts[:time_end]
  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: 'JavaManagementServiceClient#list_java_migration_analysis_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::Jms::Models::JavaMigrationAnalysisResultCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_java_releases(opts = {}) ⇒ Response

Note:

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

Returns a list of Java releases.

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

  • :release_version (String) —

    Unique Java release version identifier

  • :family_version (String) —

    The version identifier for the Java family.

  • :release_type (String) —

    Java release type.

  • :jre_security_status (String) —

    The security status of the Java Runtime.

  • :license_type (String) —

    Java license type.

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

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

  • :sort_by (String) —

    If no value is specified releaseDate is default. (default to releaseDate)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
 
# File 'lib/oci/jms/java_management_service_client.rb', line 3121

def list_java_releases(opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#list_java_releases.' if logger


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

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

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

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

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

  path = '/javaReleases'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:releaseVersion] = opts[:release_version] if opts[:release_version]
  query_params[:familyVersion] = opts[:family_version] if opts[:family_version]
  query_params[:releaseType] = opts[:release_type] if opts[:release_type]
  query_params[:jreSecurityStatus] = opts[:jre_security_status] if opts[:jre_security_status]
  query_params[:licenseType] = opts[:license_type] if opts[:license_type]
  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: 'JavaManagementServiceClient#list_java_releases') 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::Jms::Models::JavaReleaseCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_jms_plugins(opts = {}) ⇒ Response

Note:

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

Lists the JmsPlugins.

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 in which to list resources.

  • :compartment_id_in_subtree (BOOLEAN) —

    Flag to determine whether the info should be gathered only in the compartment or in the compartment and its subcompartments. (default to false)

  • :id (String) —

    The OCID of the JmsPlugin.

  • :fleet_id (String) —

    The ID of the Fleet.

  • :agent_id (String) —

    The ManagementAgent (OMA) or Instance (OCA) OCID that identifies the Agent.

  • :lifecycle_state (String) —

    Filter JmsPlugin with its lifecycle state.

  • :availability_status (String) —

    Filter JmsPlugin with its availability status.

  • :agent_type (String) —

    Filter JmsPlugin with agent type.

  • :time_registered_less_than_or_equal_to (DateTime) —

    If present, only plugins with a registration time before this parameter are searched (formatted according to RFC3339).

  • :time_last_seen_less_than_or_equal_to (DateTime) —

    If present, only plugins with a last seen time before this parameter are searched (formatted according to RFC3339).

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

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

  • :sort_by (String) —

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

  • :hostname_contains (String) —

    Filter the list with hostname contains the given value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
 
# File 'lib/oci/jms/java_management_service_client.rb', line 3222

def list_jms_plugins(opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#list_jms_plugins.' if logger


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

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

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

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

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

  path = '/jmsPlugins'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:fleetId] = opts[:fleet_id] if opts[:fleet_id]
  query_params[:agentId] = opts[:agent_id] if opts[:agent_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:availabilityStatus] = opts[:availability_status] if opts[:availability_status]
  query_params[:agentType] = opts[:agent_type] if opts[:agent_type]
  query_params[:timeRegisteredLessThanOrEqualTo] = opts[:time_registered_less_than_or_equal_to] if opts[:time_registered_less_than_or_equal_to]
  query_params[:timeLastSeenLessThanOrEqualTo] = opts[:time_last_seen_less_than_or_equal_to] if opts[:time_last_seen_less_than_or_equal_to]
  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[:hostnameContains] = opts[:hostname_contains] if opts[:hostname_contains]

  # Header Params
  header_params = {}
  header_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: 'JavaManagementServiceClient#list_jms_plugins') 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::Jms::Models::JmsPluginCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_jre_usage(opts = {}) ⇒ Response

Note:

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

List Java Runtime usage in a specified host filtered by query parameters.

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 in which to list resources.

  • :host_id (String) —

    The host OCID of the managed instance.

  • :application_id (String) —

    The Fleet-unique identifier of the application.

  • :application_name (String) —

    The name of the application.

  • :time_start (DateTime) —

    The start of the time period during which resources are searched (formatted according to RFC3339).

  • :time_end (DateTime) —

    The end of the time period during which resources are searched (formatted according to RFC3339).

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

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

  • :sort_by (String) —

    The field to sort JRE usages. Only one sort order may be provided. Default order for timeFirstSeen, timeLastSeen, and version is descending. Default order for timeFirstSeen, timeLastSeen, version, approximateInstallationCount, approximateApplicationCount and approximateManagedInstanceCount is descending. Default order for distribution, vendor, and osName is ascending. If no value is specified timeLastSeen is default. (default to timeLastSeen)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
 
# File 'lib/oci/jms/java_management_service_client.rb', line 3325

def list_jre_usage(opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#list_jre_usage.' if logger


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

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

  path = '/listJreUsage'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:hostId] = opts[:host_id] if opts[:host_id]
  query_params[:applicationId] = opts[:application_id] if opts[:application_id]
  query_params[:applicationName] = opts[:application_name] if opts[:application_name]
  query_params[:timeStart] = opts[:time_start] if opts[:time_start]
  query_params[:timeEnd] = opts[:time_end] if opts[:time_end]
  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: 'JavaManagementServiceClient#list_jre_usage') 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::Jms::Models::JreUsageCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_performance_tuning_analysis_results(fleet_id, opts = {}) ⇒ Response

Note:

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

List Performance Tuning Analysis results.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

  • 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

  • :managed_instance_id (String) —

    The Fleet-unique identifier of the related managed instance.

  • :application_id (String) —

    The Fleet-unique identifier of the related application.

  • :application_name (String) —

    The name of the application.

  • :host_name (String) —

    The host OCID of the managed instance. (default to hostName)

  • :time_start (DateTime) —

    The start of the time period during which resources are searched (formatted according to RFC3339).

  • :time_end (DateTime) —

    The end of the time period during which resources are searched (formatted according to RFC3339).

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

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

  • :sort_by (String) —

    The field to sort performance tuning analysis results. Only one sort order may be provided. Default order for timeCreated, and jreVersion is descending. Default order for managedInstanceId, jreDistribution, jreVendor and osName is ascending. If no value is specified timeCreated is default. (default to timeCreated)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
 
# File 'lib/oci/jms/java_management_service_client.rb', line 3409

def list_performance_tuning_analysis_results(fleet_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#list_performance_tuning_analysis_results.' if logger

  raise "Missing the required parameter 'fleet_id' when calling list_performance_tuning_analysis_results." if fleet_id.nil?

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

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

  path = '/fleets/{fleetId}/performanceTuningAnalysisResults'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:managedInstanceId] = opts[:managed_instance_id] if opts[:managed_instance_id]
  query_params[:applicationId] = opts[:application_id] if opts[:application_id]
  query_params[:applicationName] = opts[:application_name] if opts[:application_name]
  query_params[:hostName] = opts[:host_name] if opts[:host_name]
  query_params[:timeStart] = opts[:time_start] if opts[:time_start]
  query_params[:timeEnd] = opts[:time_end] if opts[:time_end]
  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: 'JavaManagementServiceClient#list_performance_tuning_analysis_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::Jms::Models::PerformanceTuningAnalysisResultCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_plugin_errors(opts = {}) ⇒ Response

Note:

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

Returns a list of plugin errors that describe all detected errors.

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 in which to list resources.

  • :compartment_id_in_subtree (BOOLEAN) —

    Flag to determine whether the info should be gathered only in the compartment or in the compartment and its subcompartments. (default to false)

  • :managed_instance_id (String) —

    The Fleet-unique identifier of the managed instance.

  • :time_first_seen_less_than_or_equal_to (DateTime) —

    If specified, only errors with a first seen time earlier than this parameter will be included in the search (formatted according to RFC3339).

  • :time_first_seen_greater_than_or_equal_to (DateTime) —

    If specified, only errors with a first seen time later than this parameter will be included in the search (formatted according to RFC3339).

  • :time_last_seen_less_than_or_equal_to (DateTime) —

    If specified, only errors with a last seen time earlier than this parameter will be included in the search (formatted according to RFC3339).

  • :time_last_seen_greater_than_or_equal_to (DateTime) —

    If specified, only errors with a last seen time later than this parameter will be included in the search (formatted according to RFC3339).

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_by (String) —

    The field to sort PluginError. Only one sort order may be provided. Default order is descending. If no value is specified timeLastSeen is default. (default to TIME_LAST_SEEN)

  • :sort_order (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
 
# File 'lib/oci/jms/java_management_service_client.rb', line 3496

def list_plugin_errors(opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#list_plugin_errors.' if logger


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

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

  path = '/pluginErrors'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:managedInstanceId] = opts[:managed_instance_id] if opts[:managed_instance_id]
  query_params[:timeFirstSeenLessThanOrEqualTo] = opts[:time_first_seen_less_than_or_equal_to] if opts[:time_first_seen_less_than_or_equal_to]
  query_params[:timeFirstSeenGreaterThanOrEqualTo] = opts[:time_first_seen_greater_than_or_equal_to] if opts[:time_first_seen_greater_than_or_equal_to]
  query_params[:timeLastSeenLessThanOrEqualTo] = opts[:time_last_seen_less_than_or_equal_to] if opts[:time_last_seen_less_than_or_equal_to]
  query_params[:timeLastSeenGreaterThanOrEqualTo] = opts[:time_last_seen_greater_than_or_equal_to] if opts[:time_last_seen_greater_than_or_equal_to]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

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

  post_body = nil

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

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

Note:

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

Retrieve a paginated list of work items for a specified 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.

  • :page (String) —

    The page token representing 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)

Returns:



3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
 
# File 'lib/oci/jms/java_management_service_client.rb', line 3570

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

  raise "Missing the required parameter 'work_request_id' when calling list_work_items." 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}/workItems'.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]

  # Header Params
  header_params = {}
  header_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: 'JavaManagementServiceClient#list_work_items') 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::Jms::Models::WorkItemCollection'
    )
  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.

Retrieve a (paginated) list of errors for a specified 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.

  • :page (String) —

    The page token representing 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)

Returns:



3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
 
# File 'lib/oci/jms/java_management_service_client.rb', line 3629

def list_work_request_errors(work_request_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#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?
  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]

  # Header Params
  header_params = {}
  header_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: 'JavaManagementServiceClient#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::Jms::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.

Retrieve a paginated list of logs for a specified 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.

  • :page (String) —

    The page token representing 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)

Returns:



3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
 
# File 'lib/oci/jms/java_management_service_client.rb', line 3688

def list_work_request_logs(work_request_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#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?
  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]

  # Header Params
  header_params = {}
  header_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: 'JavaManagementServiceClient#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::Jms::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.

List the work requests in a compartment. The query parameter compartmentId is required unless the query parameter id or fleetId is specified.

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 in which to list resources.

  • :id (String) —

    The ID of an asynchronous work request.

  • :fleet_id (String) —

    The OCID of the fleet.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :page (String) —

    The page token representing 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)

  • :managed_instance_id (String) —

    The Fleet-unique identifier of the managed instance.

  • :operation_type (String) —

    The operation type of the work request.

  • :status (Array<String>) —

    The status of the work request. (default to []) Allowed values are: ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, SUCCEEDED

Returns:



3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
 
# File 'lib/oci/jms/java_management_service_client.rb', line 3754

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


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


  status_allowable_values = %w[ACCEPTED CANCELED CANCELING FAILED IN_PROGRESS SUCCEEDED]
  if opts[:status] && !opts[:status].empty?
    opts[:status].each do |val_to_check|
      unless status_allowable_values.include?(val_to_check)
        raise 'Invalid value for "status", must be one of ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, SUCCEEDED.'
      end
    end
  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[:id] = opts[:id] if opts[:id]
  query_params[:fleetId] = opts[:fleet_id] if opts[:fleet_id]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:managedInstanceId] = opts[:managed_instance_id] if opts[:managed_instance_id]
  query_params[:operationType] = opts[:operation_type] if opts[:operation_type]
  query_params[:status] = OCI::ApiClient.build_collection_params(opts[:status], :multi) if opts[:status] && !opts[:status].empty?

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

  post_body = nil

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

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



94
95
96
 
# File 'lib/oci/jms/java_management_service_client.rb', line 94

def logger
  @api_client.config.logger
end

#remove_fleet_installation_sites(fleet_id, remove_fleet_installation_sites_details, opts = {}) ⇒ Response

Note:

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

Remove Java installation sites in a Fleet.

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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_retry_token (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
 
# File 'lib/oci/jms/java_management_service_client.rb', line 3841

def remove_fleet_installation_sites(fleet_id, remove_fleet_installation_sites_details, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#remove_fleet_installation_sites.' if logger

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

  path = '/fleets/{fleetId}/actions/removeInstallationSites'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(remove_fleet_installation_sites_details)

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

#request_crypto_analyses(fleet_id, request_crypto_analyses_details, opts = {}) ⇒ Response

Note:

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

Request to perform crypto analysis on one or more selected targets in the Fleet. The result of the crypto analysis will be uploaded to the object storage bucket created by JMS on enabling the Crypto Event Analysis feature in the Fleet.

Parameters:

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
 
# File 'lib/oci/jms/java_management_service_client.rb', line 3900

def request_crypto_analyses(fleet_id, request_crypto_analyses_details, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#request_crypto_analyses.' if logger

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

  path = '/fleets/{fleetId}/actions/requestCryptoAnalyses'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(request_crypto_analyses_details)

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

#request_deployed_application_migration_analyses(fleet_id, request_deployed_application_migration_analyses_details, opts = {}) ⇒ Response

Note:

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

Request to perform a deployed Java migration analyses. The results of the deployed Java migration analyses will be uploaded to the Object Storage bucket that you designate when you enable the Java Migration Analyses feature.

Parameters:

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



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

def request_deployed_application_migration_analyses(fleet_id, request_deployed_application_migration_analyses_details, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#request_deployed_application_migration_analyses.' if logger

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

  path = '/fleets/{fleetId}/actions/requestDeployedApplicationMigrationAnalyses'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(request_deployed_application_migration_analyses_details)

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

#request_java_migration_analyses(fleet_id, request_java_migration_analyses_details, opts = {}) ⇒ Response

Note:

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

Request to perform a Java migration analysis. The results of the Java migration analysis will be uploaded to the Object Storage bucket that you designate when you enable the Java Migration Analysis feature.

Parameters:

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



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

def request_java_migration_analyses(fleet_id, request_java_migration_analyses_details, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#request_java_migration_analyses.' if logger

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

  path = '/fleets/{fleetId}/actions/requestJavaMigrationAnalyses'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(request_java_migration_analyses_details)

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

#request_jfr_recordings(fleet_id, request_jfr_recordings_details, opts = {}) ⇒ Response

Note:

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

Request to collect the JFR recordings on the selected target in the Fleet. The JFR files are uploaded to the object storage bucket created by JMS on enabling Generic JFR feature in the Fleet.

Parameters:

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



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

def request_jfr_recordings(fleet_id, request_jfr_recordings_details, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#request_jfr_recordings.' if logger

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

  path = '/fleets/{fleetId}/actions/requestJfrRecordings'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(request_jfr_recordings_details)

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

#request_performance_tuning_analyses(fleet_id, request_performance_tuning_analyses_details, opts = {}) ⇒ Response

Note:

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

Request to perform performance tuning analyses. The result of performance tuning analysis will be uploaded to the object storage bucket that you designated when you enabled the recording feature.

Parameters:

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



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

def request_performance_tuning_analyses(fleet_id, request_performance_tuning_analyses_details, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#request_performance_tuning_analyses.' if logger

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

  path = '/fleets/{fleetId}/actions/requestPerformanceTuningAnalyses'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(request_performance_tuning_analyses_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'JavaManagementServiceClient#request_performance_tuning_analyses') 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_java_server_usage(fleet_id, scan_java_server_usage_details, opts = {}) ⇒ Response

Note:

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

Scan Java Server usage in a fleet.

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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_retry_token (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
 
# File 'lib/oci/jms/java_management_service_client.rb', line 4194

def scan_java_server_usage(fleet_id, scan_java_server_usage_details, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#scan_java_server_usage.' if logger

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

  path = '/fleets/{fleetId}/actions/scanJavaServerUsage'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(scan_java_server_usage_details)

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

#scan_library_usage(fleet_id, scan_library_usage_details, opts = {}) ⇒ Response

Note:

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

Scan library usage in a fleet.

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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_retry_token (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
 
# File 'lib/oci/jms/java_management_service_client.rb', line 4264

def scan_library_usage(fleet_id, scan_library_usage_details, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#scan_library_usage.' if logger

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

  path = '/fleets/{fleetId}/actions/scanLibraryUsage'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(scan_library_usage_details)

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

#summarize_application_installation_usage(fleet_id, opts = {}) ⇒ Response

Note:

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

Summarizes the application installation usage in a Fleet filtered by query parameters. In contrast to SummarizeApplicationUsage, which provides only information aggregated by application name, this operation provides installation details. This allows for better focusing of actions.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

  • 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

  • :application_installation_key (String) —

    The Fleet-unique identifier of the application installation.

  • :application_id (String) —

    The Fleet-unique identifier of the application.

  • :display_name (String) —

    The display name.

  • :display_name_contains (String) —

    Filter the list with displayName contains the given value.

  • :application_type (String) —

    The type of the application.

  • :app_installation_path_contains (String) —

    Filter the list with the application installation path that contains the given value.

  • :jre_vendor (String) —

    The vendor of the related Java Runtime.

  • :jre_distribution (String) —

    The distribution of the related Java Runtime.

  • :jre_version (String) —

    The version of the related Java Runtime.

  • :installation_path (String) —

    The file system path of the Java Runtime installation.

  • :library_key (String) —

    The library key.

  • :managed_instance_id (String) —

    The Fleet-unique identifier of the related managed instance.

  • :os_family (Array<String>) —

    The operating system type. Allowed values are: LINUX, WINDOWS, MACOS, UNKNOWN

  • :time_start (DateTime) —

    The start of the time period during which resources are searched (formatted according to RFC3339).

  • :time_end (DateTime) —

    The end of the time period during which resources are searched (formatted according to RFC3339).

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

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

  • :sort_by (String) —

    The field to sort application installation views. Only one sort order may be provided. Default order for timeFirstSeen, timeLastSeen, approximateJreCount, approximateInstallationCount and approximateManagedInstanceCount is descending. Default order for displayName, installationPath and osName is ascending. If no value is specified timeLastSeen is default. (default to timeLastSeen)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
 
# File 'lib/oci/jms/java_management_service_client.rb', line 4349

def summarize_application_installation_usage(fleet_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#summarize_application_installation_usage.' if logger

  raise "Missing the required parameter 'fleet_id' when calling summarize_application_installation_usage." if fleet_id.nil?


  os_family_allowable_values = %w[LINUX WINDOWS MACOS UNKNOWN]
  if opts[:os_family] && !opts[:os_family].empty?
    opts[:os_family].each do |val_to_check|
      unless os_family_allowable_values.include?(val_to_check)
        raise 'Invalid value for "os_family", must be one of LINUX, WINDOWS, MACOS, UNKNOWN.'
      end
    end
  end

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

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

  path = '/fleets/{fleetId}/actions/summarizeApplicationInstallationUsage'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:applicationInstallationKey] = opts[:application_installation_key] if opts[:application_installation_key]
  query_params[:applicationId] = opts[:application_id] if opts[:application_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains]
  query_params[:applicationType] = opts[:application_type] if opts[:application_type]
  query_params[:appInstallationPathContains] = opts[:app_installation_path_contains] if opts[:app_installation_path_contains]
  query_params[:jreVendor] = opts[:jre_vendor] if opts[:jre_vendor]
  query_params[:jreDistribution] = opts[:jre_distribution] if opts[:jre_distribution]
  query_params[:jreVersion] = opts[:jre_version] if opts[:jre_version]
  query_params[:installationPath] = opts[:installation_path] if opts[:installation_path]
  query_params[:libraryKey] = opts[:library_key] if opts[:library_key]
  query_params[:managedInstanceId] = opts[:managed_instance_id] if opts[:managed_instance_id]
  query_params[:osFamily] = OCI::ApiClient.build_collection_params(opts[:os_family], :multi) if opts[:os_family] && !opts[:os_family].empty?
  query_params[:timeStart] = opts[:time_start] if opts[:time_start]
  query_params[:timeEnd] = opts[:time_end] if opts[:time_end]
  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: 'JavaManagementServiceClient#summarize_application_installation_usage') 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::Jms::Models::ApplicationInstallationUsageSummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_application_usage(fleet_id, opts = {}) ⇒ Response

Note:

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

List application usage in a Fleet filtered by query parameters.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

  • 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

  • :application_id (String) —

    The Fleet-unique identifier of the application.

  • :display_name (String) —

    The display name.

  • :application_type (String) —

    The type of the application.

  • :jre_vendor (String) —

    The vendor of the related Java Runtime.

  • :jre_distribution (String) —

    The distribution of the related Java Runtime.

  • :jre_version (String) —

    The version of the related Java Runtime.

  • :installation_path (String) —

    The file system path of the Java Runtime installation.

  • :managed_instance_id (String) —

    The Fleet-unique identifier of the related managed instance.

  • :fields (Array<String>) —

    Additional fields to include into the returned model on top of the required ones. This parameter can also include 'approximateJreCount', 'approximateInstallationCount' and 'approximateManagedInstanceCount'. For example 'approximateJreCount,approximateInstallationCount'. (default to []) Allowed values are: approximateJreCount, approximateInstallationCount, approximateManagedInstanceCount

  • :time_start (DateTime) —

    The start of the time period during which resources are searched (formatted according to RFC3339).

  • :time_end (DateTime) —

    The end of the time period during which resources are searched (formatted according to RFC3339).

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

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

  • :sort_by (String) —

    The field to sort application views. Only one sort order may be provided. Default order for timeFirstSeen, timeLastSeen, approximateJreCount, approximateInstallationCount and approximateManagedInstanceCount is descending. Default order for displayName and osName is ascending. If no value is specified timeLastSeen is default. (default to timeLastSeen)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :os_family (Array<String>) —

    The operating system type. Allowed values are: LINUX, WINDOWS, MACOS, UNKNOWN

  • :display_name_contains (String) —

    Filter the list with displayName contains the given value.

  • :library_key (String) —

    The library key.

Returns:



4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
 
# File 'lib/oci/jms/java_management_service_client.rb', line 4470

def summarize_application_usage(fleet_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#summarize_application_usage.' if logger

  raise "Missing the required parameter 'fleet_id' when calling summarize_application_usage." if fleet_id.nil?


  fields_allowable_values = %w[approximateJreCount approximateInstallationCount approximateManagedInstanceCount]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of approximateJreCount, approximateInstallationCount, approximateManagedInstanceCount.'
      end
    end
  end

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

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


  os_family_allowable_values = %w[LINUX WINDOWS MACOS UNKNOWN]
  if opts[:os_family] && !opts[:os_family].empty?
    opts[:os_family].each do |val_to_check|
      unless os_family_allowable_values.include?(val_to_check)
        raise 'Invalid value for "os_family", must be one of LINUX, WINDOWS, MACOS, UNKNOWN.'
      end
    end
  end
  raise "Parameter value for 'fleet_id' must not be blank" if OCI::Internal::Util.blank_string?(fleet_id)

  path = '/fleets/{fleetId}/actions/summarizeApplicationUsage'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:applicationId] = opts[:application_id] if opts[:application_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:applicationType] = opts[:application_type] if opts[:application_type]
  query_params[:jreVendor] = opts[:jre_vendor] if opts[:jre_vendor]
  query_params[:jreDistribution] = opts[:jre_distribution] if opts[:jre_distribution]
  query_params[:jreVersion] = opts[:jre_version] if opts[:jre_version]
  query_params[:installationPath] = opts[:installation_path] if opts[:installation_path]
  query_params[:managedInstanceId] = opts[:managed_instance_id] if opts[:managed_instance_id]
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?
  query_params[:timeStart] = opts[:time_start] if opts[:time_start]
  query_params[:timeEnd] = opts[:time_end] if opts[:time_end]
  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[:osFamily] = OCI::ApiClient.build_collection_params(opts[:os_family], :multi) if opts[:os_family] && !opts[:os_family].empty?
  query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains]
  query_params[:libraryKey] = opts[:library_key] if opts[:library_key]

  # Header Params
  header_params = {}
  header_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: 'JavaManagementServiceClient#summarize_application_usage') 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::Jms::Models::ApplicationUsageCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_deployed_application_installation_usage(fleet_id, opts = {}) ⇒ Response

Note:

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

Summarize installation usage of an application deployed on Java servers in a fleet filtered by query parameters. In contrast to SummarizeDeployedApplicationUsage, which provides only information aggregated by the deployment information, this operation provides installation details and allows for better focusing of actions.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

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

    The server key.

  • :server_instance_key (String) —

    The Java Server instance key.

  • :managed_instance_id (String) —

    The Fleet-unique identifier of the managed instance.

  • :application_installation_key (String) —

    The deployed application installation key.

  • :application_key (String) —

    The deployed application key.

  • :application_name_contains (String) —

    Filter the list with deployed application name contains the given value.

  • :application_name (String) —

    The deployed application name.

  • :application_source_path_contains (String) —

    Filter the list with application source path contains the given value.

  • :library_key (String) —

    The library key.

  • :time_start (DateTime) —

    The start of the time period during which resources are searched (formatted according to RFC3339).

  • :time_end (DateTime) —

    The end of the time period during which resources are searched (formatted according to RFC3339).

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

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

  • :sort_by (String) —

    The field to sort the deployed application installations. Only one sort order can be provided. If no value is specified timeLastSeen is default.

    (default to timeLastSeen)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
 
# File 'lib/oci/jms/java_management_service_client.rb', line 4596

def summarize_deployed_application_installation_usage(fleet_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#summarize_deployed_application_installation_usage.' if logger

  raise "Missing the required parameter 'fleet_id' when calling summarize_deployed_application_installation_usage." if fleet_id.nil?

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

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

  path = '/fleets/{fleetId}/actions/summarizeDeployedApplicationInstallationUsage'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:serverKey] = opts[:server_key] if opts[:server_key]
  query_params[:serverInstanceKey] = opts[:server_instance_key] if opts[:server_instance_key]
  query_params[:managedInstanceId] = opts[:managed_instance_id] if opts[:managed_instance_id]
  query_params[:applicationInstallationKey] = opts[:application_installation_key] if opts[:application_installation_key]
  query_params[:applicationKey] = opts[:application_key] if opts[:application_key]
  query_params[:applicationNameContains] = opts[:application_name_contains] if opts[:application_name_contains]
  query_params[:applicationName] = opts[:application_name] if opts[:application_name]
  query_params[:applicationSourcePathContains] = opts[:application_source_path_contains] if opts[:application_source_path_contains]
  query_params[:libraryKey] = opts[:library_key] if opts[:library_key]
  query_params[:timeStart] = opts[:time_start] if opts[:time_start]
  query_params[:timeEnd] = opts[:time_end] if opts[:time_end]
  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: 'JavaManagementServiceClient#summarize_deployed_application_installation_usage') 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::Jms::Models::DeployedApplicationInstallationUsageSummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_deployed_application_usage(fleet_id, opts = {}) ⇒ Response

Note:

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

List of deployed applications in a Fleet filtered by query parameters.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

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

    The server key.

  • :server_instance_key (String) —

    The Java Server instance key.

  • :managed_instance_id (String) —

    The Fleet-unique identifier of the managed instance.

  • :library_key (String) —

    The library key.

  • :application_key (String) —

    The deployed application key.

  • :application_name_contains (String) —

    Filter the list with deployed application name contains the given value.

  • :application_name (String) —

    The deployed application name.

  • :time_start (DateTime) —

    The start of the time period during which resources are searched (formatted according to RFC3339).

  • :time_end (DateTime) —

    The end of the time period during which resources are searched (formatted according to RFC3339).

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

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

  • :sort_by (String) —

    The field to sort the deployed applications. Only one sort order can be provided. If no value is specified timeLastSeen is default. (default to timeLastSeen)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
 
# File 'lib/oci/jms/java_management_service_client.rb', line 4695

def summarize_deployed_application_usage(fleet_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#summarize_deployed_application_usage.' if logger

  raise "Missing the required parameter 'fleet_id' when calling summarize_deployed_application_usage." if fleet_id.nil?

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

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

  path = '/fleets/{fleetId}/actions/summarizeDeployedApplicationUsage'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:serverKey] = opts[:server_key] if opts[:server_key]
  query_params[:serverInstanceKey] = opts[:server_instance_key] if opts[:server_instance_key]
  query_params[:managedInstanceId] = opts[:managed_instance_id] if opts[:managed_instance_id]
  query_params[:libraryKey] = opts[:library_key] if opts[:library_key]
  query_params[:applicationKey] = opts[:application_key] if opts[:application_key]
  query_params[:applicationNameContains] = opts[:application_name_contains] if opts[:application_name_contains]
  query_params[:applicationName] = opts[:application_name] if opts[:application_name]
  query_params[:timeStart] = opts[:time_start] if opts[:time_start]
  query_params[:timeEnd] = opts[:time_end] if opts[:time_end]
  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: 'JavaManagementServiceClient#summarize_deployed_application_usage') 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::Jms::Models::DeployedApplicationUsageCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_fleet_errors(opts = {}) ⇒ Response

Note:

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

Returns a high level summary of FleetErrors.

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 in which to list resources.

  • :compartment_id_in_subtree (BOOLEAN) —

    Flag to determine whether the info should be gathered only in the compartment or in the compartment and its subcompartments. (default to false)

  • :limit (Integer) —

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

  • :page (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
 
# File 'lib/oci/jms/java_management_service_client.rb', line 4775

def summarize_fleet_errors(opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#summarize_fleet_errors.' if logger


  path = '/fleetErrorAnalytics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

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

  post_body = nil

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

#summarize_installation_usage(fleet_id, opts = {}) ⇒ Response

Note:

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

List Java installation usage in a Fleet filtered by query parameters.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

  • 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

  • :jre_vendor (String) —

    The vendor of the related Java Runtime.

  • :jre_distribution (String) —

    The distribution of the related Java Runtime.

  • :jre_version (String) —

    The version of the related Java Runtime.

  • :installation_path (String) —

    The file system path of the installation.

  • :application_id (String) —

    The Fleet-unique identifier of the related application.

  • :managed_instance_id (String) —

    The Fleet-unique identifier of the related managed instance.

  • :fields (Array<String>) —

    Additional fields to include into the returned model on top of the required ones. This parameter can also include 'approximateApplicationCount' and 'approximateManagedInstanceCount'. For example 'approximateApplicationCount,approximateManagedInstanceCount'. (default to []) Allowed values are: approximateApplicationCount, approximateManagedInstanceCount

  • :time_start (DateTime) —

    The start of the time period during which resources are searched (formatted according to RFC3339).

  • :time_end (DateTime) —

    The end of the time period during which resources are searched (formatted according to RFC3339).

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

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

  • :sort_by (String) —

    The field to sort installation views. Only one sort order may be provided. Default order for timeFirstSeen, timeLastSeen, and jreVersion, approximateApplicationCount and approximateManagedInstanceCount is descending. Default order for jreDistribution and jreVendor is ascending. If no value is specified timeLastSeen is default. (default to timeLastSeen)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :os_family (Array<String>) —

    The operating system type. Allowed values are: LINUX, WINDOWS, MACOS, UNKNOWN

  • :path_contains (String) —

    Filter the list with path contains the given value.

Returns:



4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
 
# File 'lib/oci/jms/java_management_service_client.rb', line 4856

def summarize_installation_usage(fleet_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#summarize_installation_usage.' if logger

  raise "Missing the required parameter 'fleet_id' when calling summarize_installation_usage." if fleet_id.nil?


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

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

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


  os_family_allowable_values = %w[LINUX WINDOWS MACOS UNKNOWN]
  if opts[:os_family] && !opts[:os_family].empty?
    opts[:os_family].each do |val_to_check|
      unless os_family_allowable_values.include?(val_to_check)
        raise 'Invalid value for "os_family", must be one of LINUX, WINDOWS, MACOS, UNKNOWN.'
      end
    end
  end
  raise "Parameter value for 'fleet_id' must not be blank" if OCI::Internal::Util.blank_string?(fleet_id)

  path = '/fleets/{fleetId}/actions/summarizeInstallationUsage'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:jreVendor] = opts[:jre_vendor] if opts[:jre_vendor]
  query_params[:jreDistribution] = opts[:jre_distribution] if opts[:jre_distribution]
  query_params[:jreVersion] = opts[:jre_version] if opts[:jre_version]
  query_params[:installationPath] = opts[:installation_path] if opts[:installation_path]
  query_params[:applicationId] = opts[:application_id] if opts[:application_id]
  query_params[:managedInstanceId] = opts[:managed_instance_id] if opts[:managed_instance_id]
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?
  query_params[:timeStart] = opts[:time_start] if opts[:time_start]
  query_params[:timeEnd] = opts[:time_end] if opts[:time_end]
  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[:osFamily] = OCI::ApiClient.build_collection_params(opts[:os_family], :multi) if opts[:os_family] && !opts[:os_family].empty?
  query_params[:pathContains] = opts[:path_contains] if opts[:path_contains]

  # Header Params
  header_params = {}
  header_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: 'JavaManagementServiceClient#summarize_installation_usage') 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::Jms::Models::InstallationUsageCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_java_server_instance_usage(fleet_id, opts = {}) ⇒ Response

Note:

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

List Java Server instances in a fleet filtered by query parameters.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

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

    The server key.

  • :server_instance_key (String) —

    The Java Server instance key.

  • :managed_instance_id (String) —

    The Fleet-unique identifier of the managed instance.

  • :application_key (String) —

    The deployed application key.

  • :library_key (String) —

    The library key.

  • :server_instance_name_contains (String) —

    Filter the list with the Java Server instance name contains the given value.

  • :server_instance_name (String) —

    The Java Server instance name.

  • :time_start (DateTime) —

    The start of the time period during which resources are searched (formatted according to RFC3339).

  • :time_end (DateTime) —

    The end of the time period during which resources are searched (formatted according to RFC3339).

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

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

  • :sort_by (String) —

    The field to sort the Java Server instances. Only one sort order can be provided. If no value is specified timeLastSeen is default. (default to timeLastSeen)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
 
# File 'lib/oci/jms/java_management_service_client.rb', line 4975

def summarize_java_server_instance_usage(fleet_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#summarize_java_server_instance_usage.' if logger

  raise "Missing the required parameter 'fleet_id' when calling summarize_java_server_instance_usage." if fleet_id.nil?

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

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

  path = '/fleets/{fleetId}/actions/summarizeJavaServerInstanceUsage'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:serverKey] = opts[:server_key] if opts[:server_key]
  query_params[:serverInstanceKey] = opts[:server_instance_key] if opts[:server_instance_key]
  query_params[:managedInstanceId] = opts[:managed_instance_id] if opts[:managed_instance_id]
  query_params[:applicationKey] = opts[:application_key] if opts[:application_key]
  query_params[:libraryKey] = opts[:library_key] if opts[:library_key]
  query_params[:serverInstanceNameContains] = opts[:server_instance_name_contains] if opts[:server_instance_name_contains]
  query_params[:serverInstanceName] = opts[:server_instance_name] if opts[:server_instance_name]
  query_params[:timeStart] = opts[:time_start] if opts[:time_start]
  query_params[:timeEnd] = opts[:time_end] if opts[:time_end]
  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: 'JavaManagementServiceClient#summarize_java_server_instance_usage') 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::Jms::Models::JavaServerInstanceUsageCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_java_server_usage(fleet_id, opts = {}) ⇒ Response

Note:

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

List of Java servers in a Fleet filtered by query parameters.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

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

    The server key.

  • :server_name_contains (String) —

    Filter the list with server name contains the given value.

  • :server_name (String) —

    The server name.

  • :server_version (String) —

    The server version.

  • :time_start (DateTime) —

    The start of the time period during which resources are searched (formatted according to RFC3339).

  • :time_end (DateTime) —

    The end of the time period during which resources are searched (formatted according to RFC3339).

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

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

  • :sort_by (String) —

    The field to sort a Java Server. Only one sort order can be provided. If no value is specified timeLastSeen is default. (default to timeLastSeen)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
 
# File 'lib/oci/jms/java_management_service_client.rb', line 5067

def summarize_java_server_usage(fleet_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#summarize_java_server_usage.' if logger

  raise "Missing the required parameter 'fleet_id' when calling summarize_java_server_usage." if fleet_id.nil?

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

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

  path = '/fleets/{fleetId}/actions/summarizeJavaServerUsage'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:serverKey] = opts[:server_key] if opts[:server_key]
  query_params[:serverNameContains] = opts[:server_name_contains] if opts[:server_name_contains]
  query_params[:serverName] = opts[:server_name] if opts[:server_name]
  query_params[:serverVersion] = opts[:server_version] if opts[:server_version]
  query_params[:timeStart] = opts[:time_start] if opts[:time_start]
  query_params[:timeEnd] = opts[:time_end] if opts[:time_end]
  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: 'JavaManagementServiceClient#summarize_java_server_usage') 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::Jms::Models::JavaServerUsageCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_jre_usage(fleet_id, opts = {}) ⇒ Response

Note:

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

List Java Runtime usage in a specified Fleet filtered by query parameters.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

  • 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

  • :jre_id (String) —

    The Fleet-unique identifier of the related Java Runtime.

  • :jre_vendor (String) —

    The vendor of the Java Runtime.

  • :jre_distribution (String) —

    The distribution of the Java Runtime.

  • :jre_version (String) —

    The version of the Java Runtime.

  • :application_id (String) —

    The Fleet-unique identifier of the related application.

  • :managed_instance_id (String) —

    The Fleet-unique identifier of the related managed instance.

  • :fields (Array<String>) —

    Additional fields to include into the returned model on top of the required ones. This parameter can also include 'approximateApplicationCount', 'approximateInstallationCount' and 'approximateManagedInstanceCount'. For example 'approximateApplicationCount,approximateManagedInstanceCount'. (default to []) Allowed values are: approximateInstallationCount, approximateApplicationCount, approximateManagedInstanceCount

  • :time_start (DateTime) —

    The start of the time period during which resources are searched (formatted according to RFC3339).

  • :time_end (DateTime) —

    The end of the time period during which resources are searched (formatted according to RFC3339).

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

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

  • :sort_by (String) —

    The field to sort JRE usages. Only one sort order may be provided. Default order for timeFirstSeen, timeLastSeen, and version is descending. Default order for timeFirstSeen, timeLastSeen, version, approximateInstallationCount, approximateApplicationCount and approximateManagedInstanceCount is descending. Default order for distribution, vendor, and osName is ascending. If no value is specified timeLastSeen is default. (default to timeLastSeen)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :os_family (Array<String>) —

    The operating system type. Allowed values are: LINUX, WINDOWS, MACOS, UNKNOWN

  • :jre_security_status (String) —

    The security status of the Java Runtime.

Returns:



5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
 
# File 'lib/oci/jms/java_management_service_client.rb', line 5165

def summarize_jre_usage(fleet_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#summarize_jre_usage.' if logger

  raise "Missing the required parameter 'fleet_id' when calling summarize_jre_usage." if fleet_id.nil?


  fields_allowable_values = %w[approximateInstallationCount approximateApplicationCount approximateManagedInstanceCount]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of approximateInstallationCount, approximateApplicationCount, approximateManagedInstanceCount.'
      end
    end
  end

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

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


  os_family_allowable_values = %w[LINUX WINDOWS MACOS UNKNOWN]
  if opts[:os_family] && !opts[:os_family].empty?
    opts[:os_family].each do |val_to_check|
      unless os_family_allowable_values.include?(val_to_check)
        raise 'Invalid value for "os_family", must be one of LINUX, WINDOWS, MACOS, UNKNOWN.'
      end
    end
  end

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

  path = '/fleets/{fleetId}/actions/summarizeJreUsage'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:jreId] = opts[:jre_id] if opts[:jre_id]
  query_params[:jreVendor] = opts[:jre_vendor] if opts[:jre_vendor]
  query_params[:jreDistribution] = opts[:jre_distribution] if opts[:jre_distribution]
  query_params[:jreVersion] = opts[:jre_version] if opts[:jre_version]
  query_params[:applicationId] = opts[:application_id] if opts[:application_id]
  query_params[:managedInstanceId] = opts[:managed_instance_id] if opts[:managed_instance_id]
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?
  query_params[:timeStart] = opts[:time_start] if opts[:time_start]
  query_params[:timeEnd] = opts[:time_end] if opts[:time_end]
  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[:osFamily] = OCI::ApiClient.build_collection_params(opts[:os_family], :multi) if opts[:os_family] && !opts[:os_family].empty?
  query_params[:jreSecurityStatus] = opts[:jre_security_status] if opts[:jre_security_status]

  # Header Params
  header_params = {}
  header_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: 'JavaManagementServiceClient#summarize_jre_usage') 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::Jms::Models::JreUsageCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_library_usage(fleet_id, opts = {}) ⇒ Response

Note:

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

List libraries in a fleet filtered by query parameters.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

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

    The Java Server instance key.

  • :managed_instance_id (String) —

    The Fleet-unique identifier of the managed instance.

  • :application_key (String) —

    The deployed application key.

  • :library_key (String) —

    The library key.

  • :library_name_contains (String) —

    Filter the list with library name contains the given value.

  • :library_name (String) —

    The library name.

  • :cvss_score_greater_than (Integer) —

    Total Common Vulnerability Scoring System (CVSS) Score reported by the analysis.

  • :cvss_score_less_than (Integer) —

    Total Common Vulnerability Scoring System (CVSS) Score reported by the analysis.

  • :time_start (DateTime) —

    The start of the time period during which resources are searched (formatted according to RFC3339).

  • :time_end (DateTime) —

    The end of the time period during which resources are searched (formatted according to RFC3339).

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

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

  • :sort_by (String) —

    The field to sort libraries. Only one sort order may be provided. If no value is specified timeLastSeen is default. (default to timeLastSeen)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
 
# File 'lib/oci/jms/java_management_service_client.rb', line 5288

def summarize_library_usage(fleet_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#summarize_library_usage.' if logger

  raise "Missing the required parameter 'fleet_id' when calling summarize_library_usage." if fleet_id.nil?

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

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

  path = '/fleets/{fleetId}/actions/summarizeLibraryUsage'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:serverInstanceKey] = opts[:server_instance_key] if opts[:server_instance_key]
  query_params[:managedInstanceId] = opts[:managed_instance_id] if opts[:managed_instance_id]
  query_params[:applicationKey] = opts[:application_key] if opts[:application_key]
  query_params[:libraryKey] = opts[:library_key] if opts[:library_key]
  query_params[:libraryNameContains] = opts[:library_name_contains] if opts[:library_name_contains]
  query_params[:libraryName] = opts[:library_name] if opts[:library_name]
  query_params[:cvssScoreGreaterThan] = opts[:cvss_score_greater_than] if opts[:cvss_score_greater_than]
  query_params[:cvssScoreLessThan] = opts[:cvss_score_less_than] if opts[:cvss_score_less_than]
  query_params[:timeStart] = opts[:time_start] if opts[:time_start]
  query_params[:timeEnd] = opts[:time_end] if opts[:time_end]
  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: 'JavaManagementServiceClient#summarize_library_usage') 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::Jms::Models::LibraryUsageCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_managed_instance_usage(fleet_id, opts = {}) ⇒ Response

Note:

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

List managed instance usage in a Fleet filtered by query parameters.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

  • 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

  • :managed_instance_id (String) —

    The Fleet-unique identifier of the managed instance.

  • :managed_instance_type (String) —

    The type of the managed instance.

  • :jre_vendor (String) —

    The vendor of the related Java Runtime.

  • :jre_distribution (String) —

    The distribution of the related Java Runtime.

  • :jre_version (String) —

    The version of the related Java Runtime.

  • :installation_path (String) —

    The file system path of the Java Runtime installation.

  • :application_id (String) —

    The Fleet-unique identifier of the related application.

  • :fields (Array<String>) —

    Additional fields to include into the returned model on top of the required ones. This parameter can also include 'approximateJreCount', 'approximateInstallationCount' and 'approximateApplicationCount'. For example 'approximateJreCount,approximateInstallationCount'. (default to []) Allowed values are: approximateJreCount, approximateInstallationCount, approximateApplicationCount

  • :time_start (DateTime) —

    The start of the time period during which resources are searched (formatted according to RFC3339).

  • :time_end (DateTime) —

    The end of the time period during which resources are searched (formatted according to RFC3339).

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

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

  • :sort_by (String) —

    The field to sort managed instance views. Only one sort order may be provided. Default order for timeFirstSeen, timeLastSeen, approximateJreCount, approximateInstallationCount_ and approximateApplicationCount is descending. Default order for osName is ascending. If no value is specified timeLastSeen is default. (default to timeLastSeen)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :os_family (Array<String>) —

    The operating system type. Allowed values are: LINUX, WINDOWS, MACOS, UNKNOWN

  • :hostname_contains (String) —

    Filter the list with hostname contains the given value.

  • :library_key (String) —

    The library key.

Returns:



5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
 
# File 'lib/oci/jms/java_management_service_client.rb', line 5393

def summarize_managed_instance_usage(fleet_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#summarize_managed_instance_usage.' if logger

  raise "Missing the required parameter 'fleet_id' when calling summarize_managed_instance_usage." if fleet_id.nil?

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


  fields_allowable_values = %w[approximateJreCount approximateInstallationCount approximateApplicationCount]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of approximateJreCount, approximateInstallationCount, approximateApplicationCount.'
      end
    end
  end

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

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


  os_family_allowable_values = %w[LINUX WINDOWS MACOS UNKNOWN]
  if opts[:os_family] && !opts[:os_family].empty?
    opts[:os_family].each do |val_to_check|
      unless os_family_allowable_values.include?(val_to_check)
        raise 'Invalid value for "os_family", must be one of LINUX, WINDOWS, MACOS, UNKNOWN.'
      end
    end
  end
  raise "Parameter value for 'fleet_id' must not be blank" if OCI::Internal::Util.blank_string?(fleet_id)

  path = '/fleets/{fleetId}/actions/summarizeManagedInstanceUsage'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:managedInstanceId] = opts[:managed_instance_id] if opts[:managed_instance_id]
  query_params[:managedInstanceType] = opts[:managed_instance_type] if opts[:managed_instance_type]
  query_params[:jreVendor] = opts[:jre_vendor] if opts[:jre_vendor]
  query_params[:jreDistribution] = opts[:jre_distribution] if opts[:jre_distribution]
  query_params[:jreVersion] = opts[:jre_version] if opts[:jre_version]
  query_params[:installationPath] = opts[:installation_path] if opts[:installation_path]
  query_params[:applicationId] = opts[:application_id] if opts[:application_id]
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?
  query_params[:timeStart] = opts[:time_start] if opts[:time_start]
  query_params[:timeEnd] = opts[:time_end] if opts[:time_end]
  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[:osFamily] = OCI::ApiClient.build_collection_params(opts[:os_family], :multi) if opts[:os_family] && !opts[:os_family].empty?
  query_params[:hostnameContains] = opts[:hostname_contains] if opts[:hostname_contains]
  query_params[:libraryKey] = opts[:library_key] if opts[:library_key]

  # Header Params
  header_params = {}
  header_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: 'JavaManagementServiceClient#summarize_managed_instance_usage') 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::Jms::Models::ManagedInstanceUsageCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_plugin_errors(opts = {}) ⇒ Response

Note:

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

Returns a high level summary of PluginErrors.

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 in which to list resources.

  • :compartment_id_in_subtree (BOOLEAN) —

    Flag to determine whether the info should be gathered only in the compartment or in the compartment and its subcompartments. (default to false)

  • :limit (Integer) —

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

  • :page (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
 
# File 'lib/oci/jms/java_management_service_client.rb', line 5501

def summarize_plugin_errors(opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#summarize_plugin_errors.' if logger


  path = '/pluginErrorAnalytics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

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

  post_body = nil

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

#summarize_resource_inventory(opts = {}) ⇒ Response

Note:

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

Retrieve the inventory of JMS resources in the specified compartment: a list of the number of active fleets, managed instances, Java Runtimes, Java installations, and applications.

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 in which to list resources.

  • :compartment_id_in_subtree (BOOLEAN) —

    Flag to determine whether the info should be gathered only in the compartment or in the compartment and its subcompartments. (default to false)

  • :time_start (DateTime) —

    The start of the time period during which resources are searched (formatted according to RFC3339).

  • :time_end (DateTime) —

    The end of the time period during which resources are searched (formatted according to RFC3339).

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
 
# File 'lib/oci/jms/java_management_service_client.rb', line 5563

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


  path = '/summarizeResourceInventory'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:timeStart] = opts[:time_start] if opts[:time_start]
  query_params[:timeEnd] = opts[:time_end] if opts[:time_end]

  # Header Params
  header_params = {}
  header_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: 'JavaManagementServiceClient#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::Jms::Models::ResourceInventory'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_drs_file(fleet_id, update_drs_file_details, drs_file_key, opts = {}) ⇒ Response

Note:

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

Request to perform validation of the DRS file and update the existing file in the Object Storage.

Parameters:

  • fleet_id (String) —

    The OCID of the Fleet.

  • update_drs_file_details (OCI::Jms::Models::UpdateDrsFileDetails) —

    Detail information to update DRS

  • drs_file_key (String) —

    The unique identifier of the DRS File in Object Storage.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

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

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



5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
 
# File 'lib/oci/jms/java_management_service_client.rb', line 5634

def update_drs_file(fleet_id, update_drs_file_details, drs_file_key, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#update_drs_file.' if logger

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

  path = '/fleets/{fleetId}/drsFiles/{drsFileKey}'.sub('{fleetId}', fleet_id.to_s).sub('{drsFileKey}', drs_file_key.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(update_drs_file_details)

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

#update_export_setting(fleet_id, update_export_setting_details, opts = {}) ⇒ Response

Note:

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

Updates existing export setting for the specified fleet.

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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:



5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
 
# File 'lib/oci/jms/java_management_service_client.rb', line 5700

def update_export_setting(fleet_id, update_export_setting_details, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#update_export_setting.' if logger

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

  path = '/fleets/{fleetId}/exportSetting'.sub('{fleetId}', fleet_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_export_setting_details)

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

#update_fleet(fleet_id, update_fleet_details, opts = {}) ⇒ Response

Note:

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

Update the Fleet specified by an identifier.

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
 
# File 'lib/oci/jms/java_management_service_client.rb', line 5763

def update_fleet(fleet_id, update_fleet_details, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#update_fleet.' if logger

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

  path = '/fleets/{fleetId}'.sub('{fleetId}', fleet_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_fleet_details)

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

#update_fleet_advanced_feature_configuration(fleet_id, update_fleet_advanced_feature_configuration_details, opts = {}) ⇒ Response

Note:

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

Update advanced feature configurations for the Fleet. Ensure that the namespace and bucket storage are created prior to turning on the JfrRecording or CryptoEventAnalysis feature.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

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



5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
 
# File 'lib/oci/jms/java_management_service_client.rb', line 5833

def update_fleet_advanced_feature_configuration(fleet_id, update_fleet_advanced_feature_configuration_details, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#update_fleet_advanced_feature_configuration.' if logger

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

  path = '/fleets/{fleetId}/advancedFeatureConfiguration'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'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
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(update_fleet_advanced_feature_configuration_details)

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

#update_fleet_agent_configuration(fleet_id, update_fleet_agent_configuration_details, opts = {}) ⇒ Response

Note:

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

Update the Fleet Agent Configuration for the specified Fleet.

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
 
# File 'lib/oci/jms/java_management_service_client.rb', line 5898

def update_fleet_agent_configuration(fleet_id, update_fleet_agent_configuration_details, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#update_fleet_agent_configuration.' if logger

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

  path = '/fleets/{fleetId}/agentConfiguration'.sub('{fleetId}', fleet_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_fleet_agent_configuration_details)

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

#update_jms_plugin(jms_plugin_id, update_jms_plugin_details, opts = {}) ⇒ Response

Note:

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

Updates the Fleet of a JmsPlugin.

Parameters:

  • jms_plugin_id (String) —

    The OCID of the JmsPlugin.

  • update_jms_plugin_details (OCI::Jms::Models::UpdateJmsPluginDetails) —

    The new details for the JmsPlugin.

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



5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
 
# File 'lib/oci/jms/java_management_service_client.rb', line 5960

def update_jms_plugin(jms_plugin_id, update_jms_plugin_details, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#update_jms_plugin.' if logger

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

  path = '/jmsPlugins/{jmsPluginId}'.sub('{jmsPluginId}', jms_plugin_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_jms_plugin_details)

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