Class ManagementAgentAsyncClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseAsyncClient
-
- com.oracle.bmc.managementagent.ManagementAgentAsyncClient
-
- All Implemented Interfaces:
ManagementAgentAsync,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20200202") public class ManagementAgentAsyncClient extends BaseAsyncClient implements ManagementAgentAsyncAsync client implementation for ManagementAgent 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 classManagementAgentAsyncClient.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 ManagementAgent.
-
Constructor Summary
Constructors Constructor Description ManagementAgentAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.ManagementAgentAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.ManagementAgentAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.ManagementAgentAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.ManagementAgentAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.ManagementAgentAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.ManagementAgentAsyncClient(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.managementagent.ManagementAgentAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
ManagementAgentAsyncClient
@Deprecated public ManagementAgentAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeManagementAgentAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
ManagementAgentAsyncClient
@Deprecated public ManagementAgentAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeManagementAgentAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
ManagementAgentAsyncClient
@Deprecated public ManagementAgentAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeManagementAgentAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
ManagementAgentAsyncClient
@Deprecated public ManagementAgentAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeManagementAgentAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
ManagementAgentAsyncClient
@Deprecated public ManagementAgentAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeManagementAgentAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
ManagementAgentAsyncClient
@Deprecated public ManagementAgentAsyncClient(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 (seeManagementAgentAsyncClient.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)
-
ManagementAgentAsyncClient
@Deprecated public ManagementAgentAsyncClient(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 (seeManagementAgentAsyncClient.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 ManagementAgentAsyncClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:ManagementAgentAsyncSets 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 interfaceManagementAgentAsync- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:ManagementAgentAsyncSets 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 interfaceManagementAgentAsync- Parameters:
regionId- The public region ID.
-
createDataSource
public Future<CreateDataSourceResponse> createDataSource(CreateDataSourceRequest request, AsyncHandler<CreateDataSourceRequest,CreateDataSourceResponse> handler)
Description copied from interface:ManagementAgentAsyncDatasource creation request to given Management Agent.- Specified by:
createDataSourcein interfaceManagementAgentAsync- 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.
-
createManagementAgentInstallKey
public Future<CreateManagementAgentInstallKeyResponse> createManagementAgentInstallKey(CreateManagementAgentInstallKeyRequest request, AsyncHandler<CreateManagementAgentInstallKeyRequest,CreateManagementAgentInstallKeyResponse> handler)
Description copied from interface:ManagementAgentAsyncUser creates a new install key as part of this API.- Specified by:
createManagementAgentInstallKeyin interfaceManagementAgentAsync- 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.
-
createNamedCredential
public Future<CreateNamedCredentialResponse> createNamedCredential(CreateNamedCredentialRequest request, AsyncHandler<CreateNamedCredentialRequest,CreateNamedCredentialResponse> handler)
Description copied from interface:ManagementAgentAsyncNamed credential creation request to given Management Agent.- Specified by:
createNamedCredentialin interfaceManagementAgentAsync- 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.
-
deleteDataSource
public Future<DeleteDataSourceResponse> deleteDataSource(DeleteDataSourceRequest request, AsyncHandler<DeleteDataSourceRequest,DeleteDataSourceResponse> handler)
Description copied from interface:ManagementAgentAsyncDatasource delete request to given Management Agent.- Specified by:
deleteDataSourcein interfaceManagementAgentAsync- 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.
-
deleteManagementAgent
public Future<DeleteManagementAgentResponse> deleteManagementAgent(DeleteManagementAgentRequest request, AsyncHandler<DeleteManagementAgentRequest,DeleteManagementAgentResponse> handler)
Description copied from interface:ManagementAgentAsyncDeletes a Management Agent resource by identifier- Specified by:
deleteManagementAgentin interfaceManagementAgentAsync- 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.
-
deleteManagementAgentInstallKey
public Future<DeleteManagementAgentInstallKeyResponse> deleteManagementAgentInstallKey(DeleteManagementAgentInstallKeyRequest request, AsyncHandler<DeleteManagementAgentInstallKeyRequest,DeleteManagementAgentInstallKeyResponse> handler)
Description copied from interface:ManagementAgentAsyncDeletes a Management Agent install Key resource by identifier- Specified by:
deleteManagementAgentInstallKeyin interfaceManagementAgentAsync- 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.
-
deleteNamedCredential
public Future<DeleteNamedCredentialResponse> deleteNamedCredential(DeleteNamedCredentialRequest request, AsyncHandler<DeleteNamedCredentialRequest,DeleteNamedCredentialResponse> handler)
Description copied from interface:ManagementAgentAsyncNamed credential delete request to sent to associated Management Agent.- Specified by:
deleteNamedCredentialin interfaceManagementAgentAsync- 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.
-
deleteWorkRequest
public Future<DeleteWorkRequestResponse> deleteWorkRequest(DeleteWorkRequestRequest request, AsyncHandler<DeleteWorkRequestRequest,DeleteWorkRequestResponse> handler)
Description copied from interface:ManagementAgentAsyncCancel the work request with the given ID.- Specified by:
deleteWorkRequestin interfaceManagementAgentAsync- 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.
-
deployPlugins
public Future<DeployPluginsResponse> deployPlugins(DeployPluginsRequest request, AsyncHandler<DeployPluginsRequest,DeployPluginsResponse> handler)
Description copied from interface:ManagementAgentAsyncDeploys Plugins to a given list of agentIds.- Specified by:
deployPluginsin interfaceManagementAgentAsync- 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.
-
getAutoUpgradableConfig
public Future<GetAutoUpgradableConfigResponse> getAutoUpgradableConfig(GetAutoUpgradableConfigRequest request, AsyncHandler<GetAutoUpgradableConfigRequest,GetAutoUpgradableConfigResponse> handler)
Description copied from interface:ManagementAgentAsyncGet the AutoUpgradable configuration for all agents in a tenancy.The supplied compartmentId must be a tenancy root.
- Specified by:
getAutoUpgradableConfigin interfaceManagementAgentAsync- 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.
-
getDataSource
public Future<GetDataSourceResponse> getDataSource(GetDataSourceRequest request, AsyncHandler<GetDataSourceRequest,GetDataSourceResponse> handler)
Description copied from interface:ManagementAgentAsyncGet Datasource details for given Id and given Management Agent.- Specified by:
getDataSourcein interfaceManagementAgentAsync- 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.
-
getManagementAgent
public Future<GetManagementAgentResponse> getManagementAgent(GetManagementAgentRequest request, AsyncHandler<GetManagementAgentRequest,GetManagementAgentResponse> handler)
Description copied from interface:ManagementAgentAsyncGets complete details of the inventory of a given agent id- Specified by:
getManagementAgentin interfaceManagementAgentAsync- 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.
-
getManagementAgentInstallKey
public Future<GetManagementAgentInstallKeyResponse> getManagementAgentInstallKey(GetManagementAgentInstallKeyRequest request, AsyncHandler<GetManagementAgentInstallKeyRequest,GetManagementAgentInstallKeyResponse> handler)
Description copied from interface:ManagementAgentAsyncGets complete details of the Agent install Key for a given key id- Specified by:
getManagementAgentInstallKeyin interfaceManagementAgentAsync- 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.
-
getManagementAgentInstallKeyContent
public Future<GetManagementAgentInstallKeyContentResponse> getManagementAgentInstallKeyContent(GetManagementAgentInstallKeyContentRequest request, AsyncHandler<GetManagementAgentInstallKeyContentRequest,GetManagementAgentInstallKeyContentResponse> handler)
Description copied from interface:ManagementAgentAsyncReturns a file with Management Agent install Key in it- Specified by:
getManagementAgentInstallKeyContentin interfaceManagementAgentAsync- 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.
-
getNamedCredential
public Future<GetNamedCredentialResponse> getNamedCredential(GetNamedCredentialRequest request, AsyncHandler<GetNamedCredentialRequest,GetNamedCredentialResponse> handler)
Description copied from interface:ManagementAgentAsyncGet Named credential details for given Id and given Management Agent.- Specified by:
getNamedCredentialin interfaceManagementAgentAsync- 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.
-
getNamedCredentialsMetadatum
public Future<GetNamedCredentialsMetadatumResponse> getNamedCredentialsMetadatum(GetNamedCredentialsMetadatumRequest request, AsyncHandler<GetNamedCredentialsMetadatumRequest,GetNamedCredentialsMetadatumResponse> handler)
Description copied from interface:ManagementAgentAsyncReturn the Metadata definition for Named Credentials supported by Management Agent.- Specified by:
getNamedCredentialsMetadatumin interfaceManagementAgentAsync- 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.
-
getWorkRequest
public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
Description copied from interface:ManagementAgentAsyncGets the status of the work request with the given ID.- Specified by:
getWorkRequestin interfaceManagementAgentAsync- 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.
-
listAvailabilityHistories
public Future<ListAvailabilityHistoriesResponse> listAvailabilityHistories(ListAvailabilityHistoriesRequest request, AsyncHandler<ListAvailabilityHistoriesRequest,ListAvailabilityHistoriesResponse> handler)
Description copied from interface:ManagementAgentAsyncLists the availability history records of Management Agent- Specified by:
listAvailabilityHistoriesin interfaceManagementAgentAsync- 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.
-
listDataSources
public Future<ListDataSourcesResponse> listDataSources(ListDataSourcesRequest request, AsyncHandler<ListDataSourcesRequest,ListDataSourcesResponse> handler)
Description copied from interface:ManagementAgentAsyncA list of Management Agent Data Sources for the given Management Agent Id.- Specified by:
listDataSourcesin interfaceManagementAgentAsync- 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.
-
listManagementAgentImages
public Future<ListManagementAgentImagesResponse> listManagementAgentImages(ListManagementAgentImagesRequest request, AsyncHandler<ListManagementAgentImagesRequest,ListManagementAgentImagesResponse> handler)
Description copied from interface:ManagementAgentAsyncGet supported agent image information- Specified by:
listManagementAgentImagesin interfaceManagementAgentAsync- 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.
-
listManagementAgentInstallKeys
public Future<ListManagementAgentInstallKeysResponse> listManagementAgentInstallKeys(ListManagementAgentInstallKeysRequest request, AsyncHandler<ListManagementAgentInstallKeysRequest,ListManagementAgentInstallKeysResponse> handler)
Description copied from interface:ManagementAgentAsyncReturns a list of Management Agent installed Keys.- Specified by:
listManagementAgentInstallKeysin interfaceManagementAgentAsync- 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.
-
listManagementAgentPlugins
public Future<ListManagementAgentPluginsResponse> listManagementAgentPlugins(ListManagementAgentPluginsRequest request, AsyncHandler<ListManagementAgentPluginsRequest,ListManagementAgentPluginsResponse> handler)
Description copied from interface:ManagementAgentAsyncReturns a list of managementAgentPlugins.- Specified by:
listManagementAgentPluginsin interfaceManagementAgentAsync- 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.
-
listManagementAgents
public Future<ListManagementAgentsResponse> listManagementAgents(ListManagementAgentsRequest request, AsyncHandler<ListManagementAgentsRequest,ListManagementAgentsResponse> handler)
Description copied from interface:ManagementAgentAsyncReturns a list of Management Agents.If no explicit page size limit is specified, it will default to 1000 when compartmentIdInSubtree is true and 5000 otherwise. The response is limited to maximum 1000 records when compartmentIdInSubtree is true.
- Specified by:
listManagementAgentsin interfaceManagementAgentAsync- 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.
-
listNamedCredentials
public Future<ListNamedCredentialsResponse> listNamedCredentials(ListNamedCredentialsRequest request, AsyncHandler<ListNamedCredentialsRequest,ListNamedCredentialsResponse> handler)
Description copied from interface:ManagementAgentAsyncA list of Management Agent Data Sources for the given Management Agent Id.- Specified by:
listNamedCredentialsin interfaceManagementAgentAsync- 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.
-
listWorkRequestErrors
public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
Description copied from interface:ManagementAgentAsyncReturn a (paginated) list of errors for a given work request.- Specified by:
listWorkRequestErrorsin interfaceManagementAgentAsync- 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.
-
listWorkRequestLogs
public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
Description copied from interface:ManagementAgentAsyncReturn a (paginated) list of logs for a given work request.- Specified by:
listWorkRequestLogsin interfaceManagementAgentAsync- 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.
-
listWorkRequests
public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
Description copied from interface:ManagementAgentAsyncLists the work requests in a compartment.- Specified by:
listWorkRequestsin interfaceManagementAgentAsync- 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.
-
setAutoUpgradableConfig
public Future<SetAutoUpgradableConfigResponse> setAutoUpgradableConfig(SetAutoUpgradableConfigRequest request, AsyncHandler<SetAutoUpgradableConfigRequest,SetAutoUpgradableConfigResponse> handler)
Description copied from interface:ManagementAgentAsyncSets the AutoUpgradable configuration for all agents in a tenancy.The supplied compartmentId must be a tenancy root.
- Specified by:
setAutoUpgradableConfigin interfaceManagementAgentAsync- 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.
-
summarizeManagementAgentCounts
public Future<SummarizeManagementAgentCountsResponse> summarizeManagementAgentCounts(SummarizeManagementAgentCountsRequest request, AsyncHandler<SummarizeManagementAgentCountsRequest,SummarizeManagementAgentCountsResponse> handler)
Description copied from interface:ManagementAgentAsyncGets count of the inventory of agents for a given compartment id, group by, and isPluginDeployed parameters.Supported groupBy parameters: availabilityStatus, platformType, version
- Specified by:
summarizeManagementAgentCountsin interfaceManagementAgentAsync- 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.
-
summarizeManagementAgentPluginCounts
public Future<SummarizeManagementAgentPluginCountsResponse> summarizeManagementAgentPluginCounts(SummarizeManagementAgentPluginCountsRequest request, AsyncHandler<SummarizeManagementAgentPluginCountsRequest,SummarizeManagementAgentPluginCountsResponse> handler)
Description copied from interface:ManagementAgentAsyncGets count of the inventory of management agent plugins for a given compartment id and group by parameter.Supported groupBy parameter: pluginName
- Specified by:
summarizeManagementAgentPluginCountsin interfaceManagementAgentAsync- 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.
-
updateDataSource
public Future<UpdateDataSourceResponse> updateDataSource(UpdateDataSourceRequest request, AsyncHandler<UpdateDataSourceRequest,UpdateDataSourceResponse> handler)
Description copied from interface:ManagementAgentAsyncDatasource update request to given Management Agent.- Specified by:
updateDataSourcein interfaceManagementAgentAsync- 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.
-
updateManagementAgent
public Future<UpdateManagementAgentResponse> updateManagementAgent(UpdateManagementAgentRequest request, AsyncHandler<UpdateManagementAgentRequest,UpdateManagementAgentResponse> handler)
Description copied from interface:ManagementAgentAsyncAPI to update the console managed properties of the Management Agent.- Specified by:
updateManagementAgentin interfaceManagementAgentAsync- 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.
-
updateManagementAgentInstallKey
public Future<UpdateManagementAgentInstallKeyResponse> updateManagementAgentInstallKey(UpdateManagementAgentInstallKeyRequest request, AsyncHandler<UpdateManagementAgentInstallKeyRequest,UpdateManagementAgentInstallKeyResponse> handler)
Description copied from interface:ManagementAgentAsyncAPI to update the modifiable properties of the Management Agent install key.- Specified by:
updateManagementAgentInstallKeyin interfaceManagementAgentAsync- 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.
-
updateNamedCredential
public Future<UpdateNamedCredentialResponse> updateNamedCredential(UpdateNamedCredentialRequest request, AsyncHandler<UpdateNamedCredentialRequest,UpdateNamedCredentialResponse> handler)
Description copied from interface:ManagementAgentAsyncNamed credential update request to given Management Agent.- Specified by:
updateNamedCredentialin interfaceManagementAgentAsync- 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)
-
-