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 FleetAppsManagementRunbooksAsyncAsync 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 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 classFleetAppsManagementRunbooksAsyncClient.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 FleetAppsManagementRunbooks.
-
Constructor Summary
Constructors Constructor Description FleetAppsManagementRunbooksAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.FleetAppsManagementRunbooksAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.FleetAppsManagementRunbooksAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.FleetAppsManagementRunbooksAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.FleetAppsManagementRunbooksAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.FleetAppsManagementRunbooksAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.FleetAppsManagementRunbooksAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
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.FleetAppsManagementRunbooksAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
FleetAppsManagementRunbooksAsyncClient
@Deprecated public FleetAppsManagementRunbooksAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeFleetAppsManagementRunbooksAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
FleetAppsManagementRunbooksAsyncClient
@Deprecated public FleetAppsManagementRunbooksAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeFleetAppsManagementRunbooksAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
FleetAppsManagementRunbooksAsyncClient
@Deprecated public FleetAppsManagementRunbooksAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeFleetAppsManagementRunbooksAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
FleetAppsManagementRunbooksAsyncClient
@Deprecated public FleetAppsManagementRunbooksAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeFleetAppsManagementRunbooksAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeFleetAppsManagementRunbooksAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
FleetAppsManagementRunbooksAsyncClient
@Deprecated public FleetAppsManagementRunbooksAsyncClient(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 (seeFleetAppsManagementRunbooksAsyncClient.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)
-
FleetAppsManagementRunbooksAsyncClient
@Deprecated public FleetAppsManagementRunbooksAsyncClient(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 (seeFleetAppsManagementRunbooksAsyncClient.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 FleetAppsManagementRunbooksAsyncClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:FleetAppsManagementRunbooksAsyncSets 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 interfaceFleetAppsManagementRunbooksAsync- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:FleetAppsManagementRunbooksAsyncSets 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 interfaceFleetAppsManagementRunbooksAsync- Parameters:
regionId- The public region ID.
-
changeRunbookCompartment
public Future<ChangeRunbookCompartmentResponse> changeRunbookCompartment(ChangeRunbookCompartmentRequest request, AsyncHandler<ChangeRunbookCompartmentRequest,ChangeRunbookCompartmentResponse> handler)
Description copied from interface:FleetAppsManagementRunbooksAsyncMoves 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:
changeRunbookCompartmentin interfaceFleetAppsManagementRunbooksAsync- 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.
-
changeTaskRecordCompartment
public Future<ChangeTaskRecordCompartmentResponse> changeTaskRecordCompartment(ChangeTaskRecordCompartmentRequest request, AsyncHandler<ChangeTaskRecordCompartmentRequest,ChangeTaskRecordCompartmentResponse> handler)
Description copied from interface:FleetAppsManagementRunbooksAsyncMoves 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:
changeTaskRecordCompartmentin interfaceFleetAppsManagementRunbooksAsync- 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.
-
createRunbook
public Future<CreateRunbookResponse> createRunbook(CreateRunbookRequest request, AsyncHandler<CreateRunbookRequest,CreateRunbookResponse> handler)
Description copied from interface:FleetAppsManagementRunbooksAsyncCreates a runbook.- Specified by:
createRunbookin interfaceFleetAppsManagementRunbooksAsync- 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.
-
createRunbookVersion
public Future<CreateRunbookVersionResponse> createRunbookVersion(CreateRunbookVersionRequest request, AsyncHandler<CreateRunbookVersionRequest,CreateRunbookVersionResponse> handler)
Description copied from interface:FleetAppsManagementRunbooksAsyncAdd RunbookVersion inĀ Fleet Application Management.- Specified by:
createRunbookVersionin interfaceFleetAppsManagementRunbooksAsync- 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.
-
createTaskRecord
public Future<CreateTaskRecordResponse> createTaskRecord(CreateTaskRecordRequest request, AsyncHandler<CreateTaskRecordRequest,CreateTaskRecordResponse> handler)
Description copied from interface:FleetAppsManagementRunbooksAsyncCreates a new task record.- Specified by:
createTaskRecordin interfaceFleetAppsManagementRunbooksAsync- 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.
-
deleteRunbook
public Future<DeleteRunbookResponse> deleteRunbook(DeleteRunbookRequest request, AsyncHandler<DeleteRunbookRequest,DeleteRunbookResponse> handler)
Description copied from interface:FleetAppsManagementRunbooksAsyncDeletes a runbook specified by the identifier.- Specified by:
deleteRunbookin interfaceFleetAppsManagementRunbooksAsync- 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.
-
deleteRunbookVersion
public Future<DeleteRunbookVersionResponse> deleteRunbookVersion(DeleteRunbookVersionRequest request, AsyncHandler<DeleteRunbookVersionRequest,DeleteRunbookVersionResponse> handler)
Description copied from interface:FleetAppsManagementRunbooksAsyncRemoves a Runbook Version from the runbook in Fleet Application Management.- Specified by:
deleteRunbookVersionin interfaceFleetAppsManagementRunbooksAsync- 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.
-
deleteTaskRecord
public Future<DeleteTaskRecordResponse> deleteTaskRecord(DeleteTaskRecordRequest request, AsyncHandler<DeleteTaskRecordRequest,DeleteTaskRecordResponse> handler)
Description copied from interface:FleetAppsManagementRunbooksAsyncDeletes the task record specified by an identifier.- Specified by:
deleteTaskRecordin interfaceFleetAppsManagementRunbooksAsync- 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.
-
getRunbook
public Future<GetRunbookResponse> getRunbook(GetRunbookRequest request, AsyncHandler<GetRunbookRequest,GetRunbookResponse> handler)
Description copied from interface:FleetAppsManagementRunbooksAsyncGet the details of a runbook in Fleet Application Management.- Specified by:
getRunbookin interfaceFleetAppsManagementRunbooksAsync- 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.
-
getRunbookVersion
public Future<GetRunbookVersionResponse> getRunbookVersion(GetRunbookVersionRequest request, AsyncHandler<GetRunbookVersionRequest,GetRunbookVersionResponse> handler)
Description copied from interface:FleetAppsManagementRunbooksAsyncGets a Runbook Version by identifier.- Specified by:
getRunbookVersionin interfaceFleetAppsManagementRunbooksAsync- 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.
-
getTaskRecord
public Future<GetTaskRecordResponse> getTaskRecord(GetTaskRecordRequest request, AsyncHandler<GetTaskRecordRequest,GetTaskRecordResponse> handler)
Description copied from interface:FleetAppsManagementRunbooksAsyncGets information for the specified task record.- Specified by:
getTaskRecordin interfaceFleetAppsManagementRunbooksAsync- 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.
-
listRunbookVersions
public Future<ListRunbookVersionsResponse> listRunbookVersions(ListRunbookVersionsRequest request, AsyncHandler<ListRunbookVersionsRequest,ListRunbookVersionsResponse> handler)
Description copied from interface:FleetAppsManagementRunbooksAsyncList versions for a runbook in Fleet Application Management.- Specified by:
listRunbookVersionsin interfaceFleetAppsManagementRunbooksAsync- 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.
-
listRunbooks
public Future<ListRunbooksResponse> listRunbooks(ListRunbooksRequest request, AsyncHandler<ListRunbooksRequest,ListRunbooksResponse> handler)
Description copied from interface:FleetAppsManagementRunbooksAsyncReturns a list of all the runbooks in the specified compartment.The query parameter
compartmentIdis required unless the query parameteridis specified.- Specified by:
listRunbooksin interfaceFleetAppsManagementRunbooksAsync- 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.
-
listTaskRecords
public Future<ListTaskRecordsResponse> listTaskRecords(ListTaskRecordsRequest request, AsyncHandler<ListTaskRecordsRequest,ListTaskRecordsResponse> handler)
Description copied from interface:FleetAppsManagementRunbooksAsyncReturns a list of all the task records in the specified compartment.The query parameter
compartmentIdis required unless the query parameteridis specified.- Specified by:
listTaskRecordsin interfaceFleetAppsManagementRunbooksAsync- 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.
-
publishRunbook
public Future<PublishRunbookResponse> publishRunbook(PublishRunbookRequest request, AsyncHandler<PublishRunbookRequest,PublishRunbookResponse> handler)
Description copied from interface:FleetAppsManagementRunbooksAsyncPublish 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:
publishRunbookin interfaceFleetAppsManagementRunbooksAsync- 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.
-
setDefaultRunbook
public Future<SetDefaultRunbookResponse> setDefaultRunbook(SetDefaultRunbookRequest request, AsyncHandler<SetDefaultRunbookRequest,SetDefaultRunbookResponse> handler)
Description copied from interface:FleetAppsManagementRunbooksAsyncSet a runbook as default.- Specified by:
setDefaultRunbookin interfaceFleetAppsManagementRunbooksAsync- 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.
-
updateRunbook
public Future<UpdateRunbookResponse> updateRunbook(UpdateRunbookRequest request, AsyncHandler<UpdateRunbookRequest,UpdateRunbookResponse> handler)
Description copied from interface:FleetAppsManagementRunbooksAsyncUpdates the runbook specified by the identifier.- Specified by:
updateRunbookin interfaceFleetAppsManagementRunbooksAsync- 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.
-
updateRunbookVersion
public Future<UpdateRunbookVersionResponse> updateRunbookVersion(UpdateRunbookVersionRequest request, AsyncHandler<UpdateRunbookVersionRequest,UpdateRunbookVersionResponse> handler)
Description copied from interface:FleetAppsManagementRunbooksAsyncUpdates the RunbookVersion.- Specified by:
updateRunbookVersionin interfaceFleetAppsManagementRunbooksAsync- 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.
-
updateTaskRecord
public Future<UpdateTaskRecordResponse> updateTaskRecord(UpdateTaskRecordRequest request, AsyncHandler<UpdateTaskRecordRequest,UpdateTaskRecordResponse> handler)
Description copied from interface:FleetAppsManagementRunbooksAsyncUpdates certain attributes for the specified task record.- Specified by:
updateTaskRecordin interfaceFleetAppsManagementRunbooksAsync- 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)
-
-