com.oracle.bmc.apmcontrolplane

Interface ApmDomain

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ApmDomainClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200630")
public interface ApmDomain
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.

This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

Modifier and Type	Method and Description
ChangeApmDomainCompartmentResponse	changeApmDomainCompartment(ChangeApmDomainCompartmentRequest request) Moves an APM domain into a different compartment.
CreateApmDomainResponse	createApmDomain(CreateApmDomainRequest request) Creates a new APM domain.
DeleteApmDomainResponse	deleteApmDomain(DeleteApmDomainRequest request) Deletes the specified APM domain asynchronously.
GenerateDataKeysResponse	generateDataKeys(GenerateDataKeysRequest request) Generates a set of new Data Keys for the specified APM domain with the specified names and types.
GetApmDomainResponse	getApmDomain(GetApmDomainRequest request) Gets the details of the APM domain specified by OCID.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
ApmDomainPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
ApmDomainWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
GetWorkRequestResponse	getWorkRequest(GetWorkRequestRequest request) Gets the details of the work request with the given ID.
ListApmDomainsResponse	listApmDomains(ListApmDomainsRequest request) Lists all APM domains for the specified tenant compartment.
ListApmDomainWorkRequestsResponse	listApmDomainWorkRequests(ListApmDomainWorkRequestsRequest request) Returns a (paginated) list of work requests related to a specific APM domain.
ListDataKeysResponse	listDataKeys(ListDataKeysRequest request) Lists all Data Keys for the specified APM domain.
ListWorkRequestErrorsResponse	listWorkRequestErrors(ListWorkRequestErrorsRequest request) Returns a (paginated) list of errors for a given work request.
ListWorkRequestLogsResponse	listWorkRequestLogs(ListWorkRequestLogsRequest request) Returns a (paginated) list of logs for a given work request.
ListWorkRequestsResponse	listWorkRequests(ListWorkRequestsRequest request) Returns a (paginated) list of work requests in a given compartment.
void	refreshClient() Rebuilds the client from scratch.
RemoveDataKeysResponse	removeDataKeys(RemoveDataKeysRequest request) 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’).
UpdateApmDomainResponse	updateApmDomain(UpdateApmDomainRequest request) 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 service.

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

ChangeApmDomainCompartmentResponse changeApmDomainCompartment(ChangeApmDomainCompartmentRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ChangeApmDomainCompartment API.

createApmDomain

CreateApmDomainResponse createApmDomain(CreateApmDomainRequest request)

Creates a new APM domain.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use CreateApmDomain API.

deleteApmDomain

DeleteApmDomainResponse deleteApmDomain(DeleteApmDomainRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use DeleteApmDomain API.

generateDataKeys

GenerateDataKeysResponse generateDataKeys(GenerateDataKeysRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GenerateDataKeys API.

getApmDomain

GetApmDomainResponse getApmDomain(GetApmDomainRequest request)

Gets the details of the APM domain specified by OCID.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetApmDomain API.

getWorkRequest

GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetWorkRequest API.

listApmDomainWorkRequests

ListApmDomainWorkRequestsResponse listApmDomainWorkRequests(ListApmDomainWorkRequestsRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListApmDomainWorkRequests API.

listApmDomains

ListApmDomainsResponse listApmDomains(ListApmDomainsRequest request)

Lists all APM domains for the specified tenant compartment.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListApmDomains API.

listDataKeys

ListDataKeysResponse listDataKeys(ListDataKeysRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListDataKeys API.

listWorkRequestErrors

ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListWorkRequestErrors API.

listWorkRequestLogs

ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListWorkRequestLogs API.

listWorkRequests

ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListWorkRequests API.

removeDataKeys

RemoveDataKeysResponse removeDataKeys(RemoveDataKeysRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use RemoveDataKeys API.

updateApmDomain

UpdateApmDomainResponse updateApmDomain(UpdateApmDomainRequest request)

Updates the APM domain.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use UpdateApmDomain API.

getWaiters

ApmDomainWaiters getWaiters()

Gets the pre-configured waiters available for resources for this service.

Returns:

The service waiters.

getPaginators

ApmDomainPaginators getPaginators()

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Returns:

The service paginators.