Package com.oracle.bmc.apmconfig

Class ConfigClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.apmconfig.ConfigClient

All Implemented Interfaces:

Config, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210201")
public class ConfigClient
extends BaseSyncClient
implements Config

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	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 Config.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static ConfigClient.Builder	builder()	Create a builder for this client.
void	close()
CopyConfigurationResponse	copyConfiguration(CopyConfigurationRequest request)	Fast importing configuration items to a destination APM domain ID.
CreateConfigResponse	createConfig(CreateConfigRequest request)	Creates a new configuration item.
DeleteConfigResponse	deleteConfig(DeleteConfigRequest request)	Deletes the configuration item identified by the OCID.
ExportConfigurationResponse	exportConfiguration(ExportConfigurationRequest request)	Exports configurations for the whole domain by domainId.
String	getClientCommonLibraryVersion()
GetConfigResponse	getConfig(GetConfigRequest request)	Gets the configuration item identified by the OCID.
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
ConfigPaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
ImportConfigurationResponse	importConfiguration(ImportConfigurationRequest request)	Import configurations Item(s) with its dependencies into a destination domain.
ListConfigsResponse	listConfigs(ListConfigsRequest request)	Returns all configuration items, which can optionally be filtered by configuration type.
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.
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)
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.
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
UpdateConfigResponse	updateConfig(UpdateConfigRequest request)	Updates the details of the configuration item identified by the OCID.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)	This method should be used to enable or disable the use of realm-specific endpoint template.
ValidateSpanFilterPatternResponse	validateSpanFilterPattern(ValidateSpanFilterPatternRequest request)	Validates the Span Filter pattern (filterText) for syntactic correctness.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.apmconfig.Config

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Config.

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

ConfigClient

@Deprecated
public ConfigClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

ConfigClient

@Deprecated
public ConfigClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                    ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

ConfigClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

ConfigClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

ConfigClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

ConfigClient

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

ConfigClient

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

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: Config

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 Config

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: Config

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 Config

Parameters:

regionId - The public region ID.

copyConfiguration

public CopyConfigurationResponse copyConfiguration(CopyConfigurationRequest request)

Description copied from interface: Config

Fast importing configuration items to a destination APM domain ID.

Specified by:

copyConfiguration in interface Config

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createConfig

public CreateConfigResponse createConfig(CreateConfigRequest request)

Description copied from interface: Config

Creates a new configuration item.

Specified by:

createConfig in interface Config

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteConfig

public DeleteConfigResponse deleteConfig(DeleteConfigRequest request)

Description copied from interface: Config

Deletes the configuration item identified by the OCID.

Specified by:

deleteConfig in interface Config

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

exportConfiguration

public ExportConfigurationResponse exportConfiguration(ExportConfigurationRequest request)

Description copied from interface: Config

Exports configurations for the whole domain by domainId.

Specified by:

exportConfiguration in interface Config

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getConfig

public GetConfigResponse getConfig(GetConfigRequest request)

Description copied from interface: Config

Gets the configuration item identified by the OCID.

Specified by:

getConfig in interface Config

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

importConfiguration

public ImportConfigurationResponse importConfiguration(ImportConfigurationRequest request)

Description copied from interface: Config

Import configurations Item(s) with its dependencies into a destination domain.

Specified by:

importConfiguration in interface Config

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listConfigs

public ListConfigsResponse listConfigs(ListConfigsRequest request)

Description copied from interface: Config

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

Specified by:

listConfigs in interface Config

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

retrieveNamespaceMetrics

public RetrieveNamespaceMetricsResponse retrieveNamespaceMetrics(RetrieveNamespaceMetricsRequest request)

Description copied from interface: Config

Returns all metrics associated with the specified namespace.

Specified by:

retrieveNamespaceMetrics in interface Config

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

retrieveNamespaces

public RetrieveNamespacesResponse retrieveNamespaces(RetrieveNamespacesRequest request)

Description copied from interface: Config

Returns all namespaces available in APM.

Specified by:

retrieveNamespaces in interface Config

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

test

public TestResponse test(TestRequest request)

Description copied from interface: Config

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.

Specified by:

test in interface Config

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateConfig

public UpdateConfigResponse updateConfig(UpdateConfigRequest request)

Description copied from interface: Config

Updates the details of the configuration item identified by the OCID.

Specified by:

updateConfig in interface Config

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

validateSpanFilterPattern

public ValidateSpanFilterPatternResponse validateSpanFilterPattern(ValidateSpanFilterPatternRequest request)

Description copied from interface: Config

Validates the Span Filter pattern (filterText) for syntactic correctness.

Returns 204 on success, 422 when validation fails.

Specified by:

validateSpanFilterPattern in interface Config

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getPaginators

public ConfigPaginators getPaginators()

Description copied from interface: Config

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.

Specified by:

getPaginators in interface Config

Returns:

The service paginators.

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()