com.oracle.bmc.apmconfig

Interface ConfigAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ConfigAsyncClient

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

Use the Application Performance Monitoring Configuration API to query and set Application Performance Monitoring configuration. For more information, see Application Performance Monitoring.

Method Summary

Modifier and Type	Method and Description
Future<CreateConfigResponse>	createConfig(CreateConfigRequest request, AsyncHandler<CreateConfigRequest,CreateConfigResponse> handler) Creates a new configuration item.
Future<DeleteConfigResponse>	deleteConfig(DeleteConfigRequest request, AsyncHandler<DeleteConfigRequest,DeleteConfigResponse> handler) Deletes the configuration item identified by the OCID.
Future<GetConfigResponse>	getConfig(GetConfigRequest request, AsyncHandler<GetConfigRequest,GetConfigResponse> handler) Gets the configuration item identified by the OCID.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<ListConfigsResponse>	listConfigs(ListConfigsRequest request, AsyncHandler<ListConfigsRequest,ListConfigsResponse> handler) Returns all configuration items, which can optionally be filtered by configuration type.
void	refreshClient() Rebuilds the client from scratch.
Future<RetrieveNamespaceMetricsResponse>	retrieveNamespaceMetrics(RetrieveNamespaceMetricsRequest request, AsyncHandler<RetrieveNamespaceMetricsRequest,RetrieveNamespaceMetricsResponse> handler) Returns all metrics associated with the specified namespace.
Future<RetrieveNamespacesResponse>	retrieveNamespaces(RetrieveNamespacesRequest request, AsyncHandler<RetrieveNamespacesRequest,RetrieveNamespacesResponse> handler) Returns all namespaces available in APM.
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<TestResponse>	test(TestRequest request, AsyncHandler<TestRequest,TestResponse> handler) Tests a data processing operation on the provided input, returning the potentially modified input as output.
Future<UpdateConfigResponse>	updateConfig(UpdateConfigRequest request, AsyncHandler<UpdateConfigRequest,UpdateConfigResponse> handler) Updates the details of the configuration item identified by the OCID.
void	useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled) Determines whether realm specific endpoint should be used or not.
Future<ValidateSpanFilterPatternResponse>	validateSpanFilterPattern(ValidateSpanFilterPatternRequest request, AsyncHandler<ValidateSpanFilterPatternRequest,ValidateSpanFilterPatternResponse> handler) Validates the Span Filter pattern (filterText) for syntactic correctness.

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

createConfig

Future<CreateConfigResponse> createConfig(CreateConfigRequest request,
                                          AsyncHandler<CreateConfigRequest,CreateConfigResponse> handler)

Creates a new configuration item.

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.

deleteConfig

Future<DeleteConfigResponse> deleteConfig(DeleteConfigRequest request,
                                          AsyncHandler<DeleteConfigRequest,DeleteConfigResponse> handler)

Deletes the configuration item identified by the 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.

getConfig

Future<GetConfigResponse> getConfig(GetConfigRequest request,
                                    AsyncHandler<GetConfigRequest,GetConfigResponse> handler)

Gets the configuration item identified by the 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.

listConfigs

Future<ListConfigsResponse> listConfigs(ListConfigsRequest request,
                                        AsyncHandler<ListConfigsRequest,ListConfigsResponse> handler)

Returns all configuration items, which can optionally be filtered by configuration type.

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.

retrieveNamespaceMetrics

Future<RetrieveNamespaceMetricsResponse> retrieveNamespaceMetrics(RetrieveNamespaceMetricsRequest request,
                                                                  AsyncHandler<RetrieveNamespaceMetricsRequest,RetrieveNamespaceMetricsResponse> handler)

Returns all metrics associated with the specified namespace.

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.

retrieveNamespaces

Future<RetrieveNamespacesResponse> retrieveNamespaces(RetrieveNamespacesRequest request,
                                                      AsyncHandler<RetrieveNamespacesRequest,RetrieveNamespacesResponse> handler)

Returns all namespaces available in APM.

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.

test

Future<TestResponse> test(TestRequest request,
                          AsyncHandler<TestRequest,TestResponse> handler)

Tests a data processing operation on the provided input, returning the potentially modified input as output. Returns 200 on success, 422 when the input can not be processed.

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.

updateConfig

Future<UpdateConfigResponse> updateConfig(UpdateConfigRequest request,
                                          AsyncHandler<UpdateConfigRequest,UpdateConfigResponse> handler)

Updates the details of the configuration item identified by the 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.

validateSpanFilterPattern

Future<ValidateSpanFilterPatternResponse> validateSpanFilterPattern(ValidateSpanFilterPatternRequest request,
                                                                    AsyncHandler<ValidateSpanFilterPatternRequest,ValidateSpanFilterPatternResponse> handler)

Validates the Span Filter pattern (filterText) for syntactic correctness. Returns 204 on success, 422 when validation fails.

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.