com.oracle.bmc.apmtraces.TraceAsyncClient Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of oci-java-sdk-apmtraces Show documentation
Show all versions of oci-java-sdk-apmtraces Show documentation
This project contains the SDK used for Oracle Cloud Infrastructure Apm Traces
/**
* Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved.
* This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
*/
package com.oracle.bmc.apmtraces;
import com.oracle.bmc.util.internal.Validate;
import com.oracle.bmc.apmtraces.requests.*;
import com.oracle.bmc.apmtraces.responses.*;
import java.util.Objects;
/**
* Async client implementation for Trace service.
* There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response
* to the call is an {@link java.io.InputStream}, like getObject Api in object storage service,
* developers need to process the stream in AsyncHandler, and not anywhere else, because the stream
* will be closed right after the AsyncHandler is invoked.
* 2. Use Java Future: using Java Future, developers need to close the stream after they are done
* with the Java Future.
* Accessing the result should be done in a mutually exclusive manner, either through the Future or
* the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the
* AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine
* whether or not the request was completed via Future.isDone/isCancelled.
* Please refer to
* https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java
*/
@jakarta.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20200630")
public class TraceAsyncClient extends com.oracle.bmc.http.internal.BaseAsyncClient
implements TraceAsync {
/** Service instance for Trace. */
public static final com.oracle.bmc.Service SERVICE =
com.oracle.bmc.Services.serviceBuilder()
.serviceName("TRACE")
.serviceEndpointPrefix("")
.serviceEndpointTemplate("https://apm-trace.{region}.oci.{secondLevelDomain}")
.build();
private static final org.slf4j.Logger LOG =
org.slf4j.LoggerFactory.getLogger(TraceAsyncClient.class);
TraceAsyncClient(
com.oracle.bmc.common.ClientBuilderBase builder,
com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider
authenticationDetailsProvider) {
super(builder, authenticationDetailsProvider);
}
/**
* Create a builder for this client.
*
* @return builder
*/
public static Builder builder() {
return new Builder(SERVICE);
}
/**
* Builder class for this client. The "authenticationDetailsProvider" is required and must be
* passed to the {@link #build(AbstractAuthenticationDetailsProvider)} method.
*/
public static class Builder
extends com.oracle.bmc.common.RegionalClientBuilder {
private Builder(com.oracle.bmc.Service service) {
super(service);
final String packageName = "apmtraces";
com.oracle.bmc.internal.Alloy.throwDisabledServiceExceptionIfAppropriate(packageName);
requestSignerFactory =
new com.oracle.bmc.http.signing.internal.DefaultRequestSignerFactory(
com.oracle.bmc.http.signing.SigningStrategy.STANDARD);
}
/**
* Build the client.
*
* @param authenticationDetailsProvider authentication details provider
* @return the client
*/
public TraceAsyncClient build(
@jakarta.annotation.Nonnull
com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider
authenticationDetailsProvider) {
return new TraceAsyncClient(this, authenticationDetailsProvider);
}
}
@Override
public void setRegion(com.oracle.bmc.Region region) {
super.setRegion(region);
}
@Override
public void setRegion(String regionId) {
super.setRegion(regionId);
}
@Override
public java.util.concurrent.Future getAggregatedSnapshot(
GetAggregatedSnapshotRequest request,
final com.oracle.bmc.responses.AsyncHandler<
GetAggregatedSnapshotRequest, GetAggregatedSnapshotResponse>
handler) {
Objects.requireNonNull(request.getApmDomainId(), "apmDomainId is required");
Validate.notBlank(request.getTraceKey(), "traceKey must not be blank");
return clientCall(request, GetAggregatedSnapshotResponse::builder)
.logger(LOG, "getAggregatedSnapshot")
.serviceDetails(
"Trace",
"GetAggregatedSnapshot",
"https://docs.oracle.com/iaas/api/#/en/apm-trace-explorer/20200630/AggregatedSnapshot/GetAggregatedSnapshot")
.method(com.oracle.bmc.http.client.Method.GET)
.requestBuilder(GetAggregatedSnapshotRequest::builder)
.basePath("/20200630")
.appendPathParam("traces")
.appendPathParam(request.getTraceKey())
.appendPathParam("aggregatedSnapshotData")
.appendQueryParam("apmDomainId", request.getApmDomainId())
.appendQueryParam("serviceName", request.getServiceName())
.appendQueryParam("serverName", request.getServerName())
.appendQueryParam("spanKey", request.getSpanKey())
.appendQueryParam("spanName", request.getSpanName())
.accept("application/json")
.appendHeader("opc-request-id", request.getOpcRequestId())
.handleBody(
com.oracle.bmc.apmtraces.model.AggregatedSnapshot.class,
GetAggregatedSnapshotResponse.Builder::aggregatedSnapshot)
.handleResponseHeaderString(
"opc-request-id", GetAggregatedSnapshotResponse.Builder::opcRequestId)
.callAsync(handler);
}
@Override
public java.util.concurrent.Future getSpan(
GetSpanRequest request,
final com.oracle.bmc.responses.AsyncHandler handler) {
Objects.requireNonNull(request.getApmDomainId(), "apmDomainId is required");
Validate.notBlank(request.getSpanKey(), "spanKey must not be blank");
Validate.notBlank(request.getTraceKey(), "traceKey must not be blank");
return clientCall(request, GetSpanResponse::builder)
.logger(LOG, "getSpan")
.serviceDetails(
"Trace",
"GetSpan",
"https://docs.oracle.com/iaas/api/#/en/apm-trace-explorer/20200630/Span/GetSpan")
.method(com.oracle.bmc.http.client.Method.GET)
.requestBuilder(GetSpanRequest::builder)
.basePath("/20200630")
.appendPathParam("spans")
.appendPathParam(request.getTraceKey())
.appendPathParam(request.getSpanKey())
.appendQueryParam("apmDomainId", request.getApmDomainId())
.appendQueryParam(
"timeSpanStartedGreaterThanOrEqualTo",
request.getTimeSpanStartedGreaterThanOrEqualTo())
.appendQueryParam("timeSpanStartedLessThan", request.getTimeSpanStartedLessThan())
.appendEnumQueryParam("spanNamespace", request.getSpanNamespace())
.accept("application/json")
.appendHeader("opc-request-id", request.getOpcRequestId())
.handleBody(
com.oracle.bmc.apmtraces.model.Span.class, GetSpanResponse.Builder::span)
.handleResponseHeaderString("opc-request-id", GetSpanResponse.Builder::opcRequestId)
.callAsync(handler);
}
@Override
public java.util.concurrent.Future getTrace(
GetTraceRequest request,
final com.oracle.bmc.responses.AsyncHandler
handler) {
Objects.requireNonNull(request.getApmDomainId(), "apmDomainId is required");
Validate.notBlank(request.getTraceKey(), "traceKey must not be blank");
return clientCall(request, GetTraceResponse::builder)
.logger(LOG, "getTrace")
.serviceDetails(
"Trace",
"GetTrace",
"https://docs.oracle.com/iaas/api/#/en/apm-trace-explorer/20200630/Trace/GetTrace")
.method(com.oracle.bmc.http.client.Method.GET)
.requestBuilder(GetTraceRequest::builder)
.basePath("/20200630")
.appendPathParam("traces")
.appendPathParam(request.getTraceKey())
.appendQueryParam("apmDomainId", request.getApmDomainId())
.appendQueryParam(
"timeTraceStartedGreaterThanOrEqualTo",
request.getTimeTraceStartedGreaterThanOrEqualTo())
.appendQueryParam("timeTraceStartedLessThan", request.getTimeTraceStartedLessThan())
.appendEnumQueryParam("traceNamespace", request.getTraceNamespace())
.accept("application/json")
.appendHeader("opc-request-id", request.getOpcRequestId())
.handleBody(
com.oracle.bmc.apmtraces.model.Trace.class, GetTraceResponse.Builder::trace)
.handleResponseHeaderString(
"opc-request-id", GetTraceResponse.Builder::opcRequestId)
.callAsync(handler);
}
@Override
public java.util.concurrent.Future getTraceSnapshot(
GetTraceSnapshotRequest request,
final com.oracle.bmc.responses.AsyncHandler<
GetTraceSnapshotRequest, GetTraceSnapshotResponse>
handler) {
Objects.requireNonNull(request.getApmDomainId(), "apmDomainId is required");
Validate.notBlank(request.getTraceKey(), "traceKey must not be blank");
return clientCall(request, GetTraceSnapshotResponse::builder)
.logger(LOG, "getTraceSnapshot")
.serviceDetails(
"Trace",
"GetTraceSnapshot",
"https://docs.oracle.com/iaas/api/#/en/apm-trace-explorer/20200630/TraceSnapshot/GetTraceSnapshot")
.method(com.oracle.bmc.http.client.Method.GET)
.requestBuilder(GetTraceSnapshotRequest::builder)
.basePath("/20200630")
.appendPathParam("traces")
.appendPathParam(request.getTraceKey())
.appendPathParam("snapshotData")
.appendQueryParam("apmDomainId", request.getApmDomainId())
.appendQueryParam("isSummarized", request.getIsSummarized())
.appendQueryParam("threadId", request.getThreadId())
.appendQueryParam("snapshotTime", request.getSnapshotTime())
.accept("application/json")
.appendHeader("opc-request-id", request.getOpcRequestId())
.handleBody(
com.oracle.bmc.apmtraces.model.TraceSnapshot.class,
GetTraceSnapshotResponse.Builder::traceSnapshot)
.handleResponseHeaderString(
"opc-request-id", GetTraceSnapshotResponse.Builder::opcRequestId)
.callAsync(handler);
}
/**
* Create a new client instance.
*
* @param authenticationDetailsProvider The authentication details (see {@link Builder#build})
* @deprecated Use the {@link #builder() builder} instead.
*/
@Deprecated
public TraceAsyncClient(
com.oracle.bmc.auth.BasicAuthenticationDetailsProvider authenticationDetailsProvider) {
this(builder(), authenticationDetailsProvider);
}
/**
* Create a new client instance.
*
* @param authenticationDetailsProvider The authentication details (see {@link Builder#build})
* @param configuration {@link Builder#configuration}
* @deprecated Use the {@link #builder() builder} instead.
*/
@Deprecated
public TraceAsyncClient(
com.oracle.bmc.auth.BasicAuthenticationDetailsProvider authenticationDetailsProvider,
com.oracle.bmc.ClientConfiguration configuration) {
this(builder().configuration(configuration), authenticationDetailsProvider);
}
/**
* Create a new client instance.
*
* @param authenticationDetailsProvider The authentication details (see {@link Builder#build})
* @param configuration {@link Builder#configuration}
* @param clientConfigurator {@link Builder#clientConfigurator}
* @deprecated Use the {@link #builder() builder} instead.
*/
@Deprecated
public TraceAsyncClient(
com.oracle.bmc.auth.BasicAuthenticationDetailsProvider authenticationDetailsProvider,
com.oracle.bmc.ClientConfiguration configuration,
com.oracle.bmc.http.ClientConfigurator clientConfigurator) {
this(
builder().configuration(configuration).clientConfigurator(clientConfigurator),
authenticationDetailsProvider);
}
/**
* Create a new client instance.
*
* @param authenticationDetailsProvider The authentication details (see {@link Builder#build})
* @param configuration {@link Builder#configuration}
* @param clientConfigurator {@link Builder#clientConfigurator}
* @param defaultRequestSignerFactory {@link Builder#requestSignerFactory}
* @deprecated Use the {@link #builder() builder} instead.
*/
@Deprecated
public TraceAsyncClient(
com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
com.oracle.bmc.ClientConfiguration configuration,
com.oracle.bmc.http.ClientConfigurator clientConfigurator,
com.oracle.bmc.http.signing.RequestSignerFactory defaultRequestSignerFactory) {
this(
builder()
.configuration(configuration)
.clientConfigurator(clientConfigurator)
.requestSignerFactory(defaultRequestSignerFactory),
authenticationDetailsProvider);
}
/**
* Create a new client instance.
*
* @param authenticationDetailsProvider The authentication details (see {@link Builder#build})
* @param configuration {@link Builder#configuration}
* @param clientConfigurator {@link Builder#clientConfigurator}
* @param defaultRequestSignerFactory {@link Builder#requestSignerFactory}
* @param additionalClientConfigurators {@link Builder#additionalClientConfigurators}
* @deprecated Use the {@link #builder() builder} instead.
*/
@Deprecated
public TraceAsyncClient(
com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
com.oracle.bmc.ClientConfiguration configuration,
com.oracle.bmc.http.ClientConfigurator clientConfigurator,
com.oracle.bmc.http.signing.RequestSignerFactory defaultRequestSignerFactory,
java.util.List additionalClientConfigurators) {
this(
builder()
.configuration(configuration)
.clientConfigurator(clientConfigurator)
.requestSignerFactory(defaultRequestSignerFactory)
.additionalClientConfigurators(additionalClientConfigurators),
authenticationDetailsProvider);
}
/**
* Create a new client instance.
*
* @param authenticationDetailsProvider The authentication details (see {@link Builder#build})
* @param configuration {@link Builder#configuration}
* @param clientConfigurator {@link Builder#clientConfigurator}
* @param defaultRequestSignerFactory {@link Builder#requestSignerFactory}
* @param additionalClientConfigurators {@link Builder#additionalClientConfigurators}
* @param endpoint {@link Builder#endpoint}
* @deprecated Use the {@link #builder() builder} instead.
*/
@Deprecated
public TraceAsyncClient(
com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
com.oracle.bmc.ClientConfiguration configuration,
com.oracle.bmc.http.ClientConfigurator clientConfigurator,
com.oracle.bmc.http.signing.RequestSignerFactory defaultRequestSignerFactory,
java.util.List additionalClientConfigurators,
String endpoint) {
this(
builder()
.configuration(configuration)
.clientConfigurator(clientConfigurator)
.requestSignerFactory(defaultRequestSignerFactory)
.additionalClientConfigurators(additionalClientConfigurators)
.endpoint(endpoint),
authenticationDetailsProvider);
}
/**
* Create a new client instance.
*
* @param authenticationDetailsProvider The authentication details (see {@link Builder#build})
* @param configuration {@link Builder#configuration}
* @param clientConfigurator {@link Builder#clientConfigurator}
* @param defaultRequestSignerFactory {@link Builder#requestSignerFactory}
* @param additionalClientConfigurators {@link Builder#additionalClientConfigurators}
* @param endpoint {@link Builder#endpoint}
* @param signingStrategyRequestSignerFactories {@link
* Builder#signingStrategyRequestSignerFactories}
* @deprecated Use the {@link #builder() builder} instead.
*/
@Deprecated
public TraceAsyncClient(
com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
com.oracle.bmc.ClientConfiguration configuration,
com.oracle.bmc.http.ClientConfigurator clientConfigurator,
com.oracle.bmc.http.signing.RequestSignerFactory defaultRequestSignerFactory,
java.util.Map<
com.oracle.bmc.http.signing.SigningStrategy,
com.oracle.bmc.http.signing.RequestSignerFactory>
signingStrategyRequestSignerFactories,
java.util.List additionalClientConfigurators,
String endpoint) {
this(
builder()
.configuration(configuration)
.clientConfigurator(clientConfigurator)
.requestSignerFactory(defaultRequestSignerFactory)
.additionalClientConfigurators(additionalClientConfigurators)
.endpoint(endpoint)
.signingStrategyRequestSignerFactories(
signingStrategyRequestSignerFactories),
authenticationDetailsProvider);
}
}