com.oracle.bmc.fleetappsmanagement

Class FleetAppsManagementOperationsAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.fleetappsmanagement.FleetAppsManagementOperationsAsyncClient

All Implemented Interfaces:

FleetAppsManagementOperationsAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20230831")
public class FleetAppsManagementOperationsAsyncClient
extends BaseAsyncClient
implements FleetAppsManagementOperationsAsync

Async client implementation for FleetAppsManagementOperations service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
String	clientCommonLibraryVersion Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE Service instance for FleetAppsManagementOperations.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static FleetAppsManagementOperationsAsyncClient.Builder	builder() Create a builder for this client.
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>	clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
void	close()
Future<CreatePatchResponse>	createPatch(CreatePatchRequest request, AsyncHandler<CreatePatchRequest,CreatePatchResponse> handler) Creates a new Patch.
Future<CreateSchedulerDefinitionResponse>	createSchedulerDefinition(CreateSchedulerDefinitionRequest request, AsyncHandler<CreateSchedulerDefinitionRequest,CreateSchedulerDefinitionResponse> handler) Create a SchedulerDefinition to perform lifecycle operations.
Future<DeletePatchResponse>	deletePatch(DeletePatchRequest request, AsyncHandler<DeletePatchRequest,DeletePatchResponse> handler) Deletes a Patch resource by identifier
Future<DeleteSchedulerDefinitionResponse>	deleteSchedulerDefinition(DeleteSchedulerDefinitionRequest request, AsyncHandler<DeleteSchedulerDefinitionRequest,DeleteSchedulerDefinitionResponse> handler) Deletes a SchedulerDefinition resource by identifier
Future<DeleteSchedulerJobResponse>	deleteSchedulerJob(DeleteSchedulerJobRequest request, AsyncHandler<DeleteSchedulerJobRequest,DeleteSchedulerJobResponse> handler) Delete a lifecycle operation schedule in Fleet Application Management.
Future<ExportComplianceReportResponse>	exportComplianceReport(ExportComplianceReportRequest request, AsyncHandler<ExportComplianceReportRequest,ExportComplianceReportResponse> handler) Generate Compliance Report
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Future<GetExecutionResponse>	getExecution(GetExecutionRequest request, AsyncHandler<GetExecutionRequest,GetExecutionResponse> handler) Get Task Execution by Identifier for a Resource within an action group.
Future<GetJobActivityResponse>	getJobActivity(GetJobActivityRequest request, AsyncHandler<GetJobActivityRequest,GetJobActivityResponse> handler) Gets activity details by identifier for a job.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetPatchResponse>	getPatch(GetPatchRequest request, AsyncHandler<GetPatchRequest,GetPatchResponse> handler) Gets a Patch by identifier
Future<GetSchedulerDefinitionResponse>	getSchedulerDefinition(GetSchedulerDefinitionRequest request, AsyncHandler<GetSchedulerDefinitionRequest,GetSchedulerDefinitionResponse> handler) Get the details of a SchedulerDefinition that performs lifecycle management operations.
Future<GetSchedulerJobResponse>	getSchedulerJob(GetSchedulerJobRequest request, AsyncHandler<GetSchedulerJobRequest,GetSchedulerJobResponse> handler) Get the details of a lifecycle management operations job in Fleet Application Management.
Future<ListComplianceRecordsResponse>	listComplianceRecords(ListComplianceRecordsRequest request, AsyncHandler<ListComplianceRecordsRequest,ListComplianceRecordsResponse> handler) Gets a list of complianceDetails.
Future<ListExecutionsResponse>	listExecutions(ListExecutionsRequest request, AsyncHandler<ListExecutionsRequest,ListExecutionsResponse> handler) Returns a list of Task Executions for a Resource.
Future<ListPatchesResponse>	listPatches(ListPatchesRequest request, AsyncHandler<ListPatchesRequest,ListPatchesResponse> handler) Returns a list of Patches.
Future<ListResourcesResponse>	listResources(ListResourcesRequest request, AsyncHandler<ListResourcesRequest,ListResourcesResponse> handler) Returns a list of resources for an Activity Execution.
Future<ListScheduledFleetsResponse>	listScheduledFleets(ListScheduledFleetsRequest request, AsyncHandler<ListScheduledFleetsRequest,ListScheduledFleetsResponse> handler) Returns a list of ScheduledFleets.
Future<ListSchedulerDefinitionsResponse>	listSchedulerDefinitions(ListSchedulerDefinitionsRequest request, AsyncHandler<ListSchedulerDefinitionsRequest,ListSchedulerDefinitionsResponse> handler) List all lifecycle management schedules in Fleet Application Management.
Future<ListSchedulerJobsResponse>	listSchedulerJobs(ListSchedulerJobsRequest request, AsyncHandler<ListSchedulerJobsRequest,ListSchedulerJobsResponse> handler) List scheduled lifecycle operation jobs in Fleet Application Management.
Future<ListStepsResponse>	listSteps(ListStepsRequest request, AsyncHandler<ListStepsRequest,ListStepsResponse> handler) Returns a list of Steps for an Activity Execution.
Future<ManageJobExecutionResponse>	manageJobExecution(ManageJobExecutionRequest request, AsyncHandler<ManageJobExecutionRequest,ManageJobExecutionResponse> handler) Manage execution actions for a Job like retrying or pausing a task.
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.
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’).
Future<SummarizeComplianceRecordCountsResponse>	summarizeComplianceRecordCounts(SummarizeComplianceRecordCountsRequest request, AsyncHandler<SummarizeComplianceRecordCountsRequest,SummarizeComplianceRecordCountsResponse> handler) Retrieve aggregated summary information of ComplianceRecords within a Tenancy.
Future<SummarizeManagedEntityCountsResponse>	summarizeManagedEntityCounts(SummarizeManagedEntityCountsRequest request, AsyncHandler<SummarizeManagedEntityCountsRequest,SummarizeManagedEntityCountsResponse> handler) Retrieve aggregated summary information of Managed Entities within a Tenancy.
Future<SummarizeSchedulerJobCountsResponse>	summarizeSchedulerJobCounts(SummarizeSchedulerJobCountsRequest request, AsyncHandler<SummarizeSchedulerJobCountsRequest,SummarizeSchedulerJobCountsResponse> handler) Retrieve aggregated summary information of Scheduler Jobs within a Tenancy.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
Future<UpdatePatchResponse>	updatePatch(UpdatePatchRequest request, AsyncHandler<UpdatePatchRequest,UpdatePatchResponse> handler) Updates the Patch
Future<UpdateSchedulerDefinitionResponse>	updateSchedulerDefinition(UpdateSchedulerDefinitionRequest request, AsyncHandler<UpdateSchedulerDefinitionRequest,UpdateSchedulerDefinitionResponse> handler) Update the details of a SchedulerDefinition that performs lifecycle management operations.
Future<UpdateSchedulerJobResponse>	updateSchedulerJob(UpdateSchedulerJobRequest request, AsyncHandler<UpdateSchedulerJobRequest,UpdateSchedulerJobResponse> handler) Update a lifecycle operation job schedule in Fleet Application Management.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

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.fleetappsmanagement.FleetAppsManagementOperationsAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for FleetAppsManagementOperations.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

