AbstractAWSXRay (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.xray.AbstractAWSXRay

All Implemented Interfaces:

AWSXRay

Direct Known Subclasses:

AbstractAWSXRayAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSXRay
extends Object
implements AWSXRay
```
Abstract implementation of AWSXRay. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.xray.AWSXRay
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchGetTracesResult`	`batchGetTraces(BatchGetTracesRequest request)` Retrieves a list of traces specified by ID.
`CreateSamplingRuleResult`	`createSamplingRule(CreateSamplingRuleRequest request)` Creates a rule to control sampling behavior for instrumented applications.
`DeleteSamplingRuleResult`	`deleteSamplingRule(DeleteSamplingRuleRequest request)` Deletes a sampling rule.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetEncryptionConfigResult`	`getEncryptionConfig(GetEncryptionConfigRequest request)` Retrieves the current encryption configuration for X-Ray data.
`GetSamplingRulesResult`	`getSamplingRules(GetSamplingRulesRequest request)` Retrieves all sampling rules.
`GetSamplingStatisticSummariesResult`	`getSamplingStatisticSummaries(GetSamplingStatisticSummariesRequest request)` Retrieves information about recent sampling results for all sampling rules.
`GetSamplingTargetsResult`	`getSamplingTargets(GetSamplingTargetsRequest request)` Requests a sampling quota for rules that the service is using to sample requests.
`GetServiceGraphResult`	`getServiceGraph(GetServiceGraphRequest request)` Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result.
`GetTraceGraphResult`	`getTraceGraph(GetTraceGraphRequest request)` Retrieves a service graph for one or more specific trace IDs.
`GetTraceSummariesResult`	`getTraceSummaries(GetTraceSummariesRequest request)` Retrieves IDs and metadata for traces available for a specified time frame using an optional filter.
`PutEncryptionConfigResult`	`putEncryptionConfig(PutEncryptionConfigRequest request)` Updates the encryption configuration for X-Ray data.
`PutTelemetryRecordsResult`	`putTelemetryRecords(PutTelemetryRecordsRequest request)` Used by the AWS X-Ray daemon to upload telemetry.
`PutTraceSegmentsResult`	`putTraceSegments(PutTraceSegmentsRequest request)` Uploads segment documents to AWS X-Ray.
`void`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client ("xray.us-east-1.amazonaws.com").
`void`	`setRegion(Region region)` An alternative to `AWSXRay.setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`UpdateSamplingRuleResult`	`updateSamplingRule(UpdateSamplingRuleRequest request)` Modifies a sampling rule's configuration.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: AWSXRay
    
    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 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: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
    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.
    
    Specified by:
    
    setEndpoint in interface AWSXRay
    
    Parameters:
    
    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.
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: AWSXRay
    
    An alternative to 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 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.
    
    Specified by:
    
    setRegion in interface AWSXRay
    
    Parameters:
    
    region - The region this client will communicate with. See 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 Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - batchGetTraces
```
public BatchGetTracesResult batchGetTraces(BatchGetTracesRequest request)
```
    Description copied from interface: AWSXRay
    
    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.
    
    Specified by:
    
    batchGetTraces in interface AWSXRay
    
    Returns:
    
    Result of the BatchGetTraces operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createSamplingRule
```
public CreateSamplingRuleResult createSamplingRule(CreateSamplingRuleRequest request)
```
    Description copied from interface: AWSXRay
    
    Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with GetSamplingRules, and evaluate each rule in ascending order of priority for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with GetSamplingTargets to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir.
    
    Specified by:
    
    createSamplingRule in interface AWSXRay
    
    Returns:
    
    Result of the CreateSamplingRule operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteSamplingRule
```
public DeleteSamplingRuleResult deleteSamplingRule(DeleteSamplingRuleRequest request)
```
    Description copied from interface: AWSXRay
    
    Deletes a sampling rule.
    
    Specified by:
    
    deleteSamplingRule in interface AWSXRay
    
    Returns:
    
    Result of the DeleteSamplingRule operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getEncryptionConfig
```
public GetEncryptionConfigResult getEncryptionConfig(GetEncryptionConfigRequest request)
```
    Description copied from interface: AWSXRay
    
    Retrieves the current encryption configuration for X-Ray data.
    
    Specified by:
    
    getEncryptionConfig in interface AWSXRay
    
    Returns:
    
    Result of the GetEncryptionConfig operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getSamplingRules
```
public GetSamplingRulesResult getSamplingRules(GetSamplingRulesRequest request)
```
    Description copied from interface: AWSXRay
    
    Retrieves all sampling rules.
    
    Specified by:
    
    getSamplingRules in interface AWSXRay
    
    Returns:
    
    Result of the GetSamplingRules operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getSamplingStatisticSummaries
```
public GetSamplingStatisticSummariesResult getSamplingStatisticSummaries(GetSamplingStatisticSummariesRequest request)
```
    Description copied from interface: AWSXRay
    
    Retrieves information about recent sampling results for all sampling rules.
    
    Specified by:
    
    getSamplingStatisticSummaries in interface AWSXRay
    
    Returns:
    
    Result of the GetSamplingStatisticSummaries operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getSamplingTargets
```
public GetSamplingTargetsResult getSamplingTargets(GetSamplingTargetsRequest request)
```
    Description copied from interface: AWSXRay
    
    Requests a sampling quota for rules that the service is using to sample requests.
    
    Specified by:
    
    getSamplingTargets in interface AWSXRay
    
    Returns:
    
    Result of the GetSamplingTargets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getServiceGraph
```
public GetServiceGraphResult getServiceGraph(GetServiceGraphRequest request)
```
    Description copied from interface: AWSXRay
    
    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.
    
    Specified by:
    
    getServiceGraph in interface AWSXRay
    
    Returns:
    
    Result of the GetServiceGraph operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getTraceGraph
```
public GetTraceGraphResult getTraceGraph(GetTraceGraphRequest request)
```
    Description copied from interface: AWSXRay
    
    Retrieves a service graph for one or more specific trace IDs.
    
    Specified by:
    
    getTraceGraph in interface AWSXRay
    
    Returns:
    
    Result of the GetTraceGraph operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getTraceSummaries
```
public GetTraceSummariesResult getTraceSummaries(GetTraceSummariesRequest request)
```
    Description copied from interface: AWSXRay
    
    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.
    
    A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come from a known user. For example, the following filter expression targets traces that pass through api.example.com:
    
    service("api.example.com")
    
    This filter expression finds traces that have an annotation named account with the value 12345:
    
    annotation.account = "12345"
    
    For a full list of indexed fields and keywords that you can use in filter expressions, see Using Filter Expressions in the AWS X-Ray Developer Guide.
    
    Specified by:
    
    getTraceSummaries in interface AWSXRay
    
    Returns:
    
    Result of the GetTraceSummaries operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putEncryptionConfig
```
public PutEncryptionConfigResult putEncryptionConfig(PutEncryptionConfigRequest request)
```
    Description copied from interface: AWSXRay
    
    Updates the encryption configuration for X-Ray data.
    
    Specified by:
    
    putEncryptionConfig in interface AWSXRay
    
    Returns:
    
    Result of the PutEncryptionConfig operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putTelemetryRecords
```
public PutTelemetryRecordsResult putTelemetryRecords(PutTelemetryRecordsRequest request)
```
    Description copied from interface: AWSXRay
    
    Used by the AWS X-Ray daemon to upload telemetry.
    
    Specified by:
    
    putTelemetryRecords in interface AWSXRay
    
    Returns:
    
    Result of the PutTelemetryRecords operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putTraceSegments
```
public PutTraceSegmentsResult putTraceSegments(PutTraceSegmentsRequest request)
```
    Description copied from interface: AWSXRay
    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.
    
    Segments must include the following fields. For the full segment document schema, see AWS X-Ray Segment Documents in the AWS X-Ray Developer Guide.
    
    Required Segment Document Fields
    - name - The name of the service that handled the request.
    - id - A 64-bit identifier for the segment, unique among segments in the same trace, in 16 hexadecimal digits.
    - trace_id - A unique identifier that connects all segments and subsegments originating from a single client request.
    - start_time - Time the segment or subsegment was created, in floating point seconds in epoch time, accurate to milliseconds. For example, 1480615200.010 or 1.480615200010E9.
    - end_time - Time the segment or subsegment was closed. For example, 1480615200.090 or 1.480615200090E9. Specify either an end_time or in_progress.
    - in_progress - Set to true instead of specifying an end_time to record that a segment has been started, but is not complete. Send an in progress segment when your application receives a request that will take a long time to serve, to trace the fact that the request was received. When the response is sent, send the complete segment to overwrite the in-progress segment.
    A trace_id consists of three numbers separated by hyphens. For example, 1-58406520-a006649127e371903a2de979. This includes:
    
    Trace ID Format
    - The version number, i.e. 1.
    - The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For example, 10:00AM December 2nd, 2016 PST in epoch time is 1480615200 seconds, or 58406520 in hexadecimal.
    - A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits.
    Specified by:
    
    putTraceSegments in interface AWSXRay
    
    Returns:
    
    Result of the PutTraceSegments operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateSamplingRule
```
public UpdateSamplingRuleResult updateSamplingRule(UpdateSamplingRuleRequest request)
```
    Description copied from interface: AWSXRay
    
    Modifies a sampling rule's configuration.
    
    Specified by:
    
    updateSamplingRule in interface AWSXRay
    
    Returns:
    
    Result of the UpdateSamplingRule operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSXRay
    
    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.
    
    Specified by:
    
    shutdown in interface AWSXRay
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSXRay
    
    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.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSXRay
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAWSXRay

Field Summary

Fields inherited from interface com.amazonaws.services.xray.AWSXRay

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

batchGetTraces

createSamplingRule

deleteSamplingRule

getEncryptionConfig

getSamplingRules

getSamplingStatisticSummaries

getSamplingTargets

getServiceGraph

getTraceGraph

getTraceSummaries

putEncryptionConfig

putTelemetryRecords

putTraceSegments

updateSamplingRule

shutdown

getCachedResponseMetadata