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: 20250228") public class FleetAppsManagementOperationsAsyncClient extends BaseAsyncClient implements FleetAppsManagementOperationsAsyncAsync 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 anInputStream, 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 Description static classFleetAppsManagementOperationsAsyncClient.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 FleetAppsManagementOperations.
-
Constructor Summary
-
Method Summary
-
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.fleetappsmanagement.FleetAppsManagementOperationsAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
FleetAppsManagementOperationsAsyncClient
@Deprecated public FleetAppsManagementOperationsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeFleetAppsManagementOperationsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
FleetAppsManagementOperationsAsyncClient
@Deprecated public FleetAppsManagementOperationsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeFleetAppsManagementOperationsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
FleetAppsManagementOperationsAsyncClient
@Deprecated public FleetAppsManagementOperationsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeFleetAppsManagementOperationsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
FleetAppsManagementOperationsAsyncClient
@Deprecated public FleetAppsManagementOperationsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeFleetAppsManagementOperationsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeFleetAppsManagementOperationsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
FleetAppsManagementOperationsAsyncClient
@Deprecated public FleetAppsManagementOperationsAsyncClient(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 (seeFleetAppsManagementOperationsAsyncClient.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)
-
FleetAppsManagementOperationsAsyncClient
@Deprecated public FleetAppsManagementOperationsAsyncClient(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 (seeFleetAppsManagementOperationsAsyncClient.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
-
-
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:FleetAppsManagementOperationsAsyncSets 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 interfaceFleetAppsManagementOperationsAsync- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:FleetAppsManagementOperationsAsyncSets 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 interfaceFleetAppsManagementOperationsAsync- Parameters:
regionId- The public region ID.
-
changePatchCompartment
public Future<ChangePatchCompartmentResponse> changePatchCompartment(ChangePatchCompartmentRequest request, AsyncHandler<ChangePatchCompartmentRequest,ChangePatchCompartmentResponse> handler)
Description copied from interface:FleetAppsManagementOperationsAsyncMoves a Patch into a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changePatchCompartmentin interfaceFleetAppsManagementOperationsAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
createPatch
public Future<CreatePatchResponse> createPatch(CreatePatchRequest request, AsyncHandler<CreatePatchRequest,CreatePatchResponse> handler)
Description copied from interface:FleetAppsManagementOperationsAsyncCreates a new Patch.- Specified by:
createPatchin interfaceFleetAppsManagementOperationsAsync- Parameters:
request- The request object containing the details to sendhandler- 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:FleetAppsManagementOperationsAsyncCreate a SchedulerDefinition to perform lifecycle operations.- Specified by:
createSchedulerDefinitionin interfaceFleetAppsManagementOperationsAsync- Parameters:
request- The request object containing the details to sendhandler- 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:FleetAppsManagementOperationsAsyncDeletes the patch specified by identifier.- Specified by:
deletePatchin interfaceFleetAppsManagementOperationsAsync- Parameters:
request- The request object containing the details to sendhandler- 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:FleetAppsManagementOperationsAsyncDeletes a SchedulerDefinition resource by identifier- Specified by:
deleteSchedulerDefinitionin interfaceFleetAppsManagementOperationsAsync- Parameters:
request- The request object containing the details to sendhandler- 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:FleetAppsManagementOperationsAsyncDeletes the schedule job specified by an identifier.- Specified by:
deleteSchedulerJobin interfaceFleetAppsManagementOperationsAsync- Parameters:
request- The request object containing the details to sendhandler- 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:FleetAppsManagementOperationsAsyncGenerate Compliance Report- Specified by:
exportComplianceReportin interfaceFleetAppsManagementOperationsAsync- Parameters:
request- The request object containing the details to sendhandler- 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:FleetAppsManagementOperationsAsyncGet Task Execution by Identifier for a Resource within an action group.- Specified by:
getExecutionin interfaceFleetAppsManagementOperationsAsync- Parameters:
request- The request object containing the details to sendhandler- 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:FleetAppsManagementOperationsAsyncGets activity details by identifier for a job.- Specified by:
getJobActivityin interfaceFleetAppsManagementOperationsAsync- Parameters:
request- The request object containing the details to sendhandler- 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:FleetAppsManagementOperationsAsyncGets a Patch by identifier.- Specified by:
getPatchin interfaceFleetAppsManagementOperationsAsync- Parameters:
request- The request object containing the details to sendhandler- 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:FleetAppsManagementOperationsAsyncGet the details of a SchedulerDefinition that performs lifecycle management operations.- Specified by:
getSchedulerDefinitionin interfaceFleetAppsManagementOperationsAsync- Parameters:
request- The request object containing the details to sendhandler- 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:FleetAppsManagementOperationsAsyncGet the details of a lifecycle management operations job in Fleet Application Management.- Specified by:
getSchedulerJobin interfaceFleetAppsManagementOperationsAsync- Parameters:
request- The request object containing the details to sendhandler- 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:FleetAppsManagementOperationsAsyncGets a list of complianceDetails.- Specified by:
listComplianceRecordsin interfaceFleetAppsManagementOperationsAsync- Parameters:
request- The request object containing the details to sendhandler- 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:FleetAppsManagementOperationsAsyncReturns a list of Task Executions for a Resource.- Specified by:
listExecutionsin interfaceFleetAppsManagementOperationsAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
listInventoryRecords
public Future<ListInventoryRecordsResponse> listInventoryRecords(ListInventoryRecordsRequest request, AsyncHandler<ListInventoryRecordsRequest,ListInventoryRecordsResponse> handler)
Description copied from interface:FleetAppsManagementOperationsAsyncGets a list of inventoryDetails.- Specified by:
listInventoryRecordsin interfaceFleetAppsManagementOperationsAsync- Parameters:
request- The request object containing the details to sendhandler- 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:FleetAppsManagementOperationsAsyncReturns a list of all the Patches in the specified compartment.The query parameter
compartmentIdis required unless the query parameteridis specified.- Specified by:
listPatchesin interfaceFleetAppsManagementOperationsAsync- Parameters:
request- The request object containing the details to sendhandler- 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:FleetAppsManagementOperationsAsyncReturns a list of resources for an Activity Execution.- Specified by:
listResourcesin interfaceFleetAppsManagementOperationsAsync- Parameters:
request- The request object containing the details to sendhandler- 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:FleetAppsManagementOperationsAsyncReturns a list of ScheduledFleets.- Specified by:
listScheduledFleetsin interfaceFleetAppsManagementOperationsAsync- Parameters:
request- The request object containing the details to sendhandler- 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:FleetAppsManagementOperationsAsyncReturns a list of all the Schedule Definitions in the specified compartment.The query parameter
compartmentIdis required unless the query parameteridis specified.- Specified by:
listSchedulerDefinitionsin interfaceFleetAppsManagementOperationsAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
listSchedulerExecutions
public Future<ListSchedulerExecutionsResponse> listSchedulerExecutions(ListSchedulerExecutionsRequest request, AsyncHandler<ListSchedulerExecutionsRequest,ListSchedulerExecutionsResponse> handler)
Description copied from interface:FleetAppsManagementOperationsAsyncReturns a list of all Fleets that are scheduled.- Specified by:
listSchedulerExecutionsin interfaceFleetAppsManagementOperationsAsync- Parameters:
request- The request object containing the details to sendhandler- 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:FleetAppsManagementOperationsAsyncReturns a list of all schedule jobs in the specified compartment.The query parameter
compartmentIdis required unless the query parameteridis specified.- Specified by:
listSchedulerJobsin interfaceFleetAppsManagementOperationsAsync- Parameters:
request- The request object containing the details to sendhandler- 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:FleetAppsManagementOperationsAsyncReturns a list of Steps for an Activity Execution.- Specified by:
listStepsin interfaceFleetAppsManagementOperationsAsync- Parameters:
request- The request object containing the details to sendhandler- 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:FleetAppsManagementOperationsAsyncManage execution actions for a Job like retrying or pausing a task.- Specified by:
manageJobExecutionin interfaceFleetAppsManagementOperationsAsync- Parameters:
request- The request object containing the details to sendhandler- 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:FleetAppsManagementOperationsAsyncRetrieve aggregated summary information of ComplianceRecords within a Compartment.- Specified by:
summarizeComplianceRecordCountsin interfaceFleetAppsManagementOperationsAsync- Parameters:
request- The request object containing the details to sendhandler- 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:FleetAppsManagementOperationsAsyncRetrieve aggregated summary information of Managed entities within a Compartment.- Specified by:
summarizeManagedEntityCountsin interfaceFleetAppsManagementOperationsAsync- Parameters:
request- The request object containing the details to sendhandler- 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:FleetAppsManagementOperationsAsyncRetrieve aggregated summary information of Scheduler Jobs within a Compartment.- Specified by:
summarizeSchedulerJobCountsin interfaceFleetAppsManagementOperationsAsync- Parameters:
request- The request object containing the details to sendhandler- 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:FleetAppsManagementOperationsAsyncUpdates the patch specified by the identifier.- Specified by:
updatePatchin interfaceFleetAppsManagementOperationsAsync- Parameters:
request- The request object containing the details to sendhandler- 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:FleetAppsManagementOperationsAsyncUpdate the details of a SchedulerDefinition that performs lifecycle management operations.- Specified by:
updateSchedulerDefinitionin interfaceFleetAppsManagementOperationsAsync- Parameters:
request- The request object containing the details to sendhandler- 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:FleetAppsManagementOperationsAsyncUpdates certain attributes for the specified schedule job.- Specified by:
updateSchedulerJobin interfaceFleetAppsManagementOperationsAsync- Parameters:
request- The request object containing the details to sendhandler- 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()
-
enableDualStackEndpoints
public void enableDualStackEndpoints(boolean enableDualStackEndpoints)
This method should be used to enable or disable the use of dual-stack endpoints.The default value is false i.e. dual-stack endpoints are disabled by default.
- Parameters:
enableDualStackEndpoints- This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively
-
getOptionsMap
public Map<String,Boolean> getOptionsMap()
Return an immutable snapshot representing the current options set for this client.- Returns:
- immutable snapshot representing the current options set for this client
-
getResolvedEndpoint
public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)
Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.- Parameters:
requiredParametersMap- the map from required parameter name to their values- Returns:
- resolved endpoint, with all options and placeholders filled in
-
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
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
Get the endpoint of the client.Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a
Region.Examples of endpoints this may return:
- Unparameterized endpoints
https://identity.us-phoenix-1.oci.oraclecloud.com https://identity.us-ashburn-1.oci.oraclecloud.com https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with placeholders
https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with options
https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com - Parameterized endpoints with placeholders and options
https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
To get the actual endpoint for a parameterized request, you can use
BaseClient.getResolvedEndpoint(Map)orParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).- Returns:
- the endpoint being used by the client
- Unparameterized endpoints
-
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()
-
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)
-
-