com.oracle.bmc.apmcontrolplane

Interface ApmDomainAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ApmDomainAsyncClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200630")
public interface ApmDomainAsync
extends AutoCloseable

Use the Application Performance Monitoring Control Plane API to perform operations such as creating, updating, deleting and listing APM domains and monitoring the progress of these operations using the work request APIs. For more information, see Application Performance Monitoring.

Method Summary

Modifier and Type	Method and Description
Future<ChangeApmDomainCompartmentResponse>	changeApmDomainCompartment(ChangeApmDomainCompartmentRequest request, AsyncHandler<ChangeApmDomainCompartmentRequest,ChangeApmDomainCompartmentResponse> handler) Moves an APM domain into a different compartment.
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	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
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	refreshClient() Rebuilds the client from scratch.
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) Sets the endpoint to call (ex, https://www.example.com).
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	useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled) Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

refreshClient

void refreshClient()

Rebuilds the client from scratch. Useful to refresh certificates.

setEndpoint

void setEndpoint(String endpoint)

Sets the endpoint to call (ex, https://www.example.com).

Parameters:

endpoint - The endpoint of the serice.

getEndpoint

String getEndpoint()

Gets the set endpoint for REST call (ex, https://www.example.com)

setRegion

void setRegion(Region region)

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.

Parameters:

region - The region of the service.

setRegion

void setRegion(String regionId)

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.

Parameters:

regionId - The public region ID.

useRealmSpecificEndpointTemplate

void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)

Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

Parameters:

realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

changeApmDomainCompartment

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

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

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

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

Creates a new APM domain.

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

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

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.

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

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. These will be added to the existing set of Data Keys for the specified APM domain.

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

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

Gets the details of the APM domain specified by OCID.

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

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

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

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

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

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

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

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

Lists all APM domains for the specified tenant compartment.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

Updates the APM domain.

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.