Class: OCI::Jms::JavaManagementServiceClient

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

fleet_id (String) —

The OCID of the Fleet.
add_fleet_installation_sites_details (OCI::Jms::Models::AddFleetInstallationSitesDetails) —

List of installation sites to be added.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

# 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

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

fleet_id (String) —

The OCID of the Fleet.
change_fleet_compartment_details (OCI::Jms::Models::ChangeFleetCompartmentDetails) —

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

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

fleet_id (String) —

The OCID of the Fleet.
create_blocklist_details (OCI::Jms::Models::CreateBlocklistDetails) —

Details for the new 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
: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 Blocklist

# File 'lib/oci/jms/java_management_service_client.rb', line 320

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

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

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

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

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

  post_body = @api_client.object_to_http_body(create_blocklist_details)

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

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

Note:

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

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

Parameters:

fleet_id (String) —

The OCID of the Fleet.
create_drs_file_details (OCI::Jms::Models::CreateDrsFileDetails) —

Detail information to create 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

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

create_fleet_details (OCI::Jms::Models::CreateFleetDetails) —

Details for the new 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_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

# File 'lib/oci/jms/java_management_service_client.rb', line 461

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

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

  path = '/fleets'
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(create_fleet_details)

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

#create_jms_plugin(create_jms_plugin_details, opts = {}) ⇒ `Response`

Note:

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

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

Parameters:

create_jms_plugin_details (OCI::Jms::Models::CreateJmsPluginDetails) —

Details for the new JmsPlugin.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:opc_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 JmsPlugin

# File 'lib/oci/jms/java_management_service_client.rb', line 524

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

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

  path = '/jmsPlugins'
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(create_jms_plugin_details)

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

#create_task_schedule(create_task_schedule_details, opts = {}) ⇒ `Response`

Note:

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

Create a task schedule using the information provided.

Parameters:

create_task_schedule_details (OCI::Jms::Models::CreateTaskScheduleDetails) —

Details for the new task schedule.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.
:opc_retry_token (String) —

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

Returns:

(Response) —

A Response object with data of type TaskSchedule

# File 'lib/oci/jms/java_management_service_client.rb', line 585

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

  raise "Missing the required parameter 'create_task_schedule_details' when calling create_task_schedule." if create_task_schedule_details.nil?

  path = '/taskSchedules'
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(create_task_schedule_details)

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

# File 'lib/oci/jms/java_management_service_client.rb', line 647

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

# File 'lib/oci/jms/java_management_service_client.rb', line 710

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

# File 'lib/oci/jms/java_management_service_client.rb', line 774

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

# File 'lib/oci/jms/java_management_service_client.rb', line 836

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

# File 'lib/oci/jms/java_management_service_client.rb', line 897

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

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

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

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

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

  post_body = nil

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

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

Note:

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

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

Parameters:

jms_plugin_id (String) —

The OCID of the JmsPlugin.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.
:if_match (String) —

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

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/jms/java_management_service_client.rb', line 961

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

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

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

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

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

  post_body = nil

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

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

Note:

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

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

Parameters:

fleet_id (String) —

The OCID of the Fleet.
performance_tuning_analysis_result_id (String) —

The OCID of the performance tuning analysis result.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/jms/java_management_service_client.rb', line 1022

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

#delete_task_schedule(task_schedule_id, opts = {}) ⇒ `Response`

Note:

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

Deletes the task schedule record specified by an identifier.

Parameters:

task_schedule_id (String) —

The OCID to identify this task schedule.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

# File 'lib/oci/jms/java_management_service_client.rb', line 1085

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

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

  path = '/taskSchedules/{taskScheduleId}'.sub('{taskScheduleId}', task_schedule_id.to_s)
  operation_signing_strategy = :standard

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

  # 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_task_schedule') 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

# File 'lib/oci/jms/java_management_service_client.rb', line 1154

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

# File 'lib/oci/jms/java_management_service_client.rb', line 1225

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

# File 'lib/oci/jms/java_management_service_client.rb', line 1286

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

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

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

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

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

  post_body = @api_client.object_to_http_body(generate_agent_deploy_script_details)

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

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

Note:

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

Generates the agent installer configuration using the information provided.

Parameters:

generate_agent_installer_configuration_details (OCI::Jms::Models::GenerateAgentInstallerConfigurationDetails) —

Details that are used to generate the installer configuration 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

# File 'lib/oci/jms/java_management_service_client.rb', line 1388

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

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

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

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

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

  post_body = @api_client.object_to_http_body(generate_agent_installer_configuration_details)

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

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

Note:

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

Generates Load Pipeline Script

Parameters:

fleet_id (String) —

The OCID of the Fleet.
generate_load_pipeline_script_details (OCI::Jms::Models::GenerateLoadPipelineScriptDetails) —

Attributes to generate the load pipeline script.
opts (Hash) (defaults to: {}) —

the optional parameters
[Block] (Hash) —

a customizable set of options

Options Hash (opts):

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

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

The client request ID for tracing.
:response_target (String, IO) —

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

Returns:

(Response) —

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

# File 'lib/oci/jms/java_management_service_client.rb', line 1489

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

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

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

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

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

  post_body = @api_client.object_to_http_body(generate_load_pipeline_script_details)

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

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

Note:

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

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

Parameters:

fleet_id (String) —

The OCID of the Fleet.
crypto_analysis_result_id (String) —

The OCID of the analysis result.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type CryptoAnalysisResult

# File 'lib/oci/jms/java_management_service_client.rb', line 1589

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:

(Response) —

A Response object with data of type DrsFile

# File 'lib/oci/jms/java_management_service_client.rb', line 1647

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:

(Response) —

A Response object with data of type ExportSetting

# File 'lib/oci/jms/java_management_service_client.rb', line 1704

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:

(Response) —

A Response object with data of type ExportStatus

# File 'lib/oci/jms/java_management_service_client.rb', line 1758

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:

(Response) —

A Response object with data of type Fleet

# File 'lib/oci/jms/java_management_service_client.rb', line 1812

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:

(Response) —

A Response object with data of type FleetAdvancedFeatureConfiguration

# File 'lib/oci/jms/java_management_service_client.rb', line 1873

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:

(Response) —

A Response object with data of type FleetAgentConfiguration

# File 'lib/oci/jms/java_management_service_client.rb', line 1928

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:

(Response) —

A Response object with data of type JavaFamily

# File 'lib/oci/jms/java_management_service_client.rb', line 1983

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:

(Response) —

A Response object with data of type JavaMigrationAnalysisResult

# File 'lib/oci/jms/java_management_service_client.rb', line 2038

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:

(Response) —

A Response object with data of type JavaRelease

# File 'lib/oci/jms/java_management_service_client.rb', line 2094

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

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

  path = '/javaReleases/{releaseVersion}'.sub('{releaseVersion}', release_version.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

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

Note:

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

Returns the JmsPlugin.

Parameters:

jms_plugin_id (String) —

The OCID of the JmsPlugin.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type JmsPlugin

# File 'lib/oci/jms/java_management_service_client.rb', line 2148

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

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

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

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

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

  post_body = nil

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

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

Note:

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

Retrieve metadata of the Performance Tuning Analysis result.

Parameters:

fleet_id (String) —

The OCID of the Fleet.
performance_tuning_analysis_result_id (String) —

The OCID of the performance tuning analysis result.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type PerformanceTuningAnalysisResult

# File 'lib/oci/jms/java_management_service_client.rb', line 2203

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_task_schedule(task_schedule_id, opts = {}) ⇒ `Response`

Note:

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

Returns a task schedule.

Parameters:

task_schedule_id (String) —

The OCID to identify this task schedule.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The ID of the Fleet.
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type TaskSchedule

# File 'lib/oci/jms/java_management_service_client.rb', line 2261

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

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

  path = '/taskSchedules/{taskScheduleId}'.sub('{taskScheduleId}', task_schedule_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:fleetId] = opts[:fleet_id] if opts[:fleet_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#get_task_schedule') 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::TaskSchedule'
    )
  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:

(Response) —

A Response object with data of type WorkRequest

# File 'lib/oci/jms/java_management_service_client.rb', line 2316

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

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

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

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

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

  post_body = nil

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

#list_agent_installers(opts = {}) ⇒ `Response`

Note:

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

Returns a list of the agent installer information.

Parameters:

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

the optional parameters

Options Hash (opts):

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

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

The OCID of the compartment in which to list resources.
:fleet_id (String) —

The ID of the Fleet.
:platform_architecture (String) —

The platform architecture for the agent installer.
:os_family (String) —

The OS family for the agent installer.
:limit (Integer) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.
:sort_order (String) —

The sort order, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type AgentInstallerCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 2382

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


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

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

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

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

  path = '/agentInstallers'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:fleetId] = opts[:fleet_id] if opts[:fleet_id]
  query_params[:platformArchitecture] = opts[:platform_architecture] if opts[:platform_architecture]
  query_params[:osFamily] = opts[:os_family] if opts[:os_family]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

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

  post_body = nil

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

#list_announcements(opts = {}) ⇒ `Response`

Note:

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

Return a list of AnnouncementSummary items

Parameters:

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

the optional parameters

Options Hash (opts):

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

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

Filter the list with summary contains the given value.
:time_start (DateTime) —

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

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

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.
:sort_order (String) —

The sort order, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type AnnouncementCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 2467

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:

(Response) —

A Response object with data of type BlocklistCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 2544

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_containers(fleet_id, opts = {}) ⇒ `Response`

Note:

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

List containers 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.
:display_name (String) —

The display name.
:application_name (String) —

The name of the application.
:jre_version (String) —

The version of the related Java Runtime.
:jre_security_status (String) —

The security status of the Java Runtime.
:time_started_greater_than_or_equal_to (DateTime) —

If specified, only containers with a start time later than or equal to this parameter will be included in the response (formatted according to RFC3339).
:time_started_less_than_or_equal_to (DateTime) —

If specified, only containers with a start time earlier than or equal to this parameter will be included in the response (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 containers. Only one sort order can be provided. Default order for displayName, namespace, podName, applicationName, or jreVersion is ascending. Default order for timeStarted is descending. If no value is specified timeStarted is default. (default to timeStarted)
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ContainerCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 2631

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

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

  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[: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::CONTAINER_SORT_BY_ENUM.include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of the values in OCI::Jms::Models::CONTAINER_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}/containers'.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[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:applicationName] = opts[:application_name] if opts[:application_name]
  query_params[:jreVersion] = opts[:jre_version] if opts[:jre_version]
  query_params[:jreSecurityStatus] = opts[:jre_security_status] if opts[:jre_security_status]
  query_params[:timeStartedGreaterThanOrEqualTo] = opts[:time_started_greater_than_or_equal_to] if opts[:time_started_greater_than_or_equal_to]
  query_params[:timeStartedLessThanOrEqualTo] = opts[:time_started_less_than_or_equal_to] if opts[:time_started_less_than_or_equal_to]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_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_containers') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Jms::Models::ContainerCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists the results of a Crypto event analysis.

Parameters:

fleet_id (String) —

The OCID of the Fleet.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The aggregation mode of the crypto event analysis result. (default to managedInstance)
:managed_instance_id (String) —

The Fleet-unique identifier of the related managed instance.
:host_name (String) —

The host OCID of the managed instance. (default to hostName)
:non_compliant_finding_count (Integer) —

Non Compliant Finding Count of CryptoAnalysis Report.
:non_compliant_finding_count_greater_than (Integer) —

Non Compliant Finding Count of CryptoAnalysis Report.
:finding_count (Integer) —

FindingCount of CryptoAnalysis Report.
:finding_count_greater_than (Integer) —

FindingCount of CryptoAnalysis Report.
:time_start (DateTime) —

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

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

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.
:sort_order (String) —

The sort order, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type CryptoAnalysisResultCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 2725

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

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

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

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

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

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

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:aggregationMode] = opts[:aggregation_mode] if opts[:aggregation_mode]
  query_params[:managedInstanceId] = opts[:managed_instance_id] if opts[:managed_instance_id]
  query_params[:hostName] = opts[:host_name] if opts[:host_name]
  query_params[:nonCompliantFindingCount] = opts[:non_compliant_finding_count] if opts[:non_compliant_finding_count]
  query_params[:nonCompliantFindingCountGreaterThan] = opts[:non_compliant_finding_count_greater_than] if opts[:non_compliant_finding_count_greater_than]
  query_params[:findingCount] = opts[:finding_count] if opts[:finding_count]
  query_params[:findingCountGreaterThan] = opts[:finding_count_greater_than] if opts[:finding_count_greater_than]
  query_params[:timeStart] = opts[:time_start] if opts[:time_start]
  query_params[:timeEnd] = opts[:time_end] if opts[:time_end]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

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

  post_body = nil

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

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

Note:

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

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

Parameters:

fleet_id (String) —

The OCID of the Fleet.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.
:limit (Integer) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.
:sort_order (String) —

The sort order, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

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

Returns:

(Response) —

A Response object with data of type DrsFileCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 2811

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:

(Response) —

A Response object with data of type FleetDiagnosisCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 2880

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

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

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

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

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

  post_body = nil

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

#list_fleet_errors(opts = {}) ⇒ `Response`

Note:

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

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

Parameters:

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

the optional parameters

Options Hash (opts):

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

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

The OCID of the compartment in which to list resources.
:compartment_id_in_subtree (BOOLEAN) —

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

The ID of the Fleet.
:time_first_seen_less_than_or_equal_to (DateTime) —

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

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

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

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

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.
:sort_by (String) —

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

The sort order, either 'asc' or 'desc'. (default to ASC)
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type FleetErrorCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 2951

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


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

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

  path = '/fleetErrors'
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#list_fleets(opts = {}) ⇒ `Response`

Note:

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

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

Parameters:

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

the optional parameters

Options Hash (opts):

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

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

The OCID of the compartment in which to list resources.
:id (String) —

The ID.
:lifecycle_state (String) —

The state of the lifecycle.
:display_name (String) —

The display name.
:limit (Integer) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.
:sort_order (String) —

The sort order, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

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

The client request ID for tracing.
:display_name_contains (String) —

Filter the list with displayName contains the given value.

Returns:

(Response) —

A Response object with data of type FleetCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 3039

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:

(Response) —

A Response object with data of type InstallationSiteCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 3133

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:

(Response) —

A Response object with data of type JavaFamilyCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 3233

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


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

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

  path = '/javaFamilies'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:familyVersion] = opts[:family_version] if opts[:family_version]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:isSupportedVersion] = opts[:is_supported_version] if !opts[:is_supported_version].nil?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

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

  post_body = nil

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

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

Note:

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

Lists the results of a Java migration analysis.

Parameters:

fleet_id (String) —

The OCID of the Fleet.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The Fleet-unique identifier of the related managed instance.
:host_name (String) —

The host OCID of the managed instance. (default to hostName)
:application_name (String) —

The name of the application.
:time_start (DateTime) —

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

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

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.
:sort_order (String) —

The sort order, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type JavaMigrationAnalysisResultCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 3312

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

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

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

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

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

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:managedInstanceId] = opts[:managed_instance_id] if opts[:managed_instance_id]
  query_params[:hostName] = opts[:host_name] if opts[:host_name]
  query_params[:applicationName] = opts[:application_name] if opts[:application_name]
  query_params[:timeStart] = opts[:time_start] if opts[:time_start]
  query_params[:timeEnd] = opts[:time_end] if opts[:time_end]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

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

  post_body = nil

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

#list_java_releases(opts = {}) ⇒ `Response`

Note:

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

Returns a list of Java releases.

Parameters:

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

the optional parameters

Options Hash (opts):

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

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

Unique Java release version identifier
:family_version (String) —

The version identifier for the Java family.
:release_type (String) —

Java release type.
:jre_security_status (String) —

The security status of the Java Runtime.
:license_type (String) —

Java license type.
:limit (Integer) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.
:sort_order (String) —

The sort order, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

If no value is specified releaseDate is default. (default to releaseDate)
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type JavaReleaseCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 3393

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


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

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

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

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

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

  path = '/javaReleases'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:releaseVersion] = opts[:release_version] if opts[:release_version]
  query_params[:familyVersion] = opts[:family_version] if opts[:family_version]
  query_params[:releaseType] = opts[:release_type] if opts[:release_type]
  query_params[:jreSecurityStatus] = opts[:jre_security_status] if opts[:jre_security_status]
  query_params[:licenseType] = opts[:license_type] if opts[:license_type]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

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

  post_body = nil

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

#list_jms_plugins(opts = {}) ⇒ `Response`

Note:

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

Lists the JmsPlugins.

Parameters:

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

the optional parameters

Options Hash (opts):

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

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

The OCID of the compartment in which to list resources.
:compartment_id_in_subtree (BOOLEAN) —

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

The OCID of the JmsPlugin.
:fleet_id (String) —

The ID of the Fleet.
:agent_id (String) —

The ManagementAgent (OMA), Oracle Cloud Agent (OCA), or the Oracle Container Management Agent (OCMA) OCID that identifies the Agent.
:lifecycle_state (String) —

Filter JmsPlugin with its lifecycle state.
:availability_status (String) —

Filter JmsPlugin with its availability status.
:agent_type (String) —

Filter JmsPlugin with agent type.
:time_registered_less_than_or_equal_to (DateTime) —

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

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

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.
:sort_order (String) —

The sort order, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

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

Filter the list with hostname contains the given value.
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type JmsPluginCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 3496

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


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

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

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

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

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

  path = '/jmsPlugins'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:fleetId] = opts[:fleet_id] if opts[:fleet_id]
  query_params[:agentId] = opts[:agent_id] if opts[:agent_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:availabilityStatus] = opts[:availability_status] if opts[:availability_status]
  query_params[:agentType] = opts[:agent_type] if opts[:agent_type]
  query_params[:timeRegisteredLessThanOrEqualTo] = opts[:time_registered_less_than_or_equal_to] if opts[:time_registered_less_than_or_equal_to]
  query_params[:timeLastSeenLessThanOrEqualTo] = opts[:time_last_seen_less_than_or_equal_to] if opts[:time_last_seen_less_than_or_equal_to]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:hostnameContains] = opts[:hostname_contains] if opts[:hostname_contains]

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

  post_body = nil

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

#list_jre_usage(opts = {}) ⇒ `Response`

Note:

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

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

Parameters:

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

the optional parameters

Options Hash (opts):

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

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

The OCID of the compartment in which to list resources.
:host_id (String) —

The host OCID of the managed instance.
:application_id (String) —

The Fleet-unique identifier of the application.
:application_name (String) —

The name of the application.
:time_start (DateTime) —

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

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

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.
:sort_order (String) —

The sort order, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type JreUsageCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 3599

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_library_application_usage(fleet_id, library_key, opts = {}) ⇒ `Response`

Note:

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

List applications where a library has been detected filtered by query parameters.

Parameters:

fleet_id (String) —

The OCID of the Fleet.
library_key (String) —

The unique identifier of a Java library.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The Fleet-unique identifier of the managed instance.
:application_name (String) —

The name of the application.
:application_name_contains (String) —

Filter the list with application name 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_by (String) —

The field to sort library application usage summaries. Only one sort order may be provided. If no value is specified lastSeenInClasspath is default. (default to lastSeenInClasspath)
:sort_order (String) —

The sort order, either 'asc' or 'desc'. (default to ASC)
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type LibraryApplicationUsageCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 3684

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

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

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

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

  path = '/fleets/{fleetId}/libraries/{libraryKey}/applications'.sub('{fleetId}', fleet_id.to_s).sub('{libraryKey}', library_key.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[:managedInstanceId] = opts[:managed_instance_id] if opts[:managed_instance_id]
  query_params[:applicationName] = opts[:application_name] if opts[:application_name]
  query_params[:applicationNameContains] = opts[:application_name_contains] if opts[:application_name_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[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

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

  post_body = nil

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

#list_library_managed_instance_usage(fleet_id, library_key, opts = {}) ⇒ `Response`

Note:

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

List managed instances where a library has been detected, filtered by query parameters.

Parameters:

fleet_id (String) —

The OCID of the Fleet.
library_key (String) —

The unique identifier of a Java library.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The Fleet-unique identifier of the managed instance.
:host_name (String) —

The host OCID of the managed instance. (default to hostName)
:hostname_contains (String) —

Filter the list with hostname 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_by (String) —

The field to sort library application usage summaries. Only one sort order may be provided. If no value is specified lastSeenInClasspath is default. (default to lastSeenInClasspath)
:sort_order (String) —

The sort order, either 'asc' or 'desc'. (default to ASC)
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type LibraryManagedInstanceUsageCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 3773

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

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

  if opts[:sort_by] && !OCI::Jms::Models::LIBRARY_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::LIBRARY_MANAGED_INSTANCE_SORT_BY_ENUM.'
  end

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

  path = '/fleets/{fleetId}/libraries/{libraryKey}/managedInstances'.sub('{fleetId}', fleet_id.to_s).sub('{libraryKey}', library_key.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[:managedInstanceId] = opts[:managed_instance_id] if opts[:managed_instance_id]
  query_params[:hostName] = opts[:host_name] if opts[:host_name]
  query_params[:hostnameContains] = opts[:hostname_contains] if opts[:hostname_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[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

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

  post_body = nil

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

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

Note:

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

List Performance Tuning Analysis results.

Parameters:

fleet_id (String) —

The OCID of the Fleet.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The Fleet-unique identifier of the related managed instance.
:application_id (String) —

The Fleet-unique identifier of the related application.
:application_name (String) —

The name of the application.
:host_name (String) —

The host OCID of the managed instance. (default to hostName)
:time_start (DateTime) —

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

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

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.
:sort_order (String) —

The sort order, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type PerformanceTuningAnalysisResultCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 3861

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

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

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

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

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

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:managedInstanceId] = opts[:managed_instance_id] if opts[:managed_instance_id]
  query_params[:applicationId] = opts[:application_id] if opts[:application_id]
  query_params[:applicationName] = opts[:application_name] if opts[:application_name]
  query_params[:hostName] = opts[:host_name] if opts[:host_name]
  query_params[:timeStart] = opts[:time_start] if opts[:time_start]
  query_params[:timeEnd] = opts[:time_end] if opts[:time_end]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

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

  post_body = nil

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

#list_plugin_errors(opts = {}) ⇒ `Response`

Note:

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

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

Parameters:

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

the optional parameters

Options Hash (opts):

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

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

The OCID of the compartment in which to list resources.
:compartment_id_in_subtree (BOOLEAN) —

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

The Fleet-unique identifier of the managed instance.
:time_first_seen_less_than_or_equal_to (DateTime) —

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

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

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

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

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.
:sort_by (String) —

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

The sort order, either 'asc' or 'desc'. (default to ASC)
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type PluginErrorCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 3948

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


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

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

  path = '/pluginErrors'
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#list_task_schedules(opts = {}) ⇒ `Response`

Note:

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

Returns a list of task schedules.

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
:fleet_id (String) —

The ID of the Fleet.
:id (String) —

The OCID to identify this task schedule.
:managed_instance_id (String) —

The Fleet-unique identifier of the related managed instance.
:name (String) —

The task name.
:task_schedule_name_contains (String) —

Filter the list with task schedule name contains the given value.
: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 task schedule records. Only one sort order may be provided. Default order for timeCreated is ascending. If no value is specified, timeCreated is default. (default to timeCreated)
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type TaskScheduleCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 4032

def list_task_schedules(opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#list_task_schedules.' 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::TASK_SCHEDULE_SORT_BY_ENUM.include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of the values in OCI::Jms::Models::TASK_SCHEDULE_SORT_BY_ENUM.'
  end

  path = '/taskSchedules'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:fleetId] = opts[:fleet_id] if opts[:fleet_id]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:managedInstanceId] = opts[:managed_instance_id] if opts[:managed_instance_id]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:taskScheduleNameContains] = opts[:task_schedule_name_contains] if opts[:task_schedule_name_contains]
  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_task_schedules') 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::TaskScheduleCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_uncorrelated_package_application_usage(fleet_id, package_name, opts = {}) ⇒ `Response`

Note:

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

List applications where an uncorrelated package has been detected, filtered by query parameters.

Parameters:

fleet_id (String) —

The OCID of the Fleet.
package_name (String) —

The unique identifier of a Java package.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The Fleet-unique identifier of the managed instance.
: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_by (String) —

The field to sort detection events. Only one sort order may be provided. If no value is specified dynamicallyLastDetected is default. (default to dynamicallyLastDetected)
:sort_order (String) —

The sort order, either 'asc' or 'desc'. (default to ASC)
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type UncorrelatedPackageApplicationUsageCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 4113

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

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

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

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

  path = '/fleets/{fleetId}/uncorrelatedPackages/{packageName}/applications'.sub('{fleetId}', fleet_id.to_s).sub('{packageName}', package_name.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[:managedInstanceId] = opts[:managed_instance_id] if opts[:managed_instance_id]
  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[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

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

  post_body = nil

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

#list_uncorrelated_package_managed_instance_usage(fleet_id, package_name, opts = {}) ⇒ `Response`

Note:

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

List managed instances where an uncorrelated package has been detected, filtered by query parameters.

Parameters:

fleet_id (String) —

The OCID of the Fleet.
package_name (String) —

The unique identifier of a Java package.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The Fleet-unique identifier of the managed instance.
: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_by (String) —

The field to sort detection events. Only one sort order may be provided. If no value is specified dynamicallyLastDetected is default. (default to dynamicallyLastDetected)
:sort_order (String) —

The sort order, either 'asc' or 'desc'. (default to ASC)
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type UncorrelatedPackageManagedInstanceUsageCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 4197

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

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

  if opts[:sort_by] && !OCI::Jms::Models::UNCORRELATED_PACKAGE_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::UNCORRELATED_PACKAGE_MANAGED_INSTANCE_SORT_BY_ENUM.'
  end

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

  path = '/fleets/{fleetId}/uncorrelatedPackages/{packageName}/managedInstances'.sub('{fleetId}', fleet_id.to_s).sub('{packageName}', package_name.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[:managedInstanceId] = opts[:managed_instance_id] if opts[:managed_instance_id]
  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[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

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

  post_body = nil

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

#list_uncorrelated_package_usage(fleet_id, opts = {}) ⇒ `Response`

Note:

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

List uncorrelated package summaries in a fleet, filtered by query parameters. Uncorrelated packages are Java packages which can't be accurately correlated to a library during a library scan.

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
:package_name (String) —

The unique identifier of a Java package.
:managed_instance_id (String) —

The Fleet-unique identifier of the managed instance.
:application_id (String) —

The Fleet-unique identifier 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 Java packages. 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:

(Response) —

A Response object with data of type UncorrelatedPackageUsageCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 4281

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

  raise "Missing the required parameter 'fleet_id' when calling list_uncorrelated_package_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::PACKAGE_SORT_BY_ENUM.include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of the values in OCI::Jms::Models::PACKAGE_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}/uncorrelatedPackages'.sub('{fleetId}', fleet_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:packageName] = opts[:package_name] if opts[:package_name]
  query_params[:managedInstanceId] = opts[:managed_instance_id] if opts[:managed_instance_id]
  query_params[:applicationId] = opts[:application_id] if opts[:application_id]
  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_uncorrelated_package_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::UncorrelatedPackageUsageCollection'
    )
  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:

(Response) —

A Response object with data of type WorkItemCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 4355

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:

(Response) —

A Response object with data of type WorkRequestErrorCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 4414

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:

(Response) —

A Response object with data of type WorkRequestLogEntryCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 4473

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

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

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

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

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

  post_body = nil

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

#list_work_requests(opts = {}) ⇒ `Response`

Note:

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

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

Parameters:

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

the optional parameters

Options Hash (opts):

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

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

The OCID of the compartment in which to list resources.
:id (String) —

The ID of an asynchronous work request.
:fleet_id (String) —

The OCID of the fleet.
:opc_request_id (String) —

The client request ID for tracing.
:page (String) —

The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.
:limit (Integer) —

The maximum number of items to return. (default to 10)
:managed_instance_id (String) —

The Fleet-unique identifier of the managed instance.
:operation_type (String) —

The operation type of the work request.
:status (Array<String>) —

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

Returns:

(Response) —

A Response object with data of type WorkRequestCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 4539

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


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


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

  path = '/workRequests'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:fleetId] = opts[:fleet_id] if opts[:fleet_id]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:managedInstanceId] = opts[:managed_instance_id] if opts[:managed_instance_id]
  query_params[:operationType] = opts[:operation_type] if opts[:operation_type]
  query_params[:status] = OCI::ApiClient.build_collection_params(opts[:status], :multi) if opts[:status] && !opts[:status].empty?

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

  post_body = nil

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

#logger ⇒ `Logger`

Returns The logger for this client. May be nil.

Returns:

(Logger) —

The logger for this client. May be nil.



94
95
96

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

def logger
  @api_client.config.logger
end

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

Note:

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

Remove Java installation sites in a Fleet.

Parameters:

fleet_id (String) —

The OCID of the Fleet.
remove_fleet_installation_sites_details (OCI::Jms::Models::RemoveFleetInstallationSitesDetails) —

List of installation sites to be deleted.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

# File 'lib/oci/jms/java_management_service_client.rb', line 4626

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:

fleet_id (String) —

The OCID of the Fleet.
request_crypto_analyses_details (OCI::Jms::Models::RequestCryptoAnalysesDetails) —

Detail information to start Crypto Analyses
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

# File 'lib/oci/jms/java_management_service_client.rb', line 4685

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

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

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

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

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

  post_body = @api_client.object_to_http_body(request_crypto_analyses_details)

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

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

Note:

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

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

Parameters:

fleet_id (String) —

The OCID of the Fleet.
request_deployed_application_migration_analyses_details (OCI::Jms::Models::RequestDeployedApplicationMigrationAnalysesDetails) —

Detail information that starts the deployed Java migration analyses
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

# File 'lib/oci/jms/java_management_service_client.rb', line 4742

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

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

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

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

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

  post_body = @api_client.object_to_http_body(request_deployed_application_migration_analyses_details)

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

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

Note:

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

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

Parameters:

fleet_id (String) —

The OCID of the Fleet.
request_java_migration_analyses_details (OCI::Jms::Models::RequestJavaMigrationAnalysesDetails) —

Detail information that starts the Java migration analysis
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

# File 'lib/oci/jms/java_management_service_client.rb', line 4799

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:

fleet_id (String) —

The OCID of the Fleet.
request_jfr_recordings_details (OCI::Jms::Models::RequestJfrRecordingsDetails) —

Detail information to start JFR recordings.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

# File 'lib/oci/jms/java_management_service_client.rb', line 4855

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:

fleet_id (String) —

The OCID of the Fleet.
request_performance_tuning_analyses_details (OCI::Jms::Models::RequestPerformanceTuningAnalysesDetails) —

Detail information to start Performance Tuning Analyses
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

# File 'lib/oci/jms/java_management_service_client.rb', line 4912

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:

fleet_id (String) —

The OCID of the Fleet.
scan_java_server_usage_details (OCI::Jms::Models::ScanJavaServerUsageDetails) —

List of managed instances to be scanned.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

# File 'lib/oci/jms/java_management_service_client.rb', line 4979

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:

fleet_id (String) —

The OCID of the Fleet.
scan_library_usage_details (OCI::Jms::Models::ScanLibraryUsageDetails) —

List of managed instances to be scanned.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

# File 'lib/oci/jms/java_management_service_client.rb', line 5049

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:

(Response) —

A Response object with data of type ApplicationInstallationUsageSummaryCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 5134

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:

(Response) —

A Response object with data of type ApplicationUsageCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 5255

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:

(Response) —

A Response object with data of type DeployedApplicationInstallationUsageSummaryCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 5381

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:

(Response) —

A Response object with data of type DeployedApplicationUsageCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 5480

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

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

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

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

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

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:serverKey] = opts[:server_key] if opts[:server_key]
  query_params[:serverInstanceKey] = opts[:server_instance_key] if opts[:server_instance_key]
  query_params[:managedInstanceId] = opts[:managed_instance_id] if opts[:managed_instance_id]
  query_params[:libraryKey] = opts[:library_key] if opts[:library_key]
  query_params[:applicationKey] = opts[:application_key] if opts[:application_key]
  query_params[:applicationNameContains] = opts[:application_name_contains] if opts[:application_name_contains]
  query_params[:applicationName] = opts[:application_name] if opts[:application_name]
  query_params[:timeStart] = opts[:time_start] if opts[:time_start]
  query_params[:timeEnd] = opts[:time_end] if opts[:time_end]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

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

  post_body = nil

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

#summarize_fleet_errors(opts = {}) ⇒ `Response`

Note:

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

Returns a high level summary of FleetErrors.

Parameters:

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

the optional parameters

Options Hash (opts):

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

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

The OCID of the compartment in which to list resources.
:compartment_id_in_subtree (BOOLEAN) —

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

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type FleetErrorAggregationCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 5560

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


  path = '/fleetErrorAnalytics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

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

  post_body = nil

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

#summarize_installation_usage(fleet_id, opts = {}) ⇒ `Response`

Note:

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

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

Parameters:

fleet_id (String) —

The OCID of the Fleet.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The vendor of the related Java Runtime.
:jre_distribution (String) —

The distribution of the related Java Runtime.
:jre_version (String) —

The version of the related Java Runtime.
:installation_path (String) —

The file system path of the installation.
:application_id (String) —

The Fleet-unique identifier of the related application.
:managed_instance_id (String) —

The Fleet-unique identifier of the related managed instance.
:fields (Array<String>) —

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

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

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

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.
:sort_order (String) —

The sort order, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

The field to sort installation views. Only one sort order may be provided. Default order for timeFirstSeen, timeLastSeen, and jreVersion, approximateApplicationCount and approximateManagedInstanceCount is descending. Default order for jreDistribution and jreVendor is ascending. If no value is specified timeLastSeen is default. (default to timeLastSeen)
:opc_request_id (String) —

The client request ID for tracing.
:os_family (Array<String>) —

The operating system type. Allowed values are: LINUX, WINDOWS, MACOS, UNKNOWN
:path_contains (String) —

Filter the list with path contains the given value.
:jre_security_status (String) —

The security status of the Java Runtime.

Returns:

(Response) —

A Response object with data of type InstallationUsageCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 5642

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

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

(Response) —

A Response object with data of type JavaServerInstanceUsageCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 5766

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:

(Response) —

A Response object with data of type JavaServerUsageCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 5858

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:

(Response) —

A Response object with data of type JreUsageCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 5956

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_inventory(fleet_id, opts = {}) ⇒ `Response`

Note:

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

Retrieve the inventory of libraries in the specified fleet: Statically detected library count, Dynamically detected library count, Uncorrelated package count, High, Medium and Low severity library count.

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.
:application_id (String) —

The Fleet-unique identifier 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).
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type LibraryInventory

# File 'lib/oci/jms/java_management_service_client.rb', line 6062

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

  raise "Missing the required parameter 'fleet_id' when calling summarize_library_inventory." 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}/summarizeLibraryInventory'.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[: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_library_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::LibraryInventory'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_library_usage(fleet_id, opts = {}) ⇒ `Response`

Note:

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

List libraries in a fleet filtered by query parameters.

Parameters:

fleet_id (String) —

The OCID of the Fleet.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The Java Server instance key.
:managed_instance_id (String) —

The Fleet-unique identifier of the managed instance.
:application_key (String) —

The deployed application key.
:library_key (String) —

The library key.
:library_name_contains (String) —

Filter the list with library name contains the given value.
:library_name (String) —

The library name.
:cvss_score_greater_than (Float) —

Total Common Vulnerability Scoring System (CVSS) Score reported by the analysis.
:cvss_score_less_than (Float) —

Total Common Vulnerability Scoring System (CVSS) Score reported by the analysis.
:time_start (DateTime) —

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

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

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.
:sort_order (String) —

The sort order, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

The field to sort libraries. Only one sort order may be provided. If no value is specified timeLastSeen is default. (default to timeLastSeen)
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type LibraryUsageCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 6142

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

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

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

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

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

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:serverInstanceKey] = opts[:server_instance_key] if opts[:server_instance_key]
  query_params[:managedInstanceId] = opts[:managed_instance_id] if opts[:managed_instance_id]
  query_params[:applicationKey] = opts[:application_key] if opts[:application_key]
  query_params[:libraryKey] = opts[:library_key] if opts[:library_key]
  query_params[:libraryNameContains] = opts[:library_name_contains] if opts[:library_name_contains]
  query_params[:libraryName] = opts[:library_name] if opts[:library_name]
  query_params[:cvssScoreGreaterThan] = opts[:cvss_score_greater_than] if opts[:cvss_score_greater_than]
  query_params[:cvssScoreLessThan] = opts[:cvss_score_less_than] if opts[:cvss_score_less_than]
  query_params[:timeStart] = opts[:time_start] if opts[:time_start]
  query_params[:timeEnd] = opts[:time_end] if opts[:time_end]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

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

  post_body = nil

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

#summarize_managed_instance_usage(fleet_id, opts = {}) ⇒ `Response`

Note:

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

List managed instance usage in a Fleet filtered by query parameters.

Parameters:

fleet_id (String) —

The OCID of the Fleet.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The Fleet-unique identifier of the managed instance.
:managed_instance_type (String) —

The type of the managed instance.
:jre_vendor (String) —

The vendor of the related Java Runtime.
:jre_distribution (String) —

The distribution of the related Java Runtime.
:jre_version (String) —

The version of the related Java Runtime.
:installation_path (String) —

The file system path of the Java Runtime installation.
:application_id (String) —

The Fleet-unique identifier of the related application.
:fields (Array<String>) —

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

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

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

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.
:sort_order (String) —

The sort order, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

The field to sort managed instance views. Only one sort order may be provided. Default order for timeFirstSeen, timeLastSeen, approximateJreCount, approximateInstallationCount_ and approximateApplicationCount is descending. Default order for osName is ascending. If no value is specified timeLastSeen is default. (default to timeLastSeen)
:opc_request_id (String) —

The client request ID for tracing.
:os_family (Array<String>) —

The operating system type. Allowed values are: LINUX, WINDOWS, MACOS, UNKNOWN
:hostname_contains (String) —

Filter the list with hostname contains the given value.
:library_key (String) —

The library key.

Returns:

(Response) —

A Response object with data of type ManagedInstanceUsageCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 6247

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

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

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


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

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

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


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

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

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

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

  post_body = nil

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

#summarize_plugin_errors(opts = {}) ⇒ `Response`

Note:

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

Returns a high level summary of PluginErrors.

Parameters:

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

the optional parameters

Options Hash (opts):

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

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

The OCID of the compartment in which to list resources.
:compartment_id_in_subtree (BOOLEAN) —

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

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type PluginErrorAggregationCollection

# File 'lib/oci/jms/java_management_service_client.rb', line 6355

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


  path = '/pluginErrorAnalytics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

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

  post_body = nil

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

#summarize_resource_inventory(opts = {}) ⇒ `Response`

Note:

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

Retrieve the inventory of JMS resources in the specified compartment: a list of the number of active fleets, managed instances, Java Runtimes, Java installations, and applications.

Parameters:

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

the optional parameters

Options Hash (opts):

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

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

The OCID of the compartment in which to list resources.
:compartment_id_in_subtree (BOOLEAN) —

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

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ResourceInventory

# File 'lib/oci/jms/java_management_service_client.rb', line 6417

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


  path = '/summarizeResourceInventory'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:timeStart] = opts[:time_start] if opts[:time_start]
  query_params[:timeEnd] = opts[:time_end] if opts[:time_end]

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

  post_body = nil

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

#update_drs_file(fleet_id, update_drs_file_details, drs_file_key, opts = {}) ⇒ `Response`

Note:

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

Request to perform validation of the DRS file and update the existing file in the Object Storage.

Parameters:

fleet_id (String) —

The OCID of the Fleet.
update_drs_file_details (OCI::Jms::Models::UpdateDrsFileDetails) —

Detail information to update DRS
drs_file_key (String) —

The unique identifier of the DRS File in Object Storage.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.
:if_match (String) —

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

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

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/jms/java_management_service_client.rb', line 6488

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:

fleet_id (String) —

The OCID of the Fleet.
update_export_setting_details (OCI::Jms::Models::UpdateExportSettingDetails) —

The new details for the export setting.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

# File 'lib/oci/jms/java_management_service_client.rb', line 6554

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:

fleet_id (String) —

The OCID of the Fleet.
update_fleet_details (OCI::Jms::Models::UpdateFleetDetails) —

The new details for 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

# File 'lib/oci/jms/java_management_service_client.rb', line 6617

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:

fleet_id (String) —

The OCID of the Fleet.
update_fleet_advanced_feature_configuration_details (OCI::Jms::Models::UpdateFleetAdvancedFeatureConfigurationDetails) —

Update advanced feature configurations with new fields.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

(Response) —

A Response object with data of type FleetAdvancedFeatureConfiguration

# File 'lib/oci/jms/java_management_service_client.rb', line 6687

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:

fleet_id (String) —

The OCID of the Fleet.
update_fleet_agent_configuration_details (OCI::Jms::Models::UpdateFleetAgentConfigurationDetails) —

The new details for the Fleet Agent Configuration.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

# File 'lib/oci/jms/java_management_service_client.rb', line 6752

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

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

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

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

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

  post_body = @api_client.object_to_http_body(update_fleet_agent_configuration_details)

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

#update_jms_plugin(jms_plugin_id, update_jms_plugin_details, opts = {}) ⇒ `Response`

Note:

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

Updates the Fleet of a JmsPlugin.

Parameters:

jms_plugin_id (String) —

The OCID of the JmsPlugin.
update_jms_plugin_details (OCI::Jms::Models::UpdateJmsPluginDetails) —

The new details for the JmsPlugin.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type JmsPlugin

# File 'lib/oci/jms/java_management_service_client.rb', line 6814

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

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

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

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

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

  post_body = @api_client.object_to_http_body(update_jms_plugin_details)

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

#update_task_schedule(update_task_schedule_details, task_schedule_id, opts = {}) ⇒ `Response`

Note:

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

Update the task schedule for the given task type.

Parameters:

update_task_schedule_details (OCI::Jms::Models::UpdateTaskScheduleDetails) —

Update task schedule details for a given task.
task_schedule_id (String) —

The OCID to identify this task schedule.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

The client request ID for tracing.
:opc_retry_token (String) —

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

Returns:

(Response) —

A Response object with data of type TaskSchedule

# File 'lib/oci/jms/java_management_service_client.rb', line 6884

def update_task_schedule(update_task_schedule_details, task_schedule_id, opts = {})
  logger.debug 'Calling operation JavaManagementServiceClient#update_task_schedule.' if logger

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

  path = '/taskSchedules/{taskScheduleId}'.sub('{taskScheduleId}', task_schedule_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(update_task_schedule_details)

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

Overview

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

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

#endpoint ⇒ String (readonly)

#region ⇒ String

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

Instance Method Details

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

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

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

#create_blocklist(fleet_id, create_blocklist_details, opts = {}) ⇒ Response

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

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

#create_jms_plugin(create_jms_plugin_details, opts = {}) ⇒ Response

#create_task_schedule(create_task_schedule_details, opts = {}) ⇒ Response

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

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

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

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

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

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

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

#delete_task_schedule(task_schedule_id, opts = {}) ⇒ Response

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

#get_task_schedule(task_schedule_id, opts = {}) ⇒ Response

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

#list_agent_installers(opts = {}) ⇒ Response

#list_announcements(opts = {}) ⇒ Response

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

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

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

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

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

#list_fleet_errors(opts = {}) ⇒ Response

#list_fleets(opts = {}) ⇒ Response

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

#list_java_families(opts = {}) ⇒ Response

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

#list_java_releases(opts = {}) ⇒ Response

#list_jms_plugins(opts = {}) ⇒ Response

#list_jre_usage(opts = {}) ⇒ Response

#list_library_application_usage(fleet_id, library_key, opts = {}) ⇒ Response

#list_library_managed_instance_usage(fleet_id, library_key, opts = {}) ⇒ Response

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

#list_plugin_errors(opts = {}) ⇒ Response

#list_task_schedules(opts = {}) ⇒ Response

#list_uncorrelated_package_application_usage(fleet_id, package_name, opts = {}) ⇒ Response

#list_uncorrelated_package_managed_instance_usage(fleet_id, package_name, opts = {}) ⇒ Response

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

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

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

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

#list_work_requests(opts = {}) ⇒ Response

#logger ⇒ Logger

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

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

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

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

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

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

#api_client ⇒ `OCI::ApiClient` (readonly)

#endpoint ⇒ `String` (readonly)

#region ⇒ `String`

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

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

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

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

#create_blocklist(fleet_id, create_blocklist_details, opts = {}) ⇒ `Response`

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

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

#create_jms_plugin(create_jms_plugin_details, opts = {}) ⇒ `Response`

#create_task_schedule(create_task_schedule_details, opts = {}) ⇒ `Response`

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

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

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

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

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

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

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

#delete_task_schedule(task_schedule_id, opts = {}) ⇒ `Response`

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

#get_task_schedule(task_schedule_id, opts = {}) ⇒ `Response`

#get_work_request(work_request_id, opts = {}) ⇒ `Response`

#list_agent_installers(opts = {}) ⇒ `Response`

#list_announcements(opts = {}) ⇒ `Response`

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

#list_containers(fleet_id, opts = {}) ⇒ `Response`

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

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

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

#list_fleet_errors(opts = {}) ⇒ `Response`

#list_fleets(opts = {}) ⇒ `Response`

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

#list_java_families(opts = {}) ⇒ `Response`

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

#list_java_releases(opts = {}) ⇒ `Response`

#list_jms_plugins(opts = {}) ⇒ `Response`

#list_jre_usage(opts = {}) ⇒ `Response`

#list_library_application_usage(fleet_id, library_key, opts = {}) ⇒ `Response`

#list_library_managed_instance_usage(fleet_id, library_key, opts = {}) ⇒ `Response`

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

#list_plugin_errors(opts = {}) ⇒ `Response`

#list_task_schedules(opts = {}) ⇒ `Response`

#list_uncorrelated_package_application_usage(fleet_id, package_name, opts = {}) ⇒ `Response`

#list_uncorrelated_package_managed_instance_usage(fleet_id, package_name, opts = {}) ⇒ `Response`

#list_uncorrelated_package_usage(fleet_id, opts = {}) ⇒ `Response`

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

#list_work_request_errors(work_request_id, opts = {}) ⇒ `Response`

#list_work_request_logs(work_request_id, opts = {}) ⇒ `Response`

#list_work_requests(opts = {}) ⇒ `Response`

#logger ⇒ `Logger`

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

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

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

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

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

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

#scan_java_server_usage(fleet_id, scan_java_server_usage_details, opts = {}) ⇒ `Response`

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

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

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

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

#summarize_deployed_application_usage(fleet_id, opts = {}) ⇒ `Response`