Class: OCI::Jms::JavaManagementServiceClient

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

Overview

API for the Java Management Service. Use this API to view, create, and manage Fleets.

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 validaition 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

#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



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

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



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

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



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_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



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

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



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

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_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



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

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



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
937
938
939
940
941
942
943
944
 
# File 'lib/oci/jms/java_management_service_client.rb', line 905

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



976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
 
# File 'lib/oci/jms/java_management_service_client.rb', line 976

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



1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
 
# File 'lib/oci/jms/java_management_service_client.rb', line 1037

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

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



1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
 
# File 'lib/oci/jms/java_management_service_client.rb', line 1137

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:



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

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:



1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
 
# File 'lib/oci/jms/java_management_service_client.rb', line 1252

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:



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

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:



1360
1361
1362
1363
1364
1365
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
 
# File 'lib/oci/jms/java_management_service_client.rb', line 1360

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:



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
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
 
# File 'lib/oci/jms/java_management_service_client.rb', line 1421

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:



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
1505
1506
1507
1508
1509
1510
1511
1512
 
# File 'lib/oci/jms/java_management_service_client.rb', line 1476

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:



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
1564
1565
1566
1567
 
# File 'lib/oci/jms/java_management_service_client.rb', line 1531

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:



1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
 
# File 'lib/oci/jms/java_management_service_client.rb', line 1586

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:



1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
 
# File 'lib/oci/jms/java_management_service_client.rb', line 1642

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



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
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
 
# File 'lib/oci/jms/java_management_service_client.rb', line 1697

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:



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

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



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

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:



1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
 
# File 'lib/oci/jms/java_management_service_client.rb', line 1893

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.

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

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



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
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
 
# File 'lib/oci/jms/java_management_service_client.rb', line 1977

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[: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[: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_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:



2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
 
# File 'lib/oci/jms/java_management_service_client.rb', line 2058

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:



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

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_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 of the Fleet.

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



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

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:



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
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
 
# File 'lib/oci/jms/java_management_service_client.rb', line 2294

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:



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
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
 
# File 'lib/oci/jms/java_management_service_client.rb', line 2394

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.

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

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



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
2515
2516
2517
2518
2519
2520
2521
2522
 
# File 'lib/oci/jms/java_management_service_client.rb', line 2471

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[: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[: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_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:



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
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
 
# File 'lib/oci/jms/java_management_service_client.rb', line 2550

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



2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
 
# File 'lib/oci/jms/java_management_service_client.rb', line 2647

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.

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

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



2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
 
# File 'lib/oci/jms/java_management_service_client.rb', line 2729

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[: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[: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_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_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:



2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
 
# File 'lib/oci/jms/java_management_service_client.rb', line 2802

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:



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

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:



2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
 
# File 'lib/oci/jms/java_management_service_client.rb', line 2920

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.

Returns:



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

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


  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]

  # Header Params
  header_params = {}
  header_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



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 3054

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



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

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_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



3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
 
# File 'lib/oci/jms/java_management_service_client.rb', line 3170

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



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

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



3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
 
# File 'lib/oci/jms/java_management_service_client.rb', line 3283

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



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
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
 
# File 'lib/oci/jms/java_management_service_client.rb', line 3350

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



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

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:



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
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
 
# File 'lib/oci/jms/java_management_service_client.rb', line 3505

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:



3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
 
# File 'lib/oci/jms/java_management_service_client.rb', line 3626

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:



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

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:



3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
 
# File 'lib/oci/jms/java_management_service_client.rb', line 3851

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



3951
3952
3953
3954
3955
3956
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
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
 
# File 'lib/oci/jms/java_management_service_client.rb', line 3951

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:



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
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
 
# File 'lib/oci/jms/java_management_service_client.rb', line 4070

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:



4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
 
# File 'lib/oci/jms/java_management_service_client.rb', line 4162

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:



4260
4261
4262
4263
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
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
 
# File 'lib/oci/jms/java_management_service_client.rb', line 4260

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.

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



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
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
 
# File 'lib/oci/jms/java_management_service_client.rb', line 4381

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



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
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
 
# File 'lib/oci/jms/java_management_service_client.rb', line 4484

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_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.

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



4591
4592
4593
4594
4595
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
 
# File 'lib/oci/jms/java_management_service_client.rb', line 4591

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[: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 validaition 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



4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
 
# File 'lib/oci/jms/java_management_service_client.rb', line 4661

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:



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
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
 
# File 'lib/oci/jms/java_management_service_client.rb', line 4727

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



4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
 
# File 'lib/oci/jms/java_management_service_client.rb', line 4790

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:



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

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



4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
 
# File 'lib/oci/jms/java_management_service_client.rb', line 4925

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