Package com.oracle.bmc.fleetappsmanagement

Class FleetAppsManagementRunbooksAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.fleetappsmanagement.FleetAppsManagementRunbooksAsyncClient

All Implemented Interfaces:

FleetAppsManagementRunbooksAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20250228")
public class FleetAppsManagementRunbooksAsyncClient
extends BaseAsyncClient
implements FleetAppsManagementRunbooksAsync

Async client implementation for FleetAppsManagementRunbooks 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	Description
static class	FleetAppsManagementRunbooksAsyncClient.Builder	Builder class for this client.

Field Summary

Fields

Modifier and Type	Field	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 FleetAppsManagementRunbooks.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static FleetAppsManagementRunbooksAsyncClient.Builder	builder()	Create a builder for this client.
Future<ChangeRunbookCompartmentResponse>	changeRunbookCompartment(ChangeRunbookCompartmentRequest request, AsyncHandler<ChangeRunbookCompartmentRequest,ChangeRunbookCompartmentResponse> handler)	Moves a Runbook into a different compartment within the same tenancy.
Future<ChangeTaskRecordCompartmentResponse>	changeTaskRecordCompartment(ChangeTaskRecordCompartmentRequest request, AsyncHandler<ChangeTaskRecordCompartmentRequest,ChangeTaskRecordCompartmentResponse> handler)	Moves a task record into a different compartment within the same tenancy.
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<CreateRunbookResponse>	createRunbook(CreateRunbookRequest request, AsyncHandler<CreateRunbookRequest,CreateRunbookResponse> handler)	Creates a runbook.
Future<CreateRunbookVersionResponse>	createRunbookVersion(CreateRunbookVersionRequest request, AsyncHandler<CreateRunbookVersionRequest,CreateRunbookVersionResponse> handler)	Add RunbookVersion in Fleet Application Management.
Future<CreateTaskRecordResponse>	createTaskRecord(CreateTaskRecordRequest request, AsyncHandler<CreateTaskRecordRequest,CreateTaskRecordResponse> handler)	Creates a new task record.
Future<DeleteRunbookResponse>	deleteRunbook(DeleteRunbookRequest request, AsyncHandler<DeleteRunbookRequest,DeleteRunbookResponse> handler)	Deletes a runbook specified by the identifier.
Future<DeleteRunbookVersionResponse>	deleteRunbookVersion(DeleteRunbookVersionRequest request, AsyncHandler<DeleteRunbookVersionRequest,DeleteRunbookVersionResponse> handler)	Removes a Runbook Version from the runbook in Fleet Application Management.
Future<DeleteTaskRecordResponse>	deleteTaskRecord(DeleteTaskRecordRequest request, AsyncHandler<DeleteTaskRecordRequest,DeleteTaskRecordResponse> handler)	Deletes the task record specified by an identifier.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetRunbookResponse>	getRunbook(GetRunbookRequest request, AsyncHandler<GetRunbookRequest,GetRunbookResponse> handler)	Get the details of a runbook in Fleet Application Management.
Future<GetRunbookVersionResponse>	getRunbookVersion(GetRunbookVersionRequest request, AsyncHandler<GetRunbookVersionRequest,GetRunbookVersionResponse> handler)	Gets a Runbook Version by identifier.
Future<GetTaskRecordResponse>	getTaskRecord(GetTaskRecordRequest request, AsyncHandler<GetTaskRecordRequest,GetTaskRecordResponse> handler)	Gets information for the specified task record.
Future<ListRunbooksResponse>	listRunbooks(ListRunbooksRequest request, AsyncHandler<ListRunbooksRequest,ListRunbooksResponse> handler)	Returns a list of all the runbooks in the specified compartment.
Future<ListRunbookVersionsResponse>	listRunbookVersions(ListRunbookVersionsRequest request, AsyncHandler<ListRunbookVersionsRequest,ListRunbookVersionsResponse> handler)	List versions for a runbook in Fleet Application Management.
Future<ListTaskRecordsResponse>	listTaskRecords(ListTaskRecordsRequest request, AsyncHandler<ListTaskRecordsRequest,ListTaskRecordsResponse> handler)	Returns a list of all the task records in the specified compartment.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
Future<PublishRunbookResponse>	publishRunbook(PublishRunbookRequest request, AsyncHandler<PublishRunbookRequest,PublishRunbookResponse> handler)	Publish the specified version of the runbook.
void	refreshClient()	Rebuild the backing HttpClient.
Future<SetDefaultRunbookResponse>	setDefaultRunbook(SetDefaultRunbookRequest request, AsyncHandler<SetDefaultRunbookRequest,SetDefaultRunbookResponse> handler)	Set a runbook as default.
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’).
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
Future<UpdateRunbookResponse>	updateRunbook(UpdateRunbookRequest request, AsyncHandler<UpdateRunbookRequest,UpdateRunbookResponse> handler)	Updates the runbook specified by the identifier.
Future<UpdateRunbookVersionResponse>	updateRunbookVersion(UpdateRunbookVersionRequest request, AsyncHandler<UpdateRunbookVersionRequest,UpdateRunbookVersionResponse> handler)	Updates the RunbookVersion.
Future<UpdateTaskRecordResponse>	updateTaskRecord(UpdateTaskRecordRequest request, AsyncHandler<UpdateTaskRecordRequest,UpdateTaskRecordResponse> handler)	Updates certain attributes for the specified task record.
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 java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.fleetappsmanagement.FleetAppsManagementRunbooksAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for FleetAppsManagementRunbooks.

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

FleetAppsManagementRunbooksAsyncClient

@Deprecated
public FleetAppsManagementRunbooksAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

FleetAppsManagementRunbooksAsyncClient

@Deprecated
public FleetAppsManagementRunbooksAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                              ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

FleetAppsManagementRunbooksAsyncClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

FleetAppsManagementRunbooksAsyncClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

FleetAppsManagementRunbooksAsyncClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

FleetAppsManagementRunbooksAsyncClient

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

FleetAppsManagementRunbooksAsyncClient

@Deprecated
public FleetAppsManagementRunbooksAsyncClient(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 FleetAppsManagementRunbooksAsyncClient.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 FleetAppsManagementRunbooksAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: FleetAppsManagementRunbooksAsync

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 FleetAppsManagementRunbooksAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: FleetAppsManagementRunbooksAsync

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 FleetAppsManagementRunbooksAsync

Parameters:

regionId - The public region ID.

changeRunbookCompartment

public Future<ChangeRunbookCompartmentResponse> changeRunbookCompartment(ChangeRunbookCompartmentRequest request,
                                                                         AsyncHandler<ChangeRunbookCompartmentRequest,ChangeRunbookCompartmentResponse> handler)

Description copied from interface: FleetAppsManagementRunbooksAsync

Moves a Runbook into a different compartment within the same tenancy.

For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Specified by:

changeRunbookCompartment in interface FleetAppsManagementRunbooksAsync

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.

changeTaskRecordCompartment

public Future<ChangeTaskRecordCompartmentResponse> changeTaskRecordCompartment(ChangeTaskRecordCompartmentRequest request,
                                                                               AsyncHandler<ChangeTaskRecordCompartmentRequest,ChangeTaskRecordCompartmentResponse> handler)

Description copied from interface: FleetAppsManagementRunbooksAsync

Moves a task record into a different compartment within the same tenancy.

For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Specified by:

changeTaskRecordCompartment in interface FleetAppsManagementRunbooksAsync

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.

createRunbook

public Future<CreateRunbookResponse> createRunbook(CreateRunbookRequest request,
                                                   AsyncHandler<CreateRunbookRequest,CreateRunbookResponse> handler)

Description copied from interface: FleetAppsManagementRunbooksAsync

Creates a runbook.

Specified by:

createRunbook in interface FleetAppsManagementRunbooksAsync

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.

createRunbookVersion

public Future<CreateRunbookVersionResponse> createRunbookVersion(CreateRunbookVersionRequest request,
                                                                 AsyncHandler<CreateRunbookVersionRequest,CreateRunbookVersionResponse> handler)

Description copied from interface: FleetAppsManagementRunbooksAsync

Add RunbookVersion in Fleet Application Management.

Specified by:

createRunbookVersion in interface FleetAppsManagementRunbooksAsync

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.

createTaskRecord

public Future<CreateTaskRecordResponse> createTaskRecord(CreateTaskRecordRequest request,
                                                         AsyncHandler<CreateTaskRecordRequest,CreateTaskRecordResponse> handler)

Description copied from interface: FleetAppsManagementRunbooksAsync

Creates a new task record.

Specified by:

createTaskRecord in interface FleetAppsManagementRunbooksAsync

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.

deleteRunbook

public Future<DeleteRunbookResponse> deleteRunbook(DeleteRunbookRequest request,
                                                   AsyncHandler<DeleteRunbookRequest,DeleteRunbookResponse> handler)

Description copied from interface: FleetAppsManagementRunbooksAsync

Deletes a runbook specified by the identifier.

Specified by:

deleteRunbook in interface FleetAppsManagementRunbooksAsync

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.

deleteRunbookVersion

public Future<DeleteRunbookVersionResponse> deleteRunbookVersion(DeleteRunbookVersionRequest request,
                                                                 AsyncHandler<DeleteRunbookVersionRequest,DeleteRunbookVersionResponse> handler)

Description copied from interface: FleetAppsManagementRunbooksAsync

Removes a Runbook Version from the runbook in Fleet Application Management.

Specified by:

deleteRunbookVersion in interface FleetAppsManagementRunbooksAsync

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.

deleteTaskRecord

public Future<DeleteTaskRecordResponse> deleteTaskRecord(DeleteTaskRecordRequest request,
                                                         AsyncHandler<DeleteTaskRecordRequest,DeleteTaskRecordResponse> handler)

Description copied from interface: FleetAppsManagementRunbooksAsync

Deletes the task record specified by an identifier.

Specified by:

deleteTaskRecord in interface FleetAppsManagementRunbooksAsync

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.

getRunbook

public Future<GetRunbookResponse> getRunbook(GetRunbookRequest request,
                                             AsyncHandler<GetRunbookRequest,GetRunbookResponse> handler)

Description copied from interface: FleetAppsManagementRunbooksAsync

Get the details of a runbook in Fleet Application Management.

Specified by:

getRunbook in interface FleetAppsManagementRunbooksAsync

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.

getRunbookVersion

public Future<GetRunbookVersionResponse> getRunbookVersion(GetRunbookVersionRequest request,
                                                           AsyncHandler<GetRunbookVersionRequest,GetRunbookVersionResponse> handler)

Description copied from interface: FleetAppsManagementRunbooksAsync

Gets a Runbook Version by identifier.

Specified by:

getRunbookVersion in interface FleetAppsManagementRunbooksAsync

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.

getTaskRecord

public Future<GetTaskRecordResponse> getTaskRecord(GetTaskRecordRequest request,
                                                   AsyncHandler<GetTaskRecordRequest,GetTaskRecordResponse> handler)

Description copied from interface: FleetAppsManagementRunbooksAsync

Gets information for the specified task record.

Specified by:

getTaskRecord in interface FleetAppsManagementRunbooksAsync

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.

listRunbookVersions

public Future<ListRunbookVersionsResponse> listRunbookVersions(ListRunbookVersionsRequest request,
                                                               AsyncHandler<ListRunbookVersionsRequest,ListRunbookVersionsResponse> handler)

Description copied from interface: FleetAppsManagementRunbooksAsync

List versions for a runbook in Fleet Application Management.

Specified by:

listRunbookVersions in interface FleetAppsManagementRunbooksAsync

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.

listRunbooks

public Future<ListRunbooksResponse> listRunbooks(ListRunbooksRequest request,
                                                 AsyncHandler<ListRunbooksRequest,ListRunbooksResponse> handler)

Description copied from interface: FleetAppsManagementRunbooksAsync

Returns a list of all the runbooks in the specified compartment.

The query parameter compartmentId is required unless the query parameter id is specified.

Specified by:

listRunbooks in interface FleetAppsManagementRunbooksAsync

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.

listTaskRecords

public Future<ListTaskRecordsResponse> listTaskRecords(ListTaskRecordsRequest request,
                                                       AsyncHandler<ListTaskRecordsRequest,ListTaskRecordsResponse> handler)

Description copied from interface: FleetAppsManagementRunbooksAsync

Returns a list of all the task records in the specified compartment.

The query parameter compartmentId is required unless the query parameter id is specified.

Specified by:

listTaskRecords in interface FleetAppsManagementRunbooksAsync

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.

publishRunbook

public Future<PublishRunbookResponse> publishRunbook(PublishRunbookRequest request,
                                                     AsyncHandler<PublishRunbookRequest,PublishRunbookResponse> handler)

Description copied from interface: FleetAppsManagementRunbooksAsync

Publish the specified version of the runbook.

The specified version of the runbook becomes acitve when it is published.Only active versions of runbook can be used in execution.

Specified by:

publishRunbook in interface FleetAppsManagementRunbooksAsync

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.

setDefaultRunbook

public Future<SetDefaultRunbookResponse> setDefaultRunbook(SetDefaultRunbookRequest request,
                                                           AsyncHandler<SetDefaultRunbookRequest,SetDefaultRunbookResponse> handler)

Description copied from interface: FleetAppsManagementRunbooksAsync

Set a runbook as default.

Specified by:

setDefaultRunbook in interface FleetAppsManagementRunbooksAsync

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.

updateRunbook

public Future<UpdateRunbookResponse> updateRunbook(UpdateRunbookRequest request,
                                                   AsyncHandler<UpdateRunbookRequest,UpdateRunbookResponse> handler)

Description copied from interface: FleetAppsManagementRunbooksAsync

Updates the runbook specified by the identifier.

Specified by:

updateRunbook in interface FleetAppsManagementRunbooksAsync

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.

updateRunbookVersion

public Future<UpdateRunbookVersionResponse> updateRunbookVersion(UpdateRunbookVersionRequest request,
                                                                 AsyncHandler<UpdateRunbookVersionRequest,UpdateRunbookVersionResponse> handler)

Description copied from interface: FleetAppsManagementRunbooksAsync

Updates the RunbookVersion.

Specified by:

updateRunbookVersion in interface FleetAppsManagementRunbooksAsync

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.

updateTaskRecord

public Future<UpdateTaskRecordResponse> updateTaskRecord(UpdateTaskRecordRequest request,
                                                         AsyncHandler<UpdateTaskRecordRequest,UpdateTaskRecordResponse> handler)

Description copied from interface: FleetAppsManagementRunbooksAsync

Updates certain attributes for the specified task record.

Specified by:

updateTaskRecord in interface FleetAppsManagementRunbooksAsync

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)