com.oracle.bmc.apmcontrolplane

Class ApmDomainAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.apmcontrolplane.ApmDomainAsyncClient

All Implemented Interfaces:

ApmDomainAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200630")
public class ApmDomainAsyncClient
extends BaseAsyncClient
implements ApmDomainAsync

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ApmDomainAsyncClient.Builder	builder() Create a builder for this client.
Future<ChangeApmDomainCompartmentResponse>	changeApmDomainCompartment(ChangeApmDomainCompartmentRequest request, AsyncHandler<ChangeApmDomainCompartmentRequest,ChangeApmDomainCompartmentResponse> handler) Moves an APM domain into a different compartment.
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<CreateApmDomainResponse>	createApmDomain(CreateApmDomainRequest request, AsyncHandler<CreateApmDomainRequest,CreateApmDomainResponse> handler) Creates a new APM domain.
Future<DeleteApmDomainResponse>	deleteApmDomain(DeleteApmDomainRequest request, AsyncHandler<DeleteApmDomainRequest,DeleteApmDomainResponse> handler) Deletes the specified APM domain asynchronously.
Future<GenerateDataKeysResponse>	generateDataKeys(GenerateDataKeysRequest request, AsyncHandler<GenerateDataKeysRequest,GenerateDataKeysResponse> handler) Generates a set of new Data Keys for the specified APM domain with the specified names and types.
Future<GetApmDomainResponse>	getApmDomain(GetApmDomainRequest request, AsyncHandler<GetApmDomainRequest,GetApmDomainResponse> handler) Gets the details of the APM domain specified by OCID.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetWorkRequestResponse>	getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler) Gets the details of the work request with the given ID.
Future<ListApmDomainsResponse>	listApmDomains(ListApmDomainsRequest request, AsyncHandler<ListApmDomainsRequest,ListApmDomainsResponse> handler) Lists all APM domains for the specified tenant compartment.
Future<ListApmDomainWorkRequestsResponse>	listApmDomainWorkRequests(ListApmDomainWorkRequestsRequest request, AsyncHandler<ListApmDomainWorkRequestsRequest,ListApmDomainWorkRequestsResponse> handler) Returns a (paginated) list of work requests related to a specific APM domain.
Future<ListDataKeysResponse>	listDataKeys(ListDataKeysRequest request, AsyncHandler<ListDataKeysRequest,ListDataKeysResponse> handler) Lists all Data Keys for the specified APM domain.
Future<ListWorkRequestErrorsResponse>	listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler) Returns a (paginated) list of errors for a given work request.
Future<ListWorkRequestLogsResponse>	listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler) Returns a (paginated) list of logs for a given work request.
Future<ListWorkRequestsResponse>	listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler) Returns a (paginated) list of work requests in a given compartment.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient() Rebuild the backing HttpClient.
Future<RemoveDataKeysResponse>	removeDataKeys(RemoveDataKeysRequest request, AsyncHandler<RemoveDataKeysRequest,RemoveDataKeysResponse> handler) Removes the set of specified Data Keys from the specified APM domain.
void	setEndpoint(String endpoint)
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
Future<UpdateApmDomainResponse>	updateApmDomain(UpdateApmDomainRequest request, AsyncHandler<UpdateApmDomainRequest,UpdateApmDomainResponse> handler) Updates the APM domain.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.apmcontrolplane.ApmDomainAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for ApmDomain.

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

ApmDomainAsyncClient

@Deprecated
public ApmDomainAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

ApmDomainAsyncClient

@Deprecated
public ApmDomainAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                        ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

ApmDomainAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

ApmDomainAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

ApmDomainAsyncClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

ApmDomainAsyncClient

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

ApmDomainAsyncClient

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

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: ApmDomainAsync

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 ApmDomainAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: ApmDomainAsync

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 ApmDomainAsync

Parameters:

regionId - The public region ID.

changeApmDomainCompartment

public Future<ChangeApmDomainCompartmentResponse> changeApmDomainCompartment(ChangeApmDomainCompartmentRequest request,
                                                                             AsyncHandler<ChangeApmDomainCompartmentRequest,ChangeApmDomainCompartmentResponse> handler)

Description copied from interface: ApmDomainAsync

Moves an APM domain into a different compartment. When provided, If-Match is checked against ETag values of the APM domain.

Specified by:

changeApmDomainCompartment in interface ApmDomainAsync

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.

createApmDomain

public Future<CreateApmDomainResponse> createApmDomain(CreateApmDomainRequest request,
                                                       AsyncHandler<CreateApmDomainRequest,CreateApmDomainResponse> handler)

Description copied from interface: ApmDomainAsync

Creates a new APM domain.

Specified by:

createApmDomain in interface ApmDomainAsync

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.

deleteApmDomain

public Future<DeleteApmDomainResponse> deleteApmDomain(DeleteApmDomainRequest request,
                                                       AsyncHandler<DeleteApmDomainRequest,DeleteApmDomainResponse> handler)

Description copied from interface: ApmDomainAsync

Deletes the specified APM domain asynchronously. The APM domain is placed in the ‘Deleting’ state and will stop accepting any operation requests. All resources associated with the APM domain are eventually recovered. Use the returned work request ID to track the progress of the background activity to complete deleting the APM domain.

Specified by:

deleteApmDomain in interface ApmDomainAsync

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.

generateDataKeys

public Future<GenerateDataKeysResponse> generateDataKeys(GenerateDataKeysRequest request,
                                                         AsyncHandler<GenerateDataKeysRequest,GenerateDataKeysResponse> handler)

Description copied from interface: ApmDomainAsync

Generates a set of new Data Keys for the specified APM domain with the specified names and types. These will be added to the existing set of Data Keys for the specified APM domain.

Specified by:

generateDataKeys in interface ApmDomainAsync

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.

getApmDomain

public Future<GetApmDomainResponse> getApmDomain(GetApmDomainRequest request,
                                                 AsyncHandler<GetApmDomainRequest,GetApmDomainResponse> handler)

Description copied from interface: ApmDomainAsync

Gets the details of the APM domain specified by OCID.

Specified by:

getApmDomain in interface ApmDomainAsync

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.

getWorkRequest

public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request,
                                                     AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)

Description copied from interface: ApmDomainAsync

Gets the details of the work request with the given ID.

Specified by:

getWorkRequest in interface ApmDomainAsync

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.

listApmDomainWorkRequests

public Future<ListApmDomainWorkRequestsResponse> listApmDomainWorkRequests(ListApmDomainWorkRequestsRequest request,
                                                                           AsyncHandler<ListApmDomainWorkRequestsRequest,ListApmDomainWorkRequestsResponse> handler)

Description copied from interface: ApmDomainAsync

Returns a (paginated) list of work requests related to a specific APM domain.

Specified by:

listApmDomainWorkRequests in interface ApmDomainAsync

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.

listApmDomains

public Future<ListApmDomainsResponse> listApmDomains(ListApmDomainsRequest request,
                                                     AsyncHandler<ListApmDomainsRequest,ListApmDomainsResponse> handler)

Description copied from interface: ApmDomainAsync

Lists all APM domains for the specified tenant compartment.

Specified by:

listApmDomains in interface ApmDomainAsync

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.

listDataKeys

public Future<ListDataKeysResponse> listDataKeys(ListDataKeysRequest request,
                                                 AsyncHandler<ListDataKeysRequest,ListDataKeysResponse> handler)

Description copied from interface: ApmDomainAsync

Lists all Data Keys for the specified APM domain. The caller may filter the list by specifying the ‘dataKeyType’ query parameter.

Specified by:

listDataKeys in interface ApmDomainAsync

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.

listWorkRequestErrors

public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request,
                                                                   AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)

Description copied from interface: ApmDomainAsync

Returns a (paginated) list of errors for a given work request.

Specified by:

listWorkRequestErrors in interface ApmDomainAsync

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.

listWorkRequestLogs

public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request,
                                                               AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)

Description copied from interface: ApmDomainAsync

Returns a (paginated) list of logs for a given work request.

Specified by:

listWorkRequestLogs in interface ApmDomainAsync

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.

listWorkRequests

public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request,
                                                         AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)

Description copied from interface: ApmDomainAsync

Returns a (paginated) list of work requests in a given compartment.

Specified by:

listWorkRequests in interface ApmDomainAsync

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.

removeDataKeys

public Future<RemoveDataKeysResponse> removeDataKeys(RemoveDataKeysRequest request,
                                                     AsyncHandler<RemoveDataKeysRequest,RemoveDataKeysResponse> handler)

Description copied from interface: ApmDomainAsync

Removes the set of specified Data Keys from the specified APM domain. Agents would no longer be able to use these data keys to upload to the APM domain once this operation is completed.

Specified by:

removeDataKeys in interface ApmDomainAsync

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.

updateApmDomain

public Future<UpdateApmDomainResponse> updateApmDomain(UpdateApmDomainRequest request,
                                                       AsyncHandler<UpdateApmDomainRequest,UpdateApmDomainResponse> handler)

Description copied from interface: ApmDomainAsync

Updates the APM domain.

Specified by:

updateApmDomain in interface ApmDomainAsync

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)