Package com.oracle.bmc.apmcontrolplane

Class ApmDomainClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.apmcontrolplane.ApmDomainClient

All Implemented Interfaces:

ApmDomain, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200630")
public class ApmDomainClient
extends BaseSyncClient
implements ApmDomain

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ApmDomainClient.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 ApmDomain.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static ApmDomainClient.Builder	builder()	Create a builder for this client.
ChangeApmDomainCompartmentResponse	changeApmDomainCompartment(ChangeApmDomainCompartmentRequest request)	Moves an APM domain into a different compartment.
void	close()
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	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
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	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.
RemoveDataKeysResponse	removeDataKeys(RemoveDataKeysRequest request)	Removes the set of specified Data Keys from the specified APM domain.
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’).
UpdateApmDomainResponse	updateApmDomain(UpdateApmDomainRequest request)	Updates the APM domain.
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)	This method should be used to enable or disable the use of realm-specific endpoint template.

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 com.oracle.bmc.apmcontrolplane.ApmDomain

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for ApmDomain.

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

ApmDomainClient

@Deprecated
public ApmDomainClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

ApmDomainClient

@Deprecated
public ApmDomainClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                       ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

ApmDomainClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

ApmDomainClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

ApmDomainClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

ApmDomainClient

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

ApmDomainClient

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

ApmDomainClient

@Deprecated
public ApmDomainClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                       ClientConfiguration configuration,
                       ClientConfigurator clientConfigurator,
                       RequestSignerFactory defaultRequestSignerFactory,
                       Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                       List<ClientConfigurator> additionalClientConfigurators,
                       String endpoint,
                       ExecutorService executorService)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ApmDomainClient.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

executorService - ApmDomainClient.Builder.executorService

Method Detail

builder

public static ApmDomainClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: ApmDomain

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 ApmDomain

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: ApmDomain

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 ApmDomain

Parameters:

regionId - The public region ID.

changeApmDomainCompartment

public ChangeApmDomainCompartmentResponse changeApmDomainCompartment(ChangeApmDomainCompartmentRequest request)

Description copied from interface: ApmDomain

Moves an APM domain into a different compartment.

When provided, If-Match is checked against ETag values of the APM domain.

Specified by:

changeApmDomainCompartment in interface ApmDomain

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createApmDomain

public CreateApmDomainResponse createApmDomain(CreateApmDomainRequest request)

Description copied from interface: ApmDomain

Creates a new APM domain.

Specified by:

createApmDomain in interface ApmDomain

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteApmDomain

public DeleteApmDomainResponse deleteApmDomain(DeleteApmDomainRequest request)

Description copied from interface: ApmDomain

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.

Specified by:

deleteApmDomain in interface ApmDomain

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

generateDataKeys

public GenerateDataKeysResponse generateDataKeys(GenerateDataKeysRequest request)

Description copied from interface: ApmDomain

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.

Specified by:

generateDataKeys in interface ApmDomain

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getApmDomain

public GetApmDomainResponse getApmDomain(GetApmDomainRequest request)

Description copied from interface: ApmDomain

Gets the details of the APM domain specified by OCID.

Specified by:

getApmDomain in interface ApmDomain

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWorkRequest

public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)

Description copied from interface: ApmDomain

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

Specified by:

getWorkRequest in interface ApmDomain

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listApmDomainWorkRequests

public ListApmDomainWorkRequestsResponse listApmDomainWorkRequests(ListApmDomainWorkRequestsRequest request)

Description copied from interface: ApmDomain

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

Specified by:

listApmDomainWorkRequests in interface ApmDomain

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listApmDomains

public ListApmDomainsResponse listApmDomains(ListApmDomainsRequest request)

Description copied from interface: ApmDomain

Lists all APM domains for the specified tenant compartment.

Specified by:

listApmDomains in interface ApmDomain

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listDataKeys

public ListDataKeysResponse listDataKeys(ListDataKeysRequest request)

Description copied from interface: ApmDomain

Lists all Data Keys for the specified APM domain.

The caller may filter the list by specifying the ‘dataKeyType’ query parameter.

Specified by:

listDataKeys in interface ApmDomain

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestErrors

public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)

Description copied from interface: ApmDomain

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

Specified by:

listWorkRequestErrors in interface ApmDomain

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestLogs

public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)

Description copied from interface: ApmDomain

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

Specified by:

listWorkRequestLogs in interface ApmDomain

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequests

public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)

Description copied from interface: ApmDomain

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

Specified by:

listWorkRequests in interface ApmDomain

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

removeDataKeys

public RemoveDataKeysResponse removeDataKeys(RemoveDataKeysRequest request)

Description copied from interface: ApmDomain

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.

Specified by:

removeDataKeys in interface ApmDomain

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateApmDomain

public UpdateApmDomainResponse updateApmDomain(UpdateApmDomainRequest request)

Description copied from interface: ApmDomain

Updates the APM domain.

Specified by:

updateApmDomain in interface ApmDomain

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public ApmDomainWaiters getWaiters()

Description copied from interface: ApmDomain

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

Specified by:

getWaiters in interface ApmDomain

Returns:

The service waiters.

getPaginators

public ApmDomainPaginators getPaginators()

Description copied from interface: ApmDomain

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 ApmDomain

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