com.oracle.bmc.apmtraces

Class TraceClient

java.lang.Object

com.oracle.bmc.apmtraces.TraceClient

All Implemented Interfaces:

Trace, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200630")
public class TraceClient
extends Object
implements Trace

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static Service	SERVICE Service instance for Trace.

Constructor Summary

Constructors

Modifier	Constructor and Description
	TraceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Creates a new service instance using the given authentication provider and client configuration.
	TraceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Creates a new service instance using the given authentication provider and client configuration.
	TraceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Creates a new service instance using the given authentication provider and client configuration.
	TraceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Creates a new service instance using the given authentication provider and client configuration.
protected	TraceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, RestClientFactoryBuilder restClientFactoryBuilder) Creates a new service instance using the given authentication provider and client configuration.
	TraceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Creates a new service instance using the given authentication provider.
	TraceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Creates a new service instance using the given authentication provider and client configuration.
	TraceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Creates a new service instance using the given authentication provider and client configuration.

Method Summary

Modifier and Type	Method and Description
static TraceClient.Builder	builder() Create a builder for this client.
void	close()
GetAggregatedSnapshotResponse	getAggregatedSnapshot(GetAggregatedSnapshotRequest request) Gets the aggregated snapshot identified by trace ID.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
GetSpanResponse	getSpan(GetSpanRequest request) Gets the span details identified by spanId.
GetTraceResponse	getTrace(GetTraceRequest request) Gets the trace details identified by traceId.
GetTraceSnapshotResponse	getTraceSnapshot(GetTraceSnapshotRequest request) Gets the trace snapshots data identified by trace ID.
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’).

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Trace.

Constructor Detail

TraceClient

public TraceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Creates a new service instance using the given authentication provider.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

TraceClient

public TraceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                   ClientConfiguration configuration)

Creates a new service instance using the given authentication provider and client configuration.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

TraceClient

public TraceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                   ClientConfiguration configuration,
                   ClientConfigurator clientConfigurator)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

TraceClient

public TraceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                   ClientConfiguration configuration,
                   ClientConfigurator clientConfigurator,
                   RequestSignerFactory defaultRequestSignerFactory)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

TraceClient

public TraceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                   ClientConfiguration configuration,
                   ClientConfigurator clientConfigurator,
                   RequestSignerFactory defaultRequestSignerFactory,
                   List<ClientConfigurator> additionalClientConfigurators)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

TraceClient

public TraceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                   ClientConfiguration configuration,
                   ClientConfigurator clientConfigurator,
                   RequestSignerFactory defaultRequestSignerFactory,
                   List<ClientConfigurator> additionalClientConfigurators,
                   String endpoint)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

TraceClient

public TraceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                   ClientConfiguration configuration,
                   ClientConfigurator clientConfigurator,
                   RequestSignerFactory defaultRequestSignerFactory,
                   Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                   List<ClientConfigurator> additionalClientConfigurators,
                   String endpoint)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

TraceClient

protected TraceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                      ClientConfiguration configuration,
                      ClientConfigurator clientConfigurator,
                      RequestSignerFactory defaultRequestSignerFactory,
                      Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                      List<ClientConfigurator> additionalClientConfigurators,
                      String endpoint,
                      RestClientFactoryBuilder restClientFactoryBuilder)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed. Use the TraceClient.Builder to get access to all these parameters.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

restClientFactoryBuilder - the builder for the RestClientFactory

Method Detail

builder

public static TraceClient.Builder builder()

Create a builder for this client.

Returns:

builder

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: Trace

Sets the endpoint to call (ex, https://www.example.com).

Specified by:

setEndpoint in interface Trace

Parameters:

endpoint - The endpoint of the service.

getEndpoint

public String getEndpoint()

Description copied from interface: Trace

Gets the set endpoint for REST call (ex, https://www.example.com)

Specified by:

getEndpoint in interface Trace

setRegion

public void setRegion(Region region)

Description copied from interface: Trace

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 Trace

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: Trace

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 Trace

Parameters:

regionId - The public region ID.

close

public void close()

Specified by:

close in interface AutoCloseable

getAggregatedSnapshot

public GetAggregatedSnapshotResponse getAggregatedSnapshot(GetAggregatedSnapshotRequest request)

Description copied from interface: Trace

Gets the aggregated snapshot identified by trace ID.

Specified by:

getAggregatedSnapshot in interface Trace

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getSpan

public GetSpanResponse getSpan(GetSpanRequest request)

Description copied from interface: Trace

Gets the span details identified by spanId.

Specified by:

getSpan in interface Trace

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getTrace

public GetTraceResponse getTrace(GetTraceRequest request)

Description copied from interface: Trace

Gets the trace details identified by traceId.

Specified by:

getTrace in interface Trace

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getTraceSnapshot

public GetTraceSnapshotResponse getTraceSnapshot(GetTraceSnapshotRequest request)

Description copied from interface: Trace

Gets the trace snapshots data identified by trace ID.

Specified by:

getTraceSnapshot in interface Trace

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation