JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
  • Summary:
  • Nested |
  • Field |
  • Constr |
  • Method
  • Detail:
  • Field |
  • Constr |
  • Method
com.amazonaws.services.xray

Class 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.

    • 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.

      • 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

      • getInsight

        public GetInsightResult getInsight(GetInsightRequest request)
        Description copied from interface: AWSXRay

        Retrieves the summary information of an insight. This includes impact to clients and root cause services, the top anomalous services, the category, the state of the insight, and the start and end time of the insight.

        Specified by:
        getInsight in interface AWSXRay
        Returns:
        Result of the GetInsight operation returned by the service.
        See Also:
        AWS API Documentation

      • getInsightEvents

        public GetInsightEventsResult getInsightEvents(GetInsightEventsRequest request)
        Description copied from interface: AWSXRay

        X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event. You can review an insight's events in the Impact Timeline on the Inspect page in the X-Ray console.

        Specified by:
        getInsightEvents in interface AWSXRay
        Returns:
        Result of the GetInsightEvents 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 Amazon Web Services X-Ray SDK. Downstream services can be other applications, Amazon Web Services 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

      • getTraceSummaries

        public GetTraceSummariesResult getTraceSummaries(GetTraceSummariesRequest request)
        Description copied from interface: AWSXRay

        Retrieves IDs and annotations 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 Amazon Web Services 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

      • putResourcePolicy

        public PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest request)
        Description copied from interface: AWSXRay

        Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access X-Ray. Each resource policy will be associated with a specific Amazon Web Services account. Each Amazon Web Services account can have a maximum of 5 resource policies, and each policy name must be unique within that account. The maximum size of each resource policy is 5KB.

        Specified by:
        putResourcePolicy in interface AWSXRay
        Returns:
        Result of the PutResourcePolicy 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 Amazon Web Services 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 Amazon Web Services X-Ray Segment Documents in the Amazon Web Services 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 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, for instance, 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

      • 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.
Skip navigation links
  • Summary:
  • Nested |
  • Field |
  • Constr |
  • Method
  • Detail:
  • Field |
  • Constr |
  • Method

AltStyle によって変換されたページ (->オリジナル) /