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 Description static classJavaManagementServiceClient.BuilderBuilder class for this client.
-
Field Summary
Fields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for JavaManagementService.
-
Constructor Summary
Constructors Constructor Description JavaManagementServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.JavaManagementServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.JavaManagementServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.JavaManagementServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.JavaManagementServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.JavaManagementServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.JavaManagementServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.JavaManagementServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
-
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 java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.jms.JavaManagementService
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
JavaManagementServiceClient
@Deprecated public JavaManagementServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeJavaManagementServiceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
JavaManagementServiceClient
@Deprecated public JavaManagementServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeJavaManagementServiceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
JavaManagementServiceClient
@Deprecated public JavaManagementServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeJavaManagementServiceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
JavaManagementServiceClient
@Deprecated public JavaManagementServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeJavaManagementServiceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeJavaManagementServiceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
JavaManagementServiceClient
@Deprecated public JavaManagementServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeJavaManagementServiceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeJavaManagementServiceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeJavaManagementServiceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactoriesexecutorService-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:JavaManagementServiceSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.- Specified by:
setRegionin interfaceJavaManagementService- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:JavaManagementServiceSets 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 callsetEndpoint.- Specified by:
setRegionin interfaceJavaManagementService- Parameters:
regionId- The public region ID.
-
addFleetInstallationSites
public AddFleetInstallationSitesResponse addFleetInstallationSites(AddFleetInstallationSitesRequest request)
Description copied from interface:JavaManagementServiceAdd Java installation sites in a Fleet.- Specified by:
addFleetInstallationSitesin interfaceJavaManagementService- 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:JavaManagementServiceDeletes the work request specified by an identifier.- Specified by:
cancelWorkRequestin interfaceJavaManagementService- 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:JavaManagementServiceMove 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:
changeFleetCompartmentin interfaceJavaManagementService- 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:JavaManagementServiceAdd a new record to the fleet blocklist.- Specified by:
createBlocklistin interfaceJavaManagementService- 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:JavaManagementServiceRequest to perform validation of the DRS file and create the file to the Object Storage.- Specified by:
createDrsFilein interfaceJavaManagementService- 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:JavaManagementServiceCreate 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:
createFleetin interfaceJavaManagementService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createJmsPlugin
public CreateJmsPluginResponse createJmsPlugin(CreateJmsPluginRequest request)
Description copied from interface:JavaManagementServiceRegisters 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.
- Specified by:
createJmsPluginin interfaceJavaManagementService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createTaskSchedule
public CreateTaskScheduleResponse createTaskSchedule(CreateTaskScheduleRequest request)
Description copied from interface:JavaManagementServiceCreate a task schedule using the information provided.- Specified by:
createTaskSchedulein interfaceJavaManagementService- 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:JavaManagementServiceDeletes the blocklist record specified by an identifier.- Specified by:
deleteBlocklistin interfaceJavaManagementService- 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:JavaManagementServiceDeletes the metadata for the result of a Crypto event analysis.The actual report shall remain in the object storage.
- Specified by:
deleteCryptoAnalysisResultin interfaceJavaManagementService- 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:JavaManagementServiceRequest to delete the DRS file from the Object Storage.- Specified by:
deleteDrsFilein interfaceJavaManagementService- 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:JavaManagementServiceDeletes the Fleet specified by an identifier.- Specified by:
deleteFleetin interfaceJavaManagementService- 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:JavaManagementServiceDelete the Java migration analysis result.The actual report will remain in the Object Storage bucket.
- Specified by:
deleteJavaMigrationAnalysisResultin interfaceJavaManagementService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteJmsPlugin
public DeleteJmsPluginResponse deleteJmsPlugin(DeleteJmsPluginRequest request)
Description copied from interface:JavaManagementServiceDeletes 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.
- Specified by:
deleteJmsPluginin interfaceJavaManagementService- 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:JavaManagementServiceDeletes only the metadata of the Performance Tuning Analysis result, but the file remains in the object storage.- Specified by:
deletePerformanceTuningAnalysisResultin interfaceJavaManagementService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteTaskSchedule
public DeleteTaskScheduleResponse deleteTaskSchedule(DeleteTaskScheduleRequest request)
Description copied from interface:JavaManagementServiceDeletes the task schedule record specified by an identifier.- Specified by:
deleteTaskSchedulein interfaceJavaManagementService- 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:JavaManagementServiceRequest to disable the DRS in the selected target in the Fleet.- Specified by:
disableDrsin interfaceJavaManagementService- 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:JavaManagementServiceRequest to enable the DRS in the selected target in the Fleet.- Specified by:
enableDrsin interfaceJavaManagementService- 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:JavaManagementServiceGenerates Agent Deploy Script for Fleet using the information provided.- Specified by:
generateAgentDeployScriptin interfaceJavaManagementService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
generateAgentInstallerConfiguration
public GenerateAgentInstallerConfigurationResponse generateAgentInstallerConfiguration(GenerateAgentInstallerConfigurationRequest request)
Description copied from interface:JavaManagementServiceGenerates the agent installer configuration using the information provided.- Specified by:
generateAgentInstallerConfigurationin interfaceJavaManagementService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
generateLoadPipelineScript
public GenerateLoadPipelineScriptResponse generateLoadPipelineScript(GenerateLoadPipelineScriptRequest request)
Description copied from interface:JavaManagementServiceGenerates Load Pipeline Script- Specified by:
generateLoadPipelineScriptin interfaceJavaManagementService- 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:JavaManagementServiceRetrieve the metadata for the result of a Crypto event analysis.- Specified by:
getCryptoAnalysisResultin interfaceJavaManagementService- 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:JavaManagementServiceGet the detail about the created DRS file in the Fleet.- Specified by:
getDrsFilein interfaceJavaManagementService- 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:JavaManagementServiceReturns export setting for the specified fleet.- Specified by:
getExportSettingin interfaceJavaManagementService- 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:JavaManagementServiceReturns last export status for the specified fleet.- Specified by:
getExportStatusin interfaceJavaManagementService- 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:JavaManagementServiceRetrieve a Fleet with the specified identifier.- Specified by:
getFleetin interfaceJavaManagementService- 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:JavaManagementServiceReturns Fleet level advanced feature configuration.- Specified by:
getFleetAdvancedFeatureConfigurationin interfaceJavaManagementService- 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:JavaManagementServiceRetrieve a Fleet Agent Configuration for the specified Fleet.- Specified by:
getFleetAgentConfigurationin interfaceJavaManagementService- 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:JavaManagementServiceReturns metadata associated with a specific Java release family.- Specified by:
getJavaFamilyin interfaceJavaManagementService- 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:JavaManagementServiceRetrieve Java Migration Analysis result.- Specified by:
getJavaMigrationAnalysisResultin interfaceJavaManagementService- 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:JavaManagementServiceReturns detail of a Java release.- Specified by:
getJavaReleasein interfaceJavaManagementService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getJmsPlugin
public GetJmsPluginResponse getJmsPlugin(GetJmsPluginRequest request)
Description copied from interface:JavaManagementServiceReturns the JmsPlugin.- Specified by:
getJmsPluginin interfaceJavaManagementService- 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:JavaManagementServiceRetrieve metadata of the Performance Tuning Analysis result.- Specified by:
getPerformanceTuningAnalysisResultin interfaceJavaManagementService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getTaskSchedule
public GetTaskScheduleResponse getTaskSchedule(GetTaskScheduleRequest request)
Description copied from interface:JavaManagementServiceReturns a task schedule.- Specified by:
getTaskSchedulein interfaceJavaManagementService- 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:JavaManagementServiceRetrieve the details of a work request with the specified ID.- Specified by:
getWorkRequestin interfaceJavaManagementService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAgentInstallers
public ListAgentInstallersResponse listAgentInstallers(ListAgentInstallersRequest request)
Description copied from interface:JavaManagementServiceReturns a list of the agent installer information.- Specified by:
listAgentInstallersin interfaceJavaManagementService- 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:JavaManagementServiceReturn a list of AnnouncementSummary items- Specified by:
listAnnouncementsin interfaceJavaManagementService- 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:JavaManagementServiceReturns a list of blocklist entities contained by a fleet.- Specified by:
listBlocklistsin interfaceJavaManagementService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listContainers
public ListContainersResponse listContainers(ListContainersRequest request)
Description copied from interface:JavaManagementServiceList containers in a fleet filtered by query parameters.- Specified by:
listContainersin interfaceJavaManagementService- 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:JavaManagementServiceLists the results of a Crypto event analysis.- Specified by:
listCryptoAnalysisResultsin interfaceJavaManagementService- 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:JavaManagementServiceList the details about the created DRS files in the Fleet.- Specified by:
listDrsFilesin interfaceJavaManagementService- 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:JavaManagementServiceList potential diagnoses that would put a fleet into FAILED or NEEDS_ATTENTION lifecycle state.- Specified by:
listFleetDiagnosesin interfaceJavaManagementService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listFleetErrors
public ListFleetErrorsResponse listFleetErrors(ListFleetErrorsRequest request)
Description copied from interface:JavaManagementServiceReturns a list of fleet errors that describe all detected errors.- Specified by:
listFleetErrorsin interfaceJavaManagementService- 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:JavaManagementServiceReturns a list of all the Fleets contained by a compartment.The query parameter
compartmentIdis required unless the query parameteridis specified.- Specified by:
listFleetsin interfaceJavaManagementService- 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:JavaManagementServiceList Java installation sites in a Fleet filtered by query parameters.- Specified by:
listInstallationSitesin interfaceJavaManagementService- 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:JavaManagementServiceReturns a list of the Java release family information.A Java release family is typically a major version in the Java version identifier.
- Specified by:
listJavaFamiliesin interfaceJavaManagementService- 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:JavaManagementServiceLists the results of a Java migration analysis.- Specified by:
listJavaMigrationAnalysisResultsin interfaceJavaManagementService- 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:JavaManagementServiceReturns a list of Java releases.- Specified by:
listJavaReleasesin interfaceJavaManagementService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listJmsPlugins
public ListJmsPluginsResponse listJmsPlugins(ListJmsPluginsRequest request)
Description copied from interface:JavaManagementServiceLists the JmsPlugins.- Specified by:
listJmsPluginsin interfaceJavaManagementService- 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:JavaManagementServiceList Java Runtime usage in a specified host filtered by query parameters.- Specified by:
listJreUsagein interfaceJavaManagementService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listLibraryApplicationUsage
public ListLibraryApplicationUsageResponse listLibraryApplicationUsage(ListLibraryApplicationUsageRequest request)
Description copied from interface:JavaManagementServiceList applications where a library has been detected filtered by query parameters.- Specified by:
listLibraryApplicationUsagein interfaceJavaManagementService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listLibraryManagedInstanceUsage
public ListLibraryManagedInstanceUsageResponse listLibraryManagedInstanceUsage(ListLibraryManagedInstanceUsageRequest request)
Description copied from interface:JavaManagementServiceList managed instances where a library has been detected, filtered by query parameters.- Specified by:
listLibraryManagedInstanceUsagein interfaceJavaManagementService- 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:JavaManagementServiceList Performance Tuning Analysis results.- Specified by:
listPerformanceTuningAnalysisResultsin interfaceJavaManagementService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPluginErrors
public ListPluginErrorsResponse listPluginErrors(ListPluginErrorsRequest request)
Description copied from interface:JavaManagementServiceReturns a list of plugin errors that describe all detected errors.- Specified by:
listPluginErrorsin interfaceJavaManagementService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listTaskSchedules
public ListTaskSchedulesResponse listTaskSchedules(ListTaskSchedulesRequest request)
Description copied from interface:JavaManagementServiceReturns a list of task schedules.- Specified by:
listTaskSchedulesin interfaceJavaManagementService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listUncorrelatedPackageApplicationUsage
public ListUncorrelatedPackageApplicationUsageResponse listUncorrelatedPackageApplicationUsage(ListUncorrelatedPackageApplicationUsageRequest request)
Description copied from interface:JavaManagementServiceList applications where an uncorrelated package has been detected, filtered by query parameters.- Specified by:
listUncorrelatedPackageApplicationUsagein interfaceJavaManagementService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listUncorrelatedPackageManagedInstanceUsage
public ListUncorrelatedPackageManagedInstanceUsageResponse listUncorrelatedPackageManagedInstanceUsage(ListUncorrelatedPackageManagedInstanceUsageRequest request)
Description copied from interface:JavaManagementServiceList managed instances where an uncorrelated package has been detected, filtered by query parameters.- Specified by:
listUncorrelatedPackageManagedInstanceUsagein interfaceJavaManagementService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listUncorrelatedPackageUsage
public ListUncorrelatedPackageUsageResponse listUncorrelatedPackageUsage(ListUncorrelatedPackageUsageRequest request)
Description copied from interface:JavaManagementServiceList 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.
- Specified by:
listUncorrelatedPackageUsagein interfaceJavaManagementService- 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:JavaManagementServiceRetrieve a paginated list of work items for a specified work request.- Specified by:
listWorkItemsin interfaceJavaManagementService- 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:JavaManagementServiceRetrieve a (paginated) list of errors for a specified work request.- Specified by:
listWorkRequestErrorsin interfaceJavaManagementService- 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:JavaManagementServiceRetrieve a paginated list of logs for a specified work request.- Specified by:
listWorkRequestLogsin interfaceJavaManagementService- 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:JavaManagementServiceList the work requests in a compartment.The query parameter
compartmentIdis required unless the query parameteridorfleetIdis specified.- Specified by:
listWorkRequestsin interfaceJavaManagementService- 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:JavaManagementServiceRemove Java installation sites in a Fleet.- Specified by:
removeFleetInstallationSitesin interfaceJavaManagementService- 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:JavaManagementServiceRequest 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:
requestCryptoAnalysesin interfaceJavaManagementService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
requestDeployedApplicationMigrationAnalyses
public RequestDeployedApplicationMigrationAnalysesResponse requestDeployedApplicationMigrationAnalyses(RequestDeployedApplicationMigrationAnalysesRequest request)
Description copied from interface:JavaManagementServiceRequest 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.
- Specified by:
requestDeployedApplicationMigrationAnalysesin interfaceJavaManagementService- 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:JavaManagementServiceRequest 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:
requestJavaMigrationAnalysesin interfaceJavaManagementService- 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:JavaManagementServiceRequest 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:
requestJfrRecordingsin interfaceJavaManagementService- 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:JavaManagementServiceRequest 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:
requestPerformanceTuningAnalysesin interfaceJavaManagementService- 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:JavaManagementServiceScan Java Server usage in a fleet.- Specified by:
scanJavaServerUsagein interfaceJavaManagementService- 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:JavaManagementServiceScan library usage in a fleet.- Specified by:
scanLibraryUsagein interfaceJavaManagementService- 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:JavaManagementServiceSummarizes 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:
summarizeApplicationInstallationUsagein interfaceJavaManagementService- 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:JavaManagementServiceList application usage in a Fleet filtered by query parameters.- Specified by:
summarizeApplicationUsagein interfaceJavaManagementService- 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:JavaManagementServiceSummarize 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:
summarizeDeployedApplicationInstallationUsagein interfaceJavaManagementService- 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:JavaManagementServiceList of deployed applications in a Fleet filtered by query parameters.- Specified by:
summarizeDeployedApplicationUsagein interfaceJavaManagementService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
summarizeFleetErrors
public SummarizeFleetErrorsResponse summarizeFleetErrors(SummarizeFleetErrorsRequest request)
Description copied from interface:JavaManagementServiceReturns a high level summary of FleetErrors.- Specified by:
summarizeFleetErrorsin interfaceJavaManagementService- 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:JavaManagementServiceList Java installation usage in a Fleet filtered by query parameters.- Specified by:
summarizeInstallationUsagein interfaceJavaManagementService- 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:JavaManagementServiceList Java Server instances in a fleet filtered by query parameters.- Specified by:
summarizeJavaServerInstanceUsagein interfaceJavaManagementService- 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:JavaManagementServiceList of Java servers in a Fleet filtered by query parameters.- Specified by:
summarizeJavaServerUsagein interfaceJavaManagementService- 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:JavaManagementServiceList Java Runtime usage in a specified Fleet filtered by query parameters.- Specified by:
summarizeJreUsagein interfaceJavaManagementService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
summarizeLibraryInventory
public SummarizeLibraryInventoryResponse summarizeLibraryInventory(SummarizeLibraryInventoryRequest request)
Description copied from interface:JavaManagementServiceRetrieve 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.- Specified by:
summarizeLibraryInventoryin interfaceJavaManagementService- 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:JavaManagementServiceList libraries in a fleet filtered by query parameters.- Specified by:
summarizeLibraryUsagein interfaceJavaManagementService- 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:JavaManagementServiceList managed instance usage in a Fleet filtered by query parameters.- Specified by:
summarizeManagedInstanceUsagein interfaceJavaManagementService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
summarizePluginErrors
public SummarizePluginErrorsResponse summarizePluginErrors(SummarizePluginErrorsRequest request)
Description copied from interface:JavaManagementServiceReturns a high level summary of PluginErrors.- Specified by:
summarizePluginErrorsin interfaceJavaManagementService- 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:JavaManagementServiceRetrieve 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:
summarizeResourceInventoryin interfaceJavaManagementService- 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:JavaManagementServiceRequest to perform validation of the DRS file and update the existing file in the Object Storage.- Specified by:
updateDrsFilein interfaceJavaManagementService- 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:JavaManagementServiceUpdates existing export setting for the specified fleet.- Specified by:
updateExportSettingin interfaceJavaManagementService- 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:JavaManagementServiceUpdate the Fleet specified by an identifier.- Specified by:
updateFleetin interfaceJavaManagementService- 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:JavaManagementServiceUpdate 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:
updateFleetAdvancedFeatureConfigurationin interfaceJavaManagementService- 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:JavaManagementServiceUpdate the Fleet Agent Configuration for the specified Fleet.- Specified by:
updateFleetAgentConfigurationin interfaceJavaManagementService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateJmsPlugin
public UpdateJmsPluginResponse updateJmsPlugin(UpdateJmsPluginRequest request)
Description copied from interface:JavaManagementServiceUpdates the Fleet of a JmsPlugin.- Specified by:
updateJmsPluginin interfaceJavaManagementService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateTaskSchedule
public UpdateTaskScheduleResponse updateTaskSchedule(UpdateTaskScheduleRequest request)
Description copied from interface:JavaManagementServiceUpdate the task schedule for the given task type.- Specified by:
updateTaskSchedulein interfaceJavaManagementService- 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:JavaManagementServiceGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceJavaManagementService- Returns:
- The service waiters.
-
getPaginators
public JavaManagementServicePaginators getPaginators()
Description copied from interface:JavaManagementServiceGets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterableinterface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
getPaginatorsin interfaceJavaManagementService- 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 userequiredParametersMap- 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 backingHttpClient.This will call
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-