com.amazonaws.services.xray.AWSXRay Maven / Gradle / Ivy
Show all versions of aws-java-sdk-xray Show documentation
/*
* Copyright 2012-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.xray;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.xray.model.*;
/**
* Interface for accessing AWS X-Ray.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.xray.AbstractAWSXRay} instead.
*
*
*
* AWS X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing
* those traces.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSXRay {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "xray";
/**
* Overrides the default endpoint for this client ("xray.us-east-1.amazonaws.com"). Callers can use this method to
* control which AWS region they want to work with.
*
* Callers can pass in just the endpoint (ex: "xray.us-east-1.amazonaws.com") or a full URL, including the protocol
* (ex: "xray.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this
* client's {@link ClientConfiguration} will be used, which by default is HTTPS.
*
* For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available
* endpoints for all AWS services, see:
* http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
*
* This method is not threadsafe. An endpoint should be configured when the client is created and before any
* service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in
* transit or retrying.
*
* @param endpoint
* The endpoint (ex: "xray.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
* "xray.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
*/
void setEndpoint(String endpoint);
/**
* An alternative to {@link AWSXRay#setEndpoint(String)}, sets the regional endpoint for this client's service
* calls. Callers can use this method to control which AWS region they want to work with.
*
* By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
* {@link ClientConfiguration} supplied at construction.
*
* This method is not threadsafe. A region should be configured when the client is created and before any service
* requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit
* or retrying.
*
* @param region
* The region this client will communicate with. See {@link Region#getRegion(com.amazonaws.regions.Regions)}
* for accessing a given region. Must not be null and must be a region where the service is available.
*
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
* @see Region#isServiceSupported(String)
*/
void setRegion(Region region);
/**
*
* Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from
* a single request. Use GetTraceSummaries to get a list of trace IDs.
*
*
* @param batchGetTracesRequest
* @return Result of the BatchGetTraces operation returned by the service.
* @throws InvalidRequestException
* The request is missing required parameters or has invalid parameters.
* @throws ThrottledException
* The request exceeds the maximum number of requests per second.
* @sample AWSXRay.BatchGetTraces
* @see AWS API
* Documentation
*/
BatchGetTracesResult batchGetTraces(BatchGetTracesRequest batchGetTracesRequest);
/**
*
* Retrieves a document that describes services that process incoming requests, and downstream services that they
* call as a result. Root services process incoming requests and make calls to downstream services. Root services
* are applications that use the AWS X-Ray SDK. Downstream services can be other applications, AWS resources, HTTP
* web APIs, or SQL databases.
*
*
* @param getServiceGraphRequest
* @return Result of the GetServiceGraph operation returned by the service.
* @throws InvalidRequestException
* The request is missing required parameters or has invalid parameters.
* @throws ThrottledException
* The request exceeds the maximum number of requests per second.
* @sample AWSXRay.GetServiceGraph
* @see AWS API
* Documentation
*/
GetServiceGraphResult getServiceGraph(GetServiceGraphRequest getServiceGraphRequest);
/**
*
* Retrieves a service graph for one or more specific trace IDs.
*
*
* @param getTraceGraphRequest
* @return Result of the GetTraceGraph operation returned by the service.
* @throws InvalidRequestException
* The request is missing required parameters or has invalid parameters.
* @throws ThrottledException
* The request exceeds the maximum number of requests per second.
* @sample AWSXRay.GetTraceGraph
* @see AWS API
* Documentation
*/
GetTraceGraphResult getTraceGraph(GetTraceGraphRequest getTraceGraphRequest);
/**
*
* Retrieves IDs and metadata for traces available for a specified time frame using an optional filter. To get the
* full traces, pass the trace IDs to BatchGetTraces.
*
*
* @param getTraceSummariesRequest
* @return Result of the GetTraceSummaries operation returned by the service.
* @throws InvalidRequestException
* The request is missing required parameters or has invalid parameters.
* @throws ThrottledException
* The request exceeds the maximum number of requests per second.
* @sample AWSXRay.GetTraceSummaries
* @see AWS API
* Documentation
*/
GetTraceSummariesResult getTraceSummaries(GetTraceSummariesRequest getTraceSummariesRequest);
/**
*
* Used by the AWS X-Ray daemon to upload telemetry.
*
*
* @param putTelemetryRecordsRequest
* @return Result of the PutTelemetryRecords operation returned by the service.
* @throws InvalidRequestException
* The request is missing required parameters or has invalid parameters.
* @throws ThrottledException
* The request exceeds the maximum number of requests per second.
* @sample AWSXRay.PutTelemetryRecords
* @see AWS API
* Documentation
*/
PutTelemetryRecordsResult putTelemetryRecords(PutTelemetryRecordsRequest putTelemetryRecordsRequest);
/**
*
* Uploads segment documents to AWS X-Ray. The X-Ray SDK generates segment documents and sends them to the X-Ray
* daemon, which uploads them in batches. A segment document can be a completed segment, an in-progress segment, or
* an array of subsegments.
*
*
* @param putTraceSegmentsRequest
* @return Result of the PutTraceSegments operation returned by the service.
* @throws InvalidRequestException
* The request is missing required parameters or has invalid parameters.
* @throws ThrottledException
* The request exceeds the maximum number of requests per second.
* @sample AWSXRay.PutTraceSegments
* @see AWS API
* Documentation
*/
PutTraceSegmentsResult putTraceSegments(PutTraceSegmentsRequest putTraceSegmentsRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
* information for an executed request, you should use this method to retrieve it as soon as possible after
* executing a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}