FleetAppsManagementOperationsAsyncClient

@Deprecated
public FleetAppsManagementOperationsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

FleetAppsManagementOperationsAsyncClient

@Deprecated
public FleetAppsManagementOperationsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                                            ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

FleetAppsManagementOperationsAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

FleetAppsManagementOperationsAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

FleetAppsManagementOperationsAsyncClient

@Deprecated
public FleetAppsManagementOperationsAsyncClient(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 FleetAppsManagementOperationsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

FleetAppsManagementOperationsAsyncClient

@Deprecated
public FleetAppsManagementOperationsAsyncClient(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 FleetAppsManagementOperationsAsyncClient.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)

FleetAppsManagementOperationsAsyncClient

@Deprecated
public FleetAppsManagementOperationsAsyncClient(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 FleetAppsManagementOperationsAsyncClient.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

Method Detail

builder

public static FleetAppsManagementOperationsAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: FleetAppsManagementOperationsAsync

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 FleetAppsManagementOperationsAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: FleetAppsManagementOperationsAsync

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 FleetAppsManagementOperationsAsync

Parameters:

regionId - The public region ID.

createPatch

public Future<CreatePatchResponse> createPatch(CreatePatchRequest request,
                                               AsyncHandler<CreatePatchRequest,CreatePatchResponse> handler)

Description copied from interface: FleetAppsManagementOperationsAsync

Creates a new Patch.

Specified by:

createPatch in interface FleetAppsManagementOperationsAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createSchedulerDefinition

public Future<CreateSchedulerDefinitionResponse> createSchedulerDefinition(CreateSchedulerDefinitionRequest request,
                                                                           AsyncHandler<CreateSchedulerDefinitionRequest,CreateSchedulerDefinitionResponse> handler)

Description copied from interface: FleetAppsManagementOperationsAsync

Create a SchedulerDefinition to perform lifecycle operations.

Specified by:

createSchedulerDefinition in interface FleetAppsManagementOperationsAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deletePatch

public Future<DeletePatchResponse> deletePatch(DeletePatchRequest request,
                                               AsyncHandler<DeletePatchRequest,DeletePatchResponse> handler)

Description copied from interface: FleetAppsManagementOperationsAsync

Deletes a Patch resource by identifier

Specified by:

deletePatch in interface FleetAppsManagementOperationsAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteSchedulerDefinition

public Future<DeleteSchedulerDefinitionResponse> deleteSchedulerDefinition(DeleteSchedulerDefinitionRequest request,
                                                                           AsyncHandler<DeleteSchedulerDefinitionRequest,DeleteSchedulerDefinitionResponse> handler)

Description copied from interface: FleetAppsManagementOperationsAsync

Deletes a SchedulerDefinition resource by identifier

Specified by:

deleteSchedulerDefinition in interface FleetAppsManagementOperationsAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteSchedulerJob

public Future<DeleteSchedulerJobResponse> deleteSchedulerJob(DeleteSchedulerJobRequest request,
                                                             AsyncHandler<DeleteSchedulerJobRequest,DeleteSchedulerJobResponse> handler)

Description copied from interface: FleetAppsManagementOperationsAsync

Delete a lifecycle operation schedule in Fleet Application Management.

Specified by:

deleteSchedulerJob in interface FleetAppsManagementOperationsAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

exportComplianceReport

public Future<ExportComplianceReportResponse> exportComplianceReport(ExportComplianceReportRequest request,
                                                                     AsyncHandler<ExportComplianceReportRequest,ExportComplianceReportResponse> handler)

Description copied from interface: FleetAppsManagementOperationsAsync

Generate Compliance Report

Specified by:

exportComplianceReport in interface FleetAppsManagementOperationsAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getExecution

public Future<GetExecutionResponse> getExecution(GetExecutionRequest request,
                                                 AsyncHandler<GetExecutionRequest,GetExecutionResponse> handler)

Description copied from interface: FleetAppsManagementOperationsAsync

Get Task Execution by Identifier for a Resource within an action group.

Specified by:

getExecution in interface FleetAppsManagementOperationsAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getJobActivity

public Future<GetJobActivityResponse> getJobActivity(GetJobActivityRequest request,
                                                     AsyncHandler<GetJobActivityRequest,GetJobActivityResponse> handler)

Description copied from interface: FleetAppsManagementOperationsAsync

Gets activity details by identifier for a job.

Specified by:

getJobActivity in interface FleetAppsManagementOperationsAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getPatch

public Future<GetPatchResponse> getPatch(GetPatchRequest request,
                                         AsyncHandler<GetPatchRequest,GetPatchResponse> handler)

Description copied from interface: FleetAppsManagementOperationsAsync

Gets a Patch by identifier

Specified by:

getPatch in interface FleetAppsManagementOperationsAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getSchedulerDefinition

public Future<GetSchedulerDefinitionResponse> getSchedulerDefinition(GetSchedulerDefinitionRequest request,
                                                                     AsyncHandler<GetSchedulerDefinitionRequest,GetSchedulerDefinitionResponse> handler)

Description copied from interface: FleetAppsManagementOperationsAsync

Get the details of a SchedulerDefinition that performs lifecycle management operations.

Specified by:

getSchedulerDefinition in interface FleetAppsManagementOperationsAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getSchedulerJob

public Future<GetSchedulerJobResponse> getSchedulerJob(GetSchedulerJobRequest request,
                                                       AsyncHandler<GetSchedulerJobRequest,GetSchedulerJobResponse> handler)

Description copied from interface: FleetAppsManagementOperationsAsync

Get the details of a lifecycle management operations job in Fleet Application Management.

Specified by:

getSchedulerJob in interface FleetAppsManagementOperationsAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listComplianceRecords

public Future<ListComplianceRecordsResponse> listComplianceRecords(ListComplianceRecordsRequest request,
                                                                   AsyncHandler<ListComplianceRecordsRequest,ListComplianceRecordsResponse> handler)

Description copied from interface: FleetAppsManagementOperationsAsync

Gets a list of complianceDetails.

Specified by:

listComplianceRecords in interface FleetAppsManagementOperationsAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listExecutions

public Future<ListExecutionsResponse> listExecutions(ListExecutionsRequest request,
                                                     AsyncHandler<ListExecutionsRequest,ListExecutionsResponse> handler)

Description copied from interface: FleetAppsManagementOperationsAsync

Returns a list of Task Executions for a Resource.

Specified by:

listExecutions in interface FleetAppsManagementOperationsAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listPatches

public Future<ListPatchesResponse> listPatches(ListPatchesRequest request,
                                               AsyncHandler<ListPatchesRequest,ListPatchesResponse> handler)

Description copied from interface: FleetAppsManagementOperationsAsync

Returns a list of Patches.

Specified by:

listPatches in interface FleetAppsManagementOperationsAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listResources

public Future<ListResourcesResponse> listResources(ListResourcesRequest request,
                                                   AsyncHandler<ListResourcesRequest,ListResourcesResponse> handler)

Description copied from interface: FleetAppsManagementOperationsAsync

Returns a list of resources for an Activity Execution.

Specified by:

listResources in interface FleetAppsManagementOperationsAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listScheduledFleets

public Future<ListScheduledFleetsResponse> listScheduledFleets(ListScheduledFleetsRequest request,
                                                               AsyncHandler<ListScheduledFleetsRequest,ListScheduledFleetsResponse> handler)

Description copied from interface: FleetAppsManagementOperationsAsync

Returns a list of ScheduledFleets.

Specified by:

listScheduledFleets in interface FleetAppsManagementOperationsAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listSchedulerDefinitions

public Future<ListSchedulerDefinitionsResponse> listSchedulerDefinitions(ListSchedulerDefinitionsRequest request,
                                                                         AsyncHandler<ListSchedulerDefinitionsRequest,ListSchedulerDefinitionsResponse> handler)

Description copied from interface: FleetAppsManagementOperationsAsync

List all lifecycle management schedules in Fleet Application Management.

Specified by:

listSchedulerDefinitions in interface FleetAppsManagementOperationsAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listSchedulerJobs

public Future<ListSchedulerJobsResponse> listSchedulerJobs(ListSchedulerJobsRequest request,
                                                           AsyncHandler<ListSchedulerJobsRequest,ListSchedulerJobsResponse> handler)

Description copied from interface: FleetAppsManagementOperationsAsync

List scheduled lifecycle operation jobs in Fleet Application Management.

Specified by:

listSchedulerJobs in interface FleetAppsManagementOperationsAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listSteps

public Future<ListStepsResponse> listSteps(ListStepsRequest request,
                                           AsyncHandler<ListStepsRequest,ListStepsResponse> handler)

Description copied from interface: FleetAppsManagementOperationsAsync

Returns a list of Steps for an Activity Execution.

Specified by:

listSteps in interface FleetAppsManagementOperationsAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

manageJobExecution

public Future<ManageJobExecutionResponse> manageJobExecution(ManageJobExecutionRequest request,
                                                             AsyncHandler<ManageJobExecutionRequest,ManageJobExecutionResponse> handler)

Description copied from interface: FleetAppsManagementOperationsAsync

Manage execution actions for a Job like retrying or pausing a task.

Specified by:

manageJobExecution in interface FleetAppsManagementOperationsAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

summarizeComplianceRecordCounts

public Future<SummarizeComplianceRecordCountsResponse> summarizeComplianceRecordCounts(SummarizeComplianceRecordCountsRequest request,
                                                                                       AsyncHandler<SummarizeComplianceRecordCountsRequest,SummarizeComplianceRecordCountsResponse> handler)

Description copied from interface: FleetAppsManagementOperationsAsync

Retrieve aggregated summary information of ComplianceRecords within a Tenancy.

Specified by:

summarizeComplianceRecordCounts in interface FleetAppsManagementOperationsAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

summarizeManagedEntityCounts

public Future<SummarizeManagedEntityCountsResponse> summarizeManagedEntityCounts(SummarizeManagedEntityCountsRequest request,
                                                                                 AsyncHandler<SummarizeManagedEntityCountsRequest,SummarizeManagedEntityCountsResponse> handler)

Description copied from interface: FleetAppsManagementOperationsAsync

Retrieve aggregated summary information of Managed Entities within a Tenancy.

Specified by:

summarizeManagedEntityCounts in interface FleetAppsManagementOperationsAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

summarizeSchedulerJobCounts

public Future<SummarizeSchedulerJobCountsResponse> summarizeSchedulerJobCounts(SummarizeSchedulerJobCountsRequest request,
                                                                               AsyncHandler<SummarizeSchedulerJobCountsRequest,SummarizeSchedulerJobCountsResponse> handler)

Description copied from interface: FleetAppsManagementOperationsAsync

Retrieve aggregated summary information of Scheduler Jobs within a Tenancy.

Specified by:

summarizeSchedulerJobCounts in interface FleetAppsManagementOperationsAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updatePatch

public Future<UpdatePatchResponse> updatePatch(UpdatePatchRequest request,
                                               AsyncHandler<UpdatePatchRequest,UpdatePatchResponse> handler)

Description copied from interface: FleetAppsManagementOperationsAsync

Updates the Patch

Specified by:

updatePatch in interface FleetAppsManagementOperationsAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateSchedulerDefinition

public Future<UpdateSchedulerDefinitionResponse> updateSchedulerDefinition(UpdateSchedulerDefinitionRequest request,
                                                                           AsyncHandler<UpdateSchedulerDefinitionRequest,UpdateSchedulerDefinitionResponse> handler)

Description copied from interface: FleetAppsManagementOperationsAsync

Update the details of a SchedulerDefinition that performs lifecycle management operations.

Specified by:

updateSchedulerDefinition in interface FleetAppsManagementOperationsAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateSchedulerJob

public Future<UpdateSchedulerJobResponse> updateSchedulerJob(UpdateSchedulerJobRequest request,
                                                             AsyncHandler<UpdateSchedulerJobRequest,UpdateSchedulerJobResponse> handler)

Description copied from interface: FleetAppsManagementOperationsAsync

Update a lifecycle operation job schedule in Fleet Application Management.

Specified by:

updateSchedulerJob in interface FleetAppsManagementOperationsAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

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

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()

clientCall

protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                           Supplier<RESP_BUILDER> responseBuilder)