Config (Oracle Cloud Infrastructure Java SDK

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ConfigClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210201")
public interface Config
extends AutoCloseable
```
Use the Application Performance Monitoring Configuration API to query and set Application Performance Monitoring configuration. 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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CreateConfigResponse`	`createConfig(CreateConfigRequest request)` Creates a new configuration item.
`DeleteConfigResponse`	`deleteConfig(DeleteConfigRequest request)` Deletes the configuration item identified by the OCID.
`GetConfigResponse`	`getConfig(GetConfigRequest request)` Gets the configuration item identified by the OCID.
`String`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`ConfigPaginators`	`getPaginators()` Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`ListConfigsResponse`	`listConfigs(ListConfigsRequest request)` Returns all configuration items, which can optionally be filtered by configuration type.
`void`	`refreshClient()` Rebuilds the client from scratch.
`RetrieveNamespaceMetricsResponse`	`retrieveNamespaceMetrics(RetrieveNamespaceMetricsRequest request)` Returns all metrics associated with the specified namespace.
`RetrieveNamespacesResponse`	`retrieveNamespaces(RetrieveNamespacesRequest request)` 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’).
`TestResponse`	`test(TestRequest request)` Tests a data processing operation on the provided input, returning the potentially modified input as output.
`UpdateConfigResponse`	`updateConfig(UpdateConfigRequest request)` 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.
`ValidateSpanFilterPatternResponse`	`validateSpanFilterPattern(ValidateSpanFilterPatternRequest request)` 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 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
  - createConfig
```
CreateConfigResponse createConfig(CreateConfigRequest request)
```
    Creates a new configuration item.
    
    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 CreateConfig API.
  - deleteConfig
```
DeleteConfigResponse deleteConfig(DeleteConfigRequest request)
```
    Deletes the configuration item identified by the 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 DeleteConfig API.
  - getConfig
```
GetConfigResponse getConfig(GetConfigRequest request)
```
    Gets the configuration item identified by the 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 GetConfig API.
  - listConfigs
```
ListConfigsResponse listConfigs(ListConfigsRequest request)
```
    Returns all configuration items, which can optionally be filtered by configuration type.
    
    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 ListConfigs API.
  - retrieveNamespaceMetrics
```
RetrieveNamespaceMetricsResponse retrieveNamespaceMetrics(RetrieveNamespaceMetricsRequest request)
```
    Returns all metrics associated with the specified namespace.
    
    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 RetrieveNamespaceMetrics API.
  - retrieveNamespaces
```
RetrieveNamespacesResponse retrieveNamespaces(RetrieveNamespacesRequest request)
```
    Returns all namespaces available in APM.
    
    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 RetrieveNamespaces API.
  - test
```
TestResponse test(TestRequest request)
```
    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
    
    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 Test API.
  - updateConfig
```
UpdateConfigResponse updateConfig(UpdateConfigRequest request)
```
    Updates the details of the configuration item identified by the 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 UpdateConfig API.
  - validateSpanFilterPattern
```
ValidateSpanFilterPatternResponse validateSpanFilterPattern(ValidateSpanFilterPatternRequest request)
```
    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
    
    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 ValidateSpanFilterPattern API.
  - getPaginators
```
ConfigPaginators 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.

Interface Config

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

createConfig

deleteConfig

getConfig

listConfigs

retrieveNamespaceMetrics

retrieveNamespaces

test

updateConfig

validateSpanFilterPattern

getPaginators