com.oracle.bmc.jms

Class JavaManagementServiceClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.jms.JavaManagementServiceClient

All Implemented Interfaces:

JavaManagementService, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210610")
public class JavaManagementServiceClient
extends BaseSyncClient
implements JavaManagementService

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JavaManagementServiceClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
static Service	SERVICE Service instance for JavaManagementService.

Constructor Summary

Constructors

Constructor and Description
JavaManagementServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
JavaManagementServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
JavaManagementServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
JavaManagementServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
JavaManagementServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Deprecated. Use the builder instead.
JavaManagementServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
JavaManagementServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
JavaManagementServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
AddFleetInstallationSitesResponse	addFleetInstallationSites(AddFleetInstallationSitesRequest request) Add Java installation sites in a Fleet.
static JavaManagementServiceClient.Builder	builder() Create a builder for this client.
CancelWorkRequestResponse	cancelWorkRequest(CancelWorkRequestRequest request) Deletes the work request specified by an identifier.
ChangeFleetCompartmentResponse	changeFleetCompartment(ChangeFleetCompartmentRequest request) Move a specified Fleet into the compartment identified in the POST form.
void	close()
CreateBlocklistResponse	createBlocklist(CreateBlocklistRequest request) Add a new record to the fleet blocklist.
CreateDrsFileResponse	createDrsFile(CreateDrsFileRequest request) Request to perform validaition of the DRS file and create the file to the Object Storage.
CreateFleetResponse	createFleet(CreateFleetRequest request) Create a new Fleet using the information provided.
DeleteBlocklistResponse	deleteBlocklist(DeleteBlocklistRequest request) Deletes the blocklist record specified by an identifier.
DeleteCryptoAnalysisResultResponse	deleteCryptoAnalysisResult(DeleteCryptoAnalysisResultRequest request) Deletes the metadata for the result of a Crypto event analysis.
DeleteDrsFileResponse	deleteDrsFile(DeleteDrsFileRequest request) Request to delete the DRS file from the Object Storage.
DeleteFleetResponse	deleteFleet(DeleteFleetRequest request) Deletes the Fleet specified by an identifier.
DeleteJavaMigrationAnalysisResultResponse	deleteJavaMigrationAnalysisResult(DeleteJavaMigrationAnalysisResultRequest request) Delete the Java migration analysis result.
DeletePerformanceTuningAnalysisResultResponse	deletePerformanceTuningAnalysisResult(DeletePerformanceTuningAnalysisResultRequest request) Deletes only the metadata of the Performance Tuning Analysis result, but the file remains in the object storage.
DisableDrsResponse	disableDrs(DisableDrsRequest request) Request to disable the DRS in the selected target in the Fleet.
EnableDrsResponse	enableDrs(EnableDrsRequest request) Request to enable the DRS in the selected target in the Fleet.
GenerateAgentDeployScriptResponse	generateAgentDeployScript(GenerateAgentDeployScriptRequest request) Generates Agent Deploy Script for Fleet using the information provided.
GetCryptoAnalysisResultResponse	getCryptoAnalysisResult(GetCryptoAnalysisResultRequest request) Retrieve the metadata for the result of a Crypto event analysis.
protected ClientConfigurator	getDefaultConfigurator()
GetDrsFileResponse	getDrsFile(GetDrsFileRequest request) Get the detail about the created DRS file in the Fleet.
String	getEndpoint()
GetExportSettingResponse	getExportSetting(GetExportSettingRequest request) Returns export setting for the specified Fleet.
GetExportStatusResponse	getExportStatus(GetExportStatusRequest request) Returns last export status for the specified Fleet.
GetFleetResponse	getFleet(GetFleetRequest request) Retrieve a Fleet with the specified identifier.
GetFleetAdvancedFeatureConfigurationResponse	getFleetAdvancedFeatureConfiguration(GetFleetAdvancedFeatureConfigurationRequest request) Returns Fleet level advanced feature configuration.
GetFleetAgentConfigurationResponse	getFleetAgentConfiguration(GetFleetAgentConfigurationRequest request) Retrieve a Fleet Agent Configuration for the specified Fleet.
GetJavaFamilyResponse	getJavaFamily(GetJavaFamilyRequest request) Returns metadata associated with a specific Java release family.
GetJavaMigrationAnalysisResultResponse	getJavaMigrationAnalysisResult(GetJavaMigrationAnalysisResultRequest request) Retrieve Java Migration Analysis result.
GetJavaReleaseResponse	getJavaRelease(GetJavaReleaseRequest request) Returns detail of a Java release.
JavaManagementServicePaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetPerformanceTuningAnalysisResultResponse	getPerformanceTuningAnalysisResult(GetPerformanceTuningAnalysisResultRequest request) Retrieve metadata of the Performance Tuning Analysis result.
JavaManagementServiceWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
GetWorkRequestResponse	getWorkRequest(GetWorkRequestRequest request) Retrieve the details of a work request with the specified ID.
ListAnnouncementsResponse	listAnnouncements(ListAnnouncementsRequest request) Return a list of AnnouncementSummary items
ListBlocklistsResponse	listBlocklists(ListBlocklistsRequest request) Returns a list of blocklist entities contained by a fleet.
ListCryptoAnalysisResultsResponse	listCryptoAnalysisResults(ListCryptoAnalysisResultsRequest request) Lists the results of a Crypto event analysis.
ListDrsFilesResponse	listDrsFiles(ListDrsFilesRequest request) List the details about the created DRS files in the Fleet.
ListFleetDiagnosesResponse	listFleetDiagnoses(ListFleetDiagnosesRequest request) List potential diagnoses that would put a fleet into FAILED or NEEDS_ATTENTION lifecycle state.
ListFleetsResponse	listFleets(ListFleetsRequest request) Returns a list of all the Fleets contained by a compartment.
ListInstallationSitesResponse	listInstallationSites(ListInstallationSitesRequest request) List Java installation sites in a Fleet filtered by query parameters.
ListJavaFamiliesResponse	listJavaFamilies(ListJavaFamiliesRequest request) Returns a list of the Java release family information.
ListJavaMigrationAnalysisResultsResponse	listJavaMigrationAnalysisResults(ListJavaMigrationAnalysisResultsRequest request) Lists the results of a Java migration analysis.
ListJavaReleasesResponse	listJavaReleases(ListJavaReleasesRequest request) Returns a list of Java releases.
ListJreUsageResponse	listJreUsage(ListJreUsageRequest request) List Java Runtime usage in a specified host filtered by query parameters.
ListPerformanceTuningAnalysisResultsResponse	listPerformanceTuningAnalysisResults(ListPerformanceTuningAnalysisResultsRequest request) List Performance Tuning Analysis results.
ListWorkItemsResponse	listWorkItems(ListWorkItemsRequest request) Retrieve a paginated list of work items for a specified work request.
ListWorkRequestErrorsResponse	listWorkRequestErrors(ListWorkRequestErrorsRequest request) Retrieve a (paginated) list of errors for a specified work request.
ListWorkRequestLogsResponse	listWorkRequestLogs(ListWorkRequestLogsRequest request) Retrieve a paginated list of logs for a specified work request.
ListWorkRequestsResponse	listWorkRequests(ListWorkRequestsRequest request) List the work requests in a compartment.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient() Rebuild the backing HttpClient.
RemoveFleetInstallationSitesResponse	removeFleetInstallationSites(RemoveFleetInstallationSitesRequest request) Remove Java installation sites in a Fleet.
RequestCryptoAnalysesResponse	requestCryptoAnalyses(RequestCryptoAnalysesRequest request) Request to perform crypto analysis on one or more selected targets in the Fleet.
RequestJavaMigrationAnalysesResponse	requestJavaMigrationAnalyses(RequestJavaMigrationAnalysesRequest request) Request to perform a Java migration analysis.
RequestJfrRecordingsResponse	requestJfrRecordings(RequestJfrRecordingsRequest request) Request to collect the JFR recordings on the selected target in the Fleet.
RequestPerformanceTuningAnalysesResponse	requestPerformanceTuningAnalyses(RequestPerformanceTuningAnalysesRequest request) Request to perform performance tuning analyses.
ScanJavaServerUsageResponse	scanJavaServerUsage(ScanJavaServerUsageRequest request) Scan Java Server usage in a fleet.
ScanLibraryUsageResponse	scanLibraryUsage(ScanLibraryUsageRequest request) Scan library usage in a fleet.
void	setEndpoint(String endpoint)
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
SummarizeApplicationInstallationUsageResponse	summarizeApplicationInstallationUsage(SummarizeApplicationInstallationUsageRequest request) Summarizes the application installation usage in a Fleet filtered by query parameters.
SummarizeApplicationUsageResponse	summarizeApplicationUsage(SummarizeApplicationUsageRequest request) List application usage in a Fleet filtered by query parameters.
SummarizeDeployedApplicationInstallationUsageResponse	summarizeDeployedApplicationInstallationUsage(SummarizeDeployedApplicationInstallationUsageRequest request) Summarize installation usage of an application deployed on Java servers in a fleet filtered by query parameters.
SummarizeDeployedApplicationUsageResponse	summarizeDeployedApplicationUsage(SummarizeDeployedApplicationUsageRequest request) List of deployed applications in a Fleet filtered by query parameters.
SummarizeInstallationUsageResponse	summarizeInstallationUsage(SummarizeInstallationUsageRequest request) List Java installation usage in a Fleet filtered by query parameters.
SummarizeJavaServerInstanceUsageResponse	summarizeJavaServerInstanceUsage(SummarizeJavaServerInstanceUsageRequest request) List Java Server instances in a fleet filtered by query parameters.
SummarizeJavaServerUsageResponse	summarizeJavaServerUsage(SummarizeJavaServerUsageRequest request) List of Java servers in a Fleet filtered by query parameters.
SummarizeJreUsageResponse	summarizeJreUsage(SummarizeJreUsageRequest request) List Java Runtime usage in a specified Fleet filtered by query parameters.
SummarizeLibraryUsageResponse	summarizeLibraryUsage(SummarizeLibraryUsageRequest request) List libraries in a fleet filtered by query parameters.
SummarizeManagedInstanceUsageResponse	summarizeManagedInstanceUsage(SummarizeManagedInstanceUsageRequest request) List managed instance usage in a Fleet filtered by query parameters.
SummarizeResourceInventoryResponse	summarizeResourceInventory(SummarizeResourceInventoryRequest request) 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.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
UpdateDrsFileResponse	updateDrsFile(UpdateDrsFileRequest request) Request to perform validaition of the DRS file and update the existing file in the Object Storage.
UpdateExportSettingResponse	updateExportSetting(UpdateExportSettingRequest request) Updates existing export setting for the specified Fleet.
UpdateFleetResponse	updateFleet(UpdateFleetRequest request) Update the Fleet specified by an identifier.
UpdateFleetAdvancedFeatureConfigurationResponse	updateFleetAdvancedFeatureConfiguration(UpdateFleetAdvancedFeatureConfigurationRequest request) Update advanced feature configurations for the Fleet.
UpdateFleetAgentConfigurationResponse	updateFleetAgentConfiguration(UpdateFleetAgentConfigurationRequest request) Update the Fleet Agent Configuration for the specified Fleet.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.jms.JavaManagementService

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for JavaManagementService.

Constructor Detail

JavaManagementServiceClient

@Deprecated
public JavaManagementServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see JavaManagementServiceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

JavaManagementServiceClient

@Deprecated
public JavaManagementServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                               ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see JavaManagementServiceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

JavaManagementServiceClient

@Deprecated
public JavaManagementServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                               ClientConfiguration configuration,
                                               ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see JavaManagementServiceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

JavaManagementServiceClient

@Deprecated
public JavaManagementServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                               ClientConfiguration configuration,
                                               ClientConfigurator clientConfigurator,
                                               RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see JavaManagementServiceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

JavaManagementServiceClient

@Deprecated
public JavaManagementServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                               ClientConfiguration configuration,
                                               ClientConfigurator clientConfigurator,
                                               RequestSignerFactory defaultRequestSignerFactory,
                                               List<ClientConfigurator> additionalClientConfigurators)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see JavaManagementServiceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

JavaManagementServiceClient

@Deprecated
public JavaManagementServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                               ClientConfiguration configuration,
                                               ClientConfigurator clientConfigurator,
                                               RequestSignerFactory defaultRequestSignerFactory,
                                               List<ClientConfigurator> additionalClientConfigurators,
                                               String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see JavaManagementServiceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

JavaManagementServiceClient

@Deprecated
public JavaManagementServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                               ClientConfiguration configuration,
                                               ClientConfigurator clientConfigurator,
                                               RequestSignerFactory defaultRequestSignerFactory,
                                               Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                               List<ClientConfigurator> additionalClientConfigurators,
                                               String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see JavaManagementServiceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

JavaManagementServiceClient

@Deprecated
public JavaManagementServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                               ClientConfiguration configuration,
                                               ClientConfigurator clientConfigurator,
                                               RequestSignerFactory defaultRequestSignerFactory,
                                               Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                               List<ClientConfigurator> additionalClientConfigurators,
                                               String endpoint,
                                               ExecutorService executorService)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see JavaManagementServiceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

executorService - JavaManagementServiceClient.Builder.executorService

Method Detail

builder

public static JavaManagementServiceClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: JavaManagementService

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

Specified by:

setRegion in interface JavaManagementService

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: JavaManagementService

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Specified by:

setRegion in interface JavaManagementService

Parameters:

regionId - The public region ID.

addFleetInstallationSites

public AddFleetInstallationSitesResponse addFleetInstallationSites(AddFleetInstallationSitesRequest request)

Description copied from interface: JavaManagementService

Add Java installation sites in a Fleet.

Specified by:

addFleetInstallationSites in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

cancelWorkRequest

public CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request)

Description copied from interface: JavaManagementService

Deletes the work request specified by an identifier.

Specified by:

cancelWorkRequest in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeFleetCompartment

public ChangeFleetCompartmentResponse changeFleetCompartment(ChangeFleetCompartmentRequest request)

Description copied from interface: JavaManagementService

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

Specified by:

changeFleetCompartment in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createBlocklist

public CreateBlocklistResponse createBlocklist(CreateBlocklistRequest request)

Description copied from interface: JavaManagementService

Add a new record to the fleet blocklist.

Specified by:

createBlocklist in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createDrsFile

public CreateDrsFileResponse createDrsFile(CreateDrsFileRequest request)

Description copied from interface: JavaManagementService

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

Specified by:

createDrsFile in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createFleet

public CreateFleetResponse createFleet(CreateFleetRequest request)

Description copied from interface: JavaManagementService

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](https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#JMS) for more details. Migrate existing fleets using the `UpdateFleet` API to set the `inventoryLog` parameter.

Specified by:

createFleet in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteBlocklist

public DeleteBlocklistResponse deleteBlocklist(DeleteBlocklistRequest request)

Description copied from interface: JavaManagementService

Deletes the blocklist record specified by an identifier.

Specified by:

deleteBlocklist in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteCryptoAnalysisResult

public DeleteCryptoAnalysisResultResponse deleteCryptoAnalysisResult(DeleteCryptoAnalysisResultRequest request)

Description copied from interface: JavaManagementService

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

Specified by:

deleteCryptoAnalysisResult in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteDrsFile

public DeleteDrsFileResponse deleteDrsFile(DeleteDrsFileRequest request)

Description copied from interface: JavaManagementService

Request to delete the DRS file from the Object Storage.

Specified by:

deleteDrsFile in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteFleet

public DeleteFleetResponse deleteFleet(DeleteFleetRequest request)

Description copied from interface: JavaManagementService

Deletes the Fleet specified by an identifier.

Specified by:

deleteFleet in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteJavaMigrationAnalysisResult

public DeleteJavaMigrationAnalysisResultResponse deleteJavaMigrationAnalysisResult(DeleteJavaMigrationAnalysisResultRequest request)

Description copied from interface: JavaManagementService

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

Specified by:

deleteJavaMigrationAnalysisResult in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deletePerformanceTuningAnalysisResult

public DeletePerformanceTuningAnalysisResultResponse deletePerformanceTuningAnalysisResult(DeletePerformanceTuningAnalysisResultRequest request)

Description copied from interface: JavaManagementService

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

Specified by:

deletePerformanceTuningAnalysisResult in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

disableDrs

public DisableDrsResponse disableDrs(DisableDrsRequest request)

Description copied from interface: JavaManagementService

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

Specified by:

disableDrs in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

enableDrs

public EnableDrsResponse enableDrs(EnableDrsRequest request)

Description copied from interface: JavaManagementService

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

Specified by:

enableDrs in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

generateAgentDeployScript

public GenerateAgentDeployScriptResponse generateAgentDeployScript(GenerateAgentDeployScriptRequest request)

Description copied from interface: JavaManagementService

Generates Agent Deploy Script for Fleet using the information provided.

Specified by:

generateAgentDeployScript in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getCryptoAnalysisResult

public GetCryptoAnalysisResultResponse getCryptoAnalysisResult(GetCryptoAnalysisResultRequest request)

Description copied from interface: JavaManagementService

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

Specified by:

getCryptoAnalysisResult in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getDrsFile

public GetDrsFileResponse getDrsFile(GetDrsFileRequest request)

Description copied from interface: JavaManagementService

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

Specified by:

getDrsFile in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getExportSetting

public GetExportSettingResponse getExportSetting(GetExportSettingRequest request)

Description copied from interface: JavaManagementService

Returns export setting for the specified Fleet.

Specified by:

getExportSetting in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getExportStatus

public GetExportStatusResponse getExportStatus(GetExportStatusRequest request)

Description copied from interface: JavaManagementService

Returns last export status for the specified Fleet.

Specified by:

getExportStatus in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getFleet

public GetFleetResponse getFleet(GetFleetRequest request)

Description copied from interface: JavaManagementService

Retrieve a Fleet with the specified identifier.

Specified by:

getFleet in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getFleetAdvancedFeatureConfiguration

public GetFleetAdvancedFeatureConfigurationResponse getFleetAdvancedFeatureConfiguration(GetFleetAdvancedFeatureConfigurationRequest request)

Description copied from interface: JavaManagementService

Returns Fleet level advanced feature configuration.

Specified by:

getFleetAdvancedFeatureConfiguration in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getFleetAgentConfiguration

public GetFleetAgentConfigurationResponse getFleetAgentConfiguration(GetFleetAgentConfigurationRequest request)

Description copied from interface: JavaManagementService

Retrieve a Fleet Agent Configuration for the specified Fleet.

Specified by:

getFleetAgentConfiguration in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getJavaFamily

public GetJavaFamilyResponse getJavaFamily(GetJavaFamilyRequest request)

Description copied from interface: JavaManagementService

Returns metadata associated with a specific Java release family.

Specified by:

getJavaFamily in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getJavaMigrationAnalysisResult

public GetJavaMigrationAnalysisResultResponse getJavaMigrationAnalysisResult(GetJavaMigrationAnalysisResultRequest request)

Description copied from interface: JavaManagementService

Retrieve Java Migration Analysis result.

Specified by:

getJavaMigrationAnalysisResult in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getJavaRelease

public GetJavaReleaseResponse getJavaRelease(GetJavaReleaseRequest request)

Description copied from interface: JavaManagementService

Returns detail of a Java release.

Specified by:

getJavaRelease in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getPerformanceTuningAnalysisResult

public GetPerformanceTuningAnalysisResultResponse getPerformanceTuningAnalysisResult(GetPerformanceTuningAnalysisResultRequest request)

Description copied from interface: JavaManagementService

Retrieve metadata of the Performance Tuning Analysis result.

Specified by:

getPerformanceTuningAnalysisResult in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWorkRequest

public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)

Description copied from interface: JavaManagementService

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

Specified by:

getWorkRequest in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listAnnouncements

public ListAnnouncementsResponse listAnnouncements(ListAnnouncementsRequest request)

Description copied from interface: JavaManagementService

Return a list of AnnouncementSummary items

Specified by:

listAnnouncements in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listBlocklists

public ListBlocklistsResponse listBlocklists(ListBlocklistsRequest request)

Description copied from interface: JavaManagementService

Returns a list of blocklist entities contained by a fleet.

Specified by:

listBlocklists in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listCryptoAnalysisResults

public ListCryptoAnalysisResultsResponse listCryptoAnalysisResults(ListCryptoAnalysisResultsRequest request)

Description copied from interface: JavaManagementService

Lists the results of a Crypto event analysis.

Specified by:

listCryptoAnalysisResults in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listDrsFiles

public ListDrsFilesResponse listDrsFiles(ListDrsFilesRequest request)

Description copied from interface: JavaManagementService

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

Specified by:

listDrsFiles in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listFleetDiagnoses

public ListFleetDiagnosesResponse listFleetDiagnoses(ListFleetDiagnosesRequest request)

Description copied from interface: JavaManagementService

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

Specified by:

listFleetDiagnoses in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listFleets

public ListFleetsResponse listFleets(ListFleetsRequest request)

Description copied from interface: JavaManagementService

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

Specified by:

listFleets in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listInstallationSites

public ListInstallationSitesResponse listInstallationSites(ListInstallationSitesRequest request)

Description copied from interface: JavaManagementService

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

Specified by:

listInstallationSites in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listJavaFamilies

public ListJavaFamiliesResponse listJavaFamilies(ListJavaFamiliesRequest request)

Description copied from interface: JavaManagementService

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

Specified by:

listJavaFamilies in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listJavaMigrationAnalysisResults

public ListJavaMigrationAnalysisResultsResponse listJavaMigrationAnalysisResults(ListJavaMigrationAnalysisResultsRequest request)

Description copied from interface: JavaManagementService

Lists the results of a Java migration analysis.

Specified by:

listJavaMigrationAnalysisResults in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listJavaReleases

public ListJavaReleasesResponse listJavaReleases(ListJavaReleasesRequest request)

Description copied from interface: JavaManagementService

Returns a list of Java releases.

Specified by:

listJavaReleases in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listJreUsage

public ListJreUsageResponse listJreUsage(ListJreUsageRequest request)

Description copied from interface: JavaManagementService

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

Specified by:

listJreUsage in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listPerformanceTuningAnalysisResults

public ListPerformanceTuningAnalysisResultsResponse listPerformanceTuningAnalysisResults(ListPerformanceTuningAnalysisResultsRequest request)

Description copied from interface: JavaManagementService

List Performance Tuning Analysis results.

Specified by:

listPerformanceTuningAnalysisResults in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkItems

public ListWorkItemsResponse listWorkItems(ListWorkItemsRequest request)

Description copied from interface: JavaManagementService

Retrieve a paginated list of work items for a specified work request.

Specified by:

listWorkItems in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestErrors

public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)

Description copied from interface: JavaManagementService

Retrieve a (paginated) list of errors for a specified work request.

Specified by:

listWorkRequestErrors in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestLogs

public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)

Description copied from interface: JavaManagementService

Retrieve a paginated list of logs for a specified work request.

Specified by:

listWorkRequestLogs in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequests

public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)

Description copied from interface: JavaManagementService

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

Specified by:

listWorkRequests in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

removeFleetInstallationSites

public RemoveFleetInstallationSitesResponse removeFleetInstallationSites(RemoveFleetInstallationSitesRequest request)

Description copied from interface: JavaManagementService

Remove Java installation sites in a Fleet.

Specified by:

removeFleetInstallationSites in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

requestCryptoAnalyses

public RequestCryptoAnalysesResponse requestCryptoAnalyses(RequestCryptoAnalysesRequest request)

Description copied from interface: JavaManagementService

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.

Specified by:

requestCryptoAnalyses in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

requestJavaMigrationAnalyses

public RequestJavaMigrationAnalysesResponse requestJavaMigrationAnalyses(RequestJavaMigrationAnalysesRequest request)

Description copied from interface: JavaManagementService

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.

Specified by:

requestJavaMigrationAnalyses in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

requestJfrRecordings

public RequestJfrRecordingsResponse requestJfrRecordings(RequestJfrRecordingsRequest request)

Description copied from interface: JavaManagementService

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.

Specified by:

requestJfrRecordings in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

requestPerformanceTuningAnalyses

public RequestPerformanceTuningAnalysesResponse requestPerformanceTuningAnalyses(RequestPerformanceTuningAnalysesRequest request)

Description copied from interface: JavaManagementService

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.

Specified by:

requestPerformanceTuningAnalyses in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

scanJavaServerUsage

public ScanJavaServerUsageResponse scanJavaServerUsage(ScanJavaServerUsageRequest request)

Description copied from interface: JavaManagementService

Scan Java Server usage in a fleet.

Specified by:

scanJavaServerUsage in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

scanLibraryUsage

public ScanLibraryUsageResponse scanLibraryUsage(ScanLibraryUsageRequest request)

Description copied from interface: JavaManagementService

Scan library usage in a fleet.

Specified by:

scanLibraryUsage in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

summarizeApplicationInstallationUsage

public SummarizeApplicationInstallationUsageResponse summarizeApplicationInstallationUsage(SummarizeApplicationInstallationUsageRequest request)

Description copied from interface: JavaManagementService

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.

Specified by:

summarizeApplicationInstallationUsage in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

summarizeApplicationUsage

public SummarizeApplicationUsageResponse summarizeApplicationUsage(SummarizeApplicationUsageRequest request)

Description copied from interface: JavaManagementService

List application usage in a Fleet filtered by query parameters.

Specified by:

summarizeApplicationUsage in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

summarizeDeployedApplicationInstallationUsage

public SummarizeDeployedApplicationInstallationUsageResponse summarizeDeployedApplicationInstallationUsage(SummarizeDeployedApplicationInstallationUsageRequest request)

Description copied from interface: JavaManagementService

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.

Specified by:

summarizeDeployedApplicationInstallationUsage in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

summarizeDeployedApplicationUsage

public SummarizeDeployedApplicationUsageResponse summarizeDeployedApplicationUsage(SummarizeDeployedApplicationUsageRequest request)

Description copied from interface: JavaManagementService

List of deployed applications in a Fleet filtered by query parameters.

Specified by:

summarizeDeployedApplicationUsage in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

summarizeInstallationUsage

public SummarizeInstallationUsageResponse summarizeInstallationUsage(SummarizeInstallationUsageRequest request)

Description copied from interface: JavaManagementService

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

Specified by:

summarizeInstallationUsage in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

summarizeJavaServerInstanceUsage

public SummarizeJavaServerInstanceUsageResponse summarizeJavaServerInstanceUsage(SummarizeJavaServerInstanceUsageRequest request)

Description copied from interface: JavaManagementService

List Java Server instances in a fleet filtered by query parameters.

Specified by:

summarizeJavaServerInstanceUsage in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

summarizeJavaServerUsage

public SummarizeJavaServerUsageResponse summarizeJavaServerUsage(SummarizeJavaServerUsageRequest request)

Description copied from interface: JavaManagementService

List of Java servers in a Fleet filtered by query parameters.

Specified by:

summarizeJavaServerUsage in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

summarizeJreUsage

public SummarizeJreUsageResponse summarizeJreUsage(SummarizeJreUsageRequest request)

Description copied from interface: JavaManagementService

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

Specified by:

summarizeJreUsage in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

summarizeLibraryUsage

public SummarizeLibraryUsageResponse summarizeLibraryUsage(SummarizeLibraryUsageRequest request)

Description copied from interface: JavaManagementService

List libraries in a fleet filtered by query parameters.

Specified by:

summarizeLibraryUsage in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

summarizeManagedInstanceUsage

public SummarizeManagedInstanceUsageResponse summarizeManagedInstanceUsage(SummarizeManagedInstanceUsageRequest request)

Description copied from interface: JavaManagementService

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

Specified by:

summarizeManagedInstanceUsage in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

summarizeResourceInventory

public SummarizeResourceInventoryResponse summarizeResourceInventory(SummarizeResourceInventoryRequest request)

Description copied from interface: JavaManagementService

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.

Specified by:

summarizeResourceInventory in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateDrsFile

public UpdateDrsFileResponse updateDrsFile(UpdateDrsFileRequest request)

Description copied from interface: JavaManagementService

Request to perform validaition of the DRS file and update the existing file in the Object Storage.

Specified by:

updateDrsFile in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateExportSetting

public UpdateExportSettingResponse updateExportSetting(UpdateExportSettingRequest request)

Description copied from interface: JavaManagementService

Updates existing export setting for the specified Fleet.

Specified by:

updateExportSetting in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateFleet

public UpdateFleetResponse updateFleet(UpdateFleetRequest request)

Description copied from interface: JavaManagementService

Update the Fleet specified by an identifier.

Specified by:

updateFleet in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateFleetAdvancedFeatureConfiguration

public UpdateFleetAdvancedFeatureConfigurationResponse updateFleetAdvancedFeatureConfiguration(UpdateFleetAdvancedFeatureConfigurationRequest request)

Description copied from interface: JavaManagementService

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.

Specified by:

updateFleetAdvancedFeatureConfiguration in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateFleetAgentConfiguration

public UpdateFleetAgentConfigurationResponse updateFleetAgentConfiguration(UpdateFleetAgentConfigurationRequest request)

Description copied from interface: JavaManagementService

Update the Fleet Agent Configuration for the specified Fleet.

Specified by:

updateFleetAgentConfiguration in interface JavaManagementService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public JavaManagementServiceWaiters getWaiters()

Description copied from interface: JavaManagementService

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface JavaManagementService

Returns:

The service waiters.

getPaginators

public JavaManagementServicePaginators getPaginators()

Description copied from interface: JavaManagementService

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Specified by:

getPaginators in interface JavaManagementService

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template. The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint. The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only. This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable