@Generated(value="software.amazon.awssdk:codegen") public interface XRayClient extends SdkClient
builder()
method.
AWS X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default BatchGetTracesResponse |
batchGetTraces(BatchGetTracesRequest batchGetTracesRequest)
Retrieves a list of traces specified by ID.
|
default BatchGetTracesResponse |
batchGetTraces(Consumer<BatchGetTracesRequest.Builder> batchGetTracesRequest)
Retrieves a list of traces specified by ID.
|
default BatchGetTracesIterable |
batchGetTracesPaginator(BatchGetTracesRequest batchGetTracesRequest)
Retrieves a list of traces specified by ID.
|
default BatchGetTracesIterable |
batchGetTracesPaginator(Consumer<BatchGetTracesRequest.Builder> batchGetTracesRequest)
Retrieves a list of traces specified by ID.
|
static XRayClientBuilder |
builder()
Create a builder that can be used to configure and create a
XRayClient . |
static XRayClient |
create()
Create a
XRayClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateGroupResponse |
createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)
Creates a group resource with a name and a filter expression.
|
default CreateGroupResponse |
createGroup(CreateGroupRequest createGroupRequest)
Creates a group resource with a name and a filter expression.
|
default CreateSamplingRuleResponse |
createSamplingRule(Consumer<CreateSamplingRuleRequest.Builder> createSamplingRuleRequest)
Creates a rule to control sampling behavior for instrumented applications.
|
default CreateSamplingRuleResponse |
createSamplingRule(CreateSamplingRuleRequest createSamplingRuleRequest)
Creates a rule to control sampling behavior for instrumented applications.
|
default DeleteGroupResponse |
deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)
Deletes a group resource.
|
default DeleteGroupResponse |
deleteGroup(DeleteGroupRequest deleteGroupRequest)
Deletes a group resource.
|
default DeleteSamplingRuleResponse |
deleteSamplingRule(Consumer<DeleteSamplingRuleRequest.Builder> deleteSamplingRuleRequest)
Deletes a sampling rule.
|
default DeleteSamplingRuleResponse |
deleteSamplingRule(DeleteSamplingRuleRequest deleteSamplingRuleRequest)
Deletes a sampling rule.
|
default GetEncryptionConfigResponse |
getEncryptionConfig()
Retrieves the current encryption configuration for X-Ray data.
|
default GetEncryptionConfigResponse |
getEncryptionConfig(Consumer<GetEncryptionConfigRequest.Builder> getEncryptionConfigRequest)
Retrieves the current encryption configuration for X-Ray data.
|
default GetEncryptionConfigResponse |
getEncryptionConfig(GetEncryptionConfigRequest getEncryptionConfigRequest)
Retrieves the current encryption configuration for X-Ray data.
|
default GetGroupResponse |
getGroup(Consumer<GetGroupRequest.Builder> getGroupRequest)
Retrieves group resource details.
|
default GetGroupResponse |
getGroup(GetGroupRequest getGroupRequest)
Retrieves group resource details.
|
default GetGroupsResponse |
getGroups()
Retrieves all active group details.
|
default GetGroupsResponse |
getGroups(Consumer<GetGroupsRequest.Builder> getGroupsRequest)
Retrieves all active group details.
|
default GetGroupsResponse |
getGroups(GetGroupsRequest getGroupsRequest)
Retrieves all active group details.
|
default GetSamplingRulesResponse |
getSamplingRules()
Retrieves all sampling rules.
|
default GetSamplingRulesResponse |
getSamplingRules(Consumer<GetSamplingRulesRequest.Builder> getSamplingRulesRequest)
Retrieves all sampling rules.
|
default GetSamplingRulesResponse |
getSamplingRules(GetSamplingRulesRequest getSamplingRulesRequest)
Retrieves all sampling rules.
|
default GetSamplingStatisticSummariesResponse |
getSamplingStatisticSummaries()
Retrieves information about recent sampling results for all sampling rules.
|
default GetSamplingStatisticSummariesResponse |
getSamplingStatisticSummaries(Consumer<GetSamplingStatisticSummariesRequest.Builder> getSamplingStatisticSummariesRequest)
Retrieves information about recent sampling results for all sampling rules.
|
default GetSamplingStatisticSummariesResponse |
getSamplingStatisticSummaries(GetSamplingStatisticSummariesRequest getSamplingStatisticSummariesRequest)
Retrieves information about recent sampling results for all sampling rules.
|
default GetSamplingTargetsResponse |
getSamplingTargets(Consumer<GetSamplingTargetsRequest.Builder> getSamplingTargetsRequest)
Requests a sampling quota for rules that the service is using to sample requests.
|
default GetSamplingTargetsResponse |
getSamplingTargets(GetSamplingTargetsRequest getSamplingTargetsRequest)
Requests a sampling quota for rules that the service is using to sample requests.
|
default GetServiceGraphResponse |
getServiceGraph(Consumer<GetServiceGraphRequest.Builder> getServiceGraphRequest)
Retrieves a document that describes services that process incoming requests, and downstream services that they
call as a result.
|
default GetServiceGraphResponse |
getServiceGraph(GetServiceGraphRequest getServiceGraphRequest)
Retrieves a document that describes services that process incoming requests, and downstream services that they
call as a result.
|
default GetServiceGraphIterable |
getServiceGraphPaginator(Consumer<GetServiceGraphRequest.Builder> getServiceGraphRequest)
Retrieves a document that describes services that process incoming requests, and downstream services that they
call as a result.
|
default GetServiceGraphIterable |
getServiceGraphPaginator(GetServiceGraphRequest getServiceGraphRequest)
Retrieves a document that describes services that process incoming requests, and downstream services that they
call as a result.
|
default GetTraceGraphResponse |
getTraceGraph(Consumer<GetTraceGraphRequest.Builder> getTraceGraphRequest)
Retrieves a service graph for one or more specific trace IDs.
|
default GetTraceGraphResponse |
getTraceGraph(GetTraceGraphRequest getTraceGraphRequest)
Retrieves a service graph for one or more specific trace IDs.
|
default GetTraceGraphIterable |
getTraceGraphPaginator(Consumer<GetTraceGraphRequest.Builder> getTraceGraphRequest)
Retrieves a service graph for one or more specific trace IDs.
|
default GetTraceGraphIterable |
getTraceGraphPaginator(GetTraceGraphRequest getTraceGraphRequest)
Retrieves a service graph for one or more specific trace IDs.
|
default GetTraceSummariesResponse |
getTraceSummaries(Consumer<GetTraceSummariesRequest.Builder> getTraceSummariesRequest)
Retrieves IDs and metadata for traces available for a specified time frame using an optional filter.
|
default GetTraceSummariesResponse |
getTraceSummaries(GetTraceSummariesRequest getTraceSummariesRequest)
Retrieves IDs and metadata for traces available for a specified time frame using an optional filter.
|
default GetTraceSummariesIterable |
getTraceSummariesPaginator(Consumer<GetTraceSummariesRequest.Builder> getTraceSummariesRequest)
Retrieves IDs and metadata for traces available for a specified time frame using an optional filter.
|
default GetTraceSummariesIterable |
getTraceSummariesPaginator(GetTraceSummariesRequest getTraceSummariesRequest)
Retrieves IDs and metadata for traces available for a specified time frame using an optional filter.
|
default PutEncryptionConfigResponse |
putEncryptionConfig(Consumer<PutEncryptionConfigRequest.Builder> putEncryptionConfigRequest)
Updates the encryption configuration for X-Ray data.
|
default PutEncryptionConfigResponse |
putEncryptionConfig(PutEncryptionConfigRequest putEncryptionConfigRequest)
Updates the encryption configuration for X-Ray data.
|
default PutTelemetryRecordsResponse |
putTelemetryRecords(Consumer<PutTelemetryRecordsRequest.Builder> putTelemetryRecordsRequest)
Used by the AWS X-Ray daemon to upload telemetry.
|
default PutTelemetryRecordsResponse |
putTelemetryRecords(PutTelemetryRecordsRequest putTelemetryRecordsRequest)
Used by the AWS X-Ray daemon to upload telemetry.
|
default PutTraceSegmentsResponse |
putTraceSegments(Consumer<PutTraceSegmentsRequest.Builder> putTraceSegmentsRequest)
Uploads segment documents to AWS X-Ray.
|
default PutTraceSegmentsResponse |
putTraceSegments(PutTraceSegmentsRequest putTraceSegmentsRequest)
Uploads segment documents to AWS X-Ray.
|
static ServiceMetadata |
serviceMetadata() |
default UpdateGroupResponse |
updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest)
Updates a group resource.
|
default UpdateGroupResponse |
updateGroup(UpdateGroupRequest updateGroupRequest)
Updates a group resource.
|
default UpdateSamplingRuleResponse |
updateSamplingRule(Consumer<UpdateSamplingRuleRequest.Builder> updateSamplingRuleRequest)
Modifies a sampling rule's configuration.
|
default UpdateSamplingRuleResponse |
updateSamplingRule(UpdateSamplingRuleRequest updateSamplingRuleRequest)
Modifies a sampling rule's configuration.
|
serviceName
close
static final String SERVICE_NAME
static XRayClient create()
XRayClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static XRayClientBuilder builder()
XRayClient
.default BatchGetTracesResponse batchGetTraces(BatchGetTracesRequest batchGetTracesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
batchGetTracesRequest
- InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default BatchGetTracesResponse batchGetTraces(Consumer<BatchGetTracesRequest.Builder> batchGetTracesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
This is a convenience which creates an instance of the BatchGetTracesRequest.Builder
avoiding the need to
create one manually via BatchGetTracesRequest.builder()
batchGetTracesRequest
- A Consumer
that will call methods on BatchGetTracesRequest.Builder
to create a request.InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default BatchGetTracesIterable batchGetTracesPaginator(BatchGetTracesRequest batchGetTracesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
This is a variant of batchGetTraces(software.amazon.awssdk.services.xray.model.BatchGetTracesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.BatchGetTracesIterable responses = client.batchGetTracesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.xray.paginators.BatchGetTracesIterable responses = client.batchGetTracesPaginator(request); for (software.amazon.awssdk.services.xray.model.BatchGetTracesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.BatchGetTracesIterable responses = client.batchGetTracesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
batchGetTraces(software.amazon.awssdk.services.xray.model.BatchGetTracesRequest)
operation.
batchGetTracesRequest
- InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default BatchGetTracesIterable batchGetTracesPaginator(Consumer<BatchGetTracesRequest.Builder> batchGetTracesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
This is a variant of batchGetTraces(software.amazon.awssdk.services.xray.model.BatchGetTracesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.BatchGetTracesIterable responses = client.batchGetTracesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.xray.paginators.BatchGetTracesIterable responses = client.batchGetTracesPaginator(request); for (software.amazon.awssdk.services.xray.model.BatchGetTracesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.BatchGetTracesIterable responses = client.batchGetTracesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
batchGetTraces(software.amazon.awssdk.services.xray.model.BatchGetTracesRequest)
operation.
This is a convenience which creates an instance of the BatchGetTracesRequest.Builder
avoiding the need to
create one manually via BatchGetTracesRequest.builder()
batchGetTracesRequest
- A Consumer
that will call methods on BatchGetTracesRequest.Builder
to create a request.InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateGroupResponse createGroup(CreateGroupRequest createGroupRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Creates a group resource with a name and a filter expression.
createGroupRequest
- InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateGroupResponse createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Creates a group resource with a name and a filter expression.
This is a convenience which creates an instance of the CreateGroupRequest.Builder
avoiding the need to
create one manually via CreateGroupRequest.builder()
createGroupRequest
- A Consumer
that will call methods on CreateGroupRequest.Builder
to create a request.InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateSamplingRuleResponse createSamplingRule(CreateSamplingRuleRequest createSamplingRuleRequest) throws InvalidRequestException, ThrottledException, RuleLimitExceededException, AwsServiceException, SdkClientException, XRayException
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.
createSamplingRuleRequest
- InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.RuleLimitExceededException
- You have reached the maximum number of sampling rules.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateSamplingRuleResponse createSamplingRule(Consumer<CreateSamplingRuleRequest.Builder> createSamplingRuleRequest) throws InvalidRequestException, ThrottledException, RuleLimitExceededException, AwsServiceException, SdkClientException, XRayException
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.
This is a convenience which creates an instance of the CreateSamplingRuleRequest.Builder
avoiding the
need to create one manually via CreateSamplingRuleRequest.builder()
createSamplingRuleRequest
- A Consumer
that will call methods on CreateSamplingRuleRequest.Builder
to create a
request.InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.RuleLimitExceededException
- You have reached the maximum number of sampling rules.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteGroupResponse deleteGroup(DeleteGroupRequest deleteGroupRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Deletes a group resource.
deleteGroupRequest
- InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteGroupResponse deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Deletes a group resource.
This is a convenience which creates an instance of the DeleteGroupRequest.Builder
avoiding the need to
create one manually via DeleteGroupRequest.builder()
deleteGroupRequest
- A Consumer
that will call methods on DeleteGroupRequest.Builder
to create a request.InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteSamplingRuleResponse deleteSamplingRule(DeleteSamplingRuleRequest deleteSamplingRuleRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Deletes a sampling rule.
deleteSamplingRuleRequest
- InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteSamplingRuleResponse deleteSamplingRule(Consumer<DeleteSamplingRuleRequest.Builder> deleteSamplingRuleRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Deletes a sampling rule.
This is a convenience which creates an instance of the DeleteSamplingRuleRequest.Builder
avoiding the
need to create one manually via DeleteSamplingRuleRequest.builder()
deleteSamplingRuleRequest
- A Consumer
that will call methods on DeleteSamplingRuleRequest.Builder
to create a
request.InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetEncryptionConfigResponse getEncryptionConfig() throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves the current encryption configuration for X-Ray data.
InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getEncryptionConfig(GetEncryptionConfigRequest)
,
AWS API
Documentationdefault GetEncryptionConfigResponse getEncryptionConfig(GetEncryptionConfigRequest getEncryptionConfigRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves the current encryption configuration for X-Ray data.
getEncryptionConfigRequest
- InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetEncryptionConfigResponse getEncryptionConfig(Consumer<GetEncryptionConfigRequest.Builder> getEncryptionConfigRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves the current encryption configuration for X-Ray data.
This is a convenience which creates an instance of the GetEncryptionConfigRequest.Builder
avoiding the
need to create one manually via GetEncryptionConfigRequest.builder()
getEncryptionConfigRequest
- A Consumer
that will call methods on GetEncryptionConfigRequest.Builder
to create a
request.InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetGroupResponse getGroup(GetGroupRequest getGroupRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves group resource details.
getGroupRequest
- InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetGroupResponse getGroup(Consumer<GetGroupRequest.Builder> getGroupRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves group resource details.
This is a convenience which creates an instance of the GetGroupRequest.Builder
avoiding the need to
create one manually via GetGroupRequest.builder()
getGroupRequest
- A Consumer
that will call methods on GetGroupRequest.Builder
to create a request.InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetGroupsResponse getGroups() throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves all active group details.
InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getGroups(GetGroupsRequest)
,
AWS API
Documentationdefault GetGroupsResponse getGroups(GetGroupsRequest getGroupsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves all active group details.
getGroupsRequest
- InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetGroupsResponse getGroups(Consumer<GetGroupsRequest.Builder> getGroupsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves all active group details.
This is a convenience which creates an instance of the GetGroupsRequest.Builder
avoiding the need to
create one manually via GetGroupsRequest.builder()
getGroupsRequest
- A Consumer
that will call methods on GetGroupsRequest.Builder
to create a request.InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetSamplingRulesResponse getSamplingRules() throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves all sampling rules.
InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getSamplingRules(GetSamplingRulesRequest)
,
AWS API
Documentationdefault GetSamplingRulesResponse getSamplingRules(GetSamplingRulesRequest getSamplingRulesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves all sampling rules.
getSamplingRulesRequest
- InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetSamplingRulesResponse getSamplingRules(Consumer<GetSamplingRulesRequest.Builder> getSamplingRulesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves all sampling rules.
This is a convenience which creates an instance of the GetSamplingRulesRequest.Builder
avoiding the need
to create one manually via GetSamplingRulesRequest.builder()
getSamplingRulesRequest
- A Consumer
that will call methods on GetSamplingRulesRequest.Builder
to create a request.InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetSamplingStatisticSummariesResponse getSamplingStatisticSummaries() throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves information about recent sampling results for all sampling rules.
InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getSamplingStatisticSummaries(GetSamplingStatisticSummariesRequest)
,
AWS API Documentationdefault GetSamplingStatisticSummariesResponse getSamplingStatisticSummaries(GetSamplingStatisticSummariesRequest getSamplingStatisticSummariesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves information about recent sampling results for all sampling rules.
getSamplingStatisticSummariesRequest
- InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetSamplingStatisticSummariesResponse getSamplingStatisticSummaries(Consumer<GetSamplingStatisticSummariesRequest.Builder> getSamplingStatisticSummariesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves information about recent sampling results for all sampling rules.
This is a convenience which creates an instance of the GetSamplingStatisticSummariesRequest.Builder
avoiding the need to create one manually via GetSamplingStatisticSummariesRequest.builder()
getSamplingStatisticSummariesRequest
- A Consumer
that will call methods on GetSamplingStatisticSummariesRequest.Builder
to
create a request.InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetSamplingTargetsResponse getSamplingTargets(GetSamplingTargetsRequest getSamplingTargetsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Requests a sampling quota for rules that the service is using to sample requests.
getSamplingTargetsRequest
- InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetSamplingTargetsResponse getSamplingTargets(Consumer<GetSamplingTargetsRequest.Builder> getSamplingTargetsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Requests a sampling quota for rules that the service is using to sample requests.
This is a convenience which creates an instance of the GetSamplingTargetsRequest.Builder
avoiding the
need to create one manually via GetSamplingTargetsRequest.builder()
getSamplingTargetsRequest
- A Consumer
that will call methods on GetSamplingTargetsRequest.Builder
to create a
request.InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetServiceGraphResponse getServiceGraph(GetServiceGraphRequest getServiceGraphRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
getServiceGraphRequest
- InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetServiceGraphResponse getServiceGraph(Consumer<GetServiceGraphRequest.Builder> getServiceGraphRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
This is a convenience which creates an instance of the GetServiceGraphRequest.Builder
avoiding the need
to create one manually via GetServiceGraphRequest.builder()
getServiceGraphRequest
- A Consumer
that will call methods on GetServiceGraphRequest.Builder
to create a request.InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetServiceGraphIterable getServiceGraphPaginator(GetServiceGraphRequest getServiceGraphRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
This is a variant of getServiceGraph(software.amazon.awssdk.services.xray.model.GetServiceGraphRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.GetServiceGraphIterable responses = client.getServiceGraphPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.xray.paginators.GetServiceGraphIterable responses = client.getServiceGraphPaginator(request); for (software.amazon.awssdk.services.xray.model.GetServiceGraphResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.GetServiceGraphIterable responses = client.getServiceGraphPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getServiceGraph(software.amazon.awssdk.services.xray.model.GetServiceGraphRequest)
operation.
getServiceGraphRequest
- InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetServiceGraphIterable getServiceGraphPaginator(Consumer<GetServiceGraphRequest.Builder> getServiceGraphRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
This is a variant of getServiceGraph(software.amazon.awssdk.services.xray.model.GetServiceGraphRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.GetServiceGraphIterable responses = client.getServiceGraphPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.xray.paginators.GetServiceGraphIterable responses = client.getServiceGraphPaginator(request); for (software.amazon.awssdk.services.xray.model.GetServiceGraphResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.GetServiceGraphIterable responses = client.getServiceGraphPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getServiceGraph(software.amazon.awssdk.services.xray.model.GetServiceGraphRequest)
operation.
This is a convenience which creates an instance of the GetServiceGraphRequest.Builder
avoiding the need
to create one manually via GetServiceGraphRequest.builder()
getServiceGraphRequest
- A Consumer
that will call methods on GetServiceGraphRequest.Builder
to create a request.InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetTraceGraphResponse getTraceGraph(GetTraceGraphRequest getTraceGraphRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves a service graph for one or more specific trace IDs.
getTraceGraphRequest
- InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetTraceGraphResponse getTraceGraph(Consumer<GetTraceGraphRequest.Builder> getTraceGraphRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves a service graph for one or more specific trace IDs.
This is a convenience which creates an instance of the GetTraceGraphRequest.Builder
avoiding the need to
create one manually via GetTraceGraphRequest.builder()
getTraceGraphRequest
- A Consumer
that will call methods on GetTraceGraphRequest.Builder
to create a request.InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetTraceGraphIterable getTraceGraphPaginator(GetTraceGraphRequest getTraceGraphRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves a service graph for one or more specific trace IDs.
This is a variant of getTraceGraph(software.amazon.awssdk.services.xray.model.GetTraceGraphRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.GetTraceGraphIterable responses = client.getTraceGraphPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.xray.paginators.GetTraceGraphIterable responses = client.getTraceGraphPaginator(request); for (software.amazon.awssdk.services.xray.model.GetTraceGraphResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.GetTraceGraphIterable responses = client.getTraceGraphPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getTraceGraph(software.amazon.awssdk.services.xray.model.GetTraceGraphRequest)
operation.
getTraceGraphRequest
- InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetTraceGraphIterable getTraceGraphPaginator(Consumer<GetTraceGraphRequest.Builder> getTraceGraphRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves a service graph for one or more specific trace IDs.
This is a variant of getTraceGraph(software.amazon.awssdk.services.xray.model.GetTraceGraphRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.GetTraceGraphIterable responses = client.getTraceGraphPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.xray.paginators.GetTraceGraphIterable responses = client.getTraceGraphPaginator(request); for (software.amazon.awssdk.services.xray.model.GetTraceGraphResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.GetTraceGraphIterable responses = client.getTraceGraphPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getTraceGraph(software.amazon.awssdk.services.xray.model.GetTraceGraphRequest)
operation.
This is a convenience which creates an instance of the GetTraceGraphRequest.Builder
avoiding the need to
create one manually via GetTraceGraphRequest.builder()
getTraceGraphRequest
- A Consumer
that will call methods on GetTraceGraphRequest.Builder
to create a request.InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetTraceSummariesResponse getTraceSummaries(GetTraceSummariesRequest getTraceSummariesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
getTraceSummariesRequest
- InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetTraceSummariesResponse getTraceSummaries(Consumer<GetTraceSummariesRequest.Builder> getTraceSummariesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
This is a convenience which creates an instance of the GetTraceSummariesRequest.Builder
avoiding the need
to create one manually via GetTraceSummariesRequest.builder()
getTraceSummariesRequest
- A Consumer
that will call methods on GetTraceSummariesRequest.Builder
to create a request.InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetTraceSummariesIterable getTraceSummariesPaginator(GetTraceSummariesRequest getTraceSummariesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
This is a variant of
getTraceSummaries(software.amazon.awssdk.services.xray.model.GetTraceSummariesRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.GetTraceSummariesIterable responses = client.getTraceSummariesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.xray.paginators.GetTraceSummariesIterable responses = client .getTraceSummariesPaginator(request); for (software.amazon.awssdk.services.xray.model.GetTraceSummariesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.GetTraceSummariesIterable responses = client.getTraceSummariesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getTraceSummaries(software.amazon.awssdk.services.xray.model.GetTraceSummariesRequest)
operation.
getTraceSummariesRequest
- InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetTraceSummariesIterable getTraceSummariesPaginator(Consumer<GetTraceSummariesRequest.Builder> getTraceSummariesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
This is a variant of
getTraceSummaries(software.amazon.awssdk.services.xray.model.GetTraceSummariesRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.GetTraceSummariesIterable responses = client.getTraceSummariesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.xray.paginators.GetTraceSummariesIterable responses = client .getTraceSummariesPaginator(request); for (software.amazon.awssdk.services.xray.model.GetTraceSummariesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.GetTraceSummariesIterable responses = client.getTraceSummariesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getTraceSummaries(software.amazon.awssdk.services.xray.model.GetTraceSummariesRequest)
operation.
This is a convenience which creates an instance of the GetTraceSummariesRequest.Builder
avoiding the need
to create one manually via GetTraceSummariesRequest.builder()
getTraceSummariesRequest
- A Consumer
that will call methods on GetTraceSummariesRequest.Builder
to create a request.InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutEncryptionConfigResponse putEncryptionConfig(PutEncryptionConfigRequest putEncryptionConfigRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Updates the encryption configuration for X-Ray data.
putEncryptionConfigRequest
- InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutEncryptionConfigResponse putEncryptionConfig(Consumer<PutEncryptionConfigRequest.Builder> putEncryptionConfigRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Updates the encryption configuration for X-Ray data.
This is a convenience which creates an instance of the PutEncryptionConfigRequest.Builder
avoiding the
need to create one manually via PutEncryptionConfigRequest.builder()
putEncryptionConfigRequest
- A Consumer
that will call methods on PutEncryptionConfigRequest.Builder
to create a
request.InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutTelemetryRecordsResponse putTelemetryRecords(PutTelemetryRecordsRequest putTelemetryRecordsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Used by the AWS X-Ray daemon to upload telemetry.
putTelemetryRecordsRequest
- InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutTelemetryRecordsResponse putTelemetryRecords(Consumer<PutTelemetryRecordsRequest.Builder> putTelemetryRecordsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Used by the AWS X-Ray daemon to upload telemetry.
This is a convenience which creates an instance of the PutTelemetryRecordsRequest.Builder
avoiding the
need to create one manually via PutTelemetryRecordsRequest.builder()
putTelemetryRecordsRequest
- A Consumer
that will call methods on PutTelemetryRecordsRequest.Builder
to create a
request.InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutTraceSegmentsResponse putTraceSegments(PutTraceSegmentsRequest putTraceSegmentsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
putTraceSegmentsRequest
- InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutTraceSegmentsResponse putTraceSegments(Consumer<PutTraceSegmentsRequest.Builder> putTraceSegmentsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
This is a convenience which creates an instance of the PutTraceSegmentsRequest.Builder
avoiding the need
to create one manually via PutTraceSegmentsRequest.builder()
putTraceSegmentsRequest
- A Consumer
that will call methods on PutTraceSegmentsRequest.Builder
to create a request.InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateGroupResponse updateGroup(UpdateGroupRequest updateGroupRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Updates a group resource.
updateGroupRequest
- InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateGroupResponse updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Updates a group resource.
This is a convenience which creates an instance of the UpdateGroupRequest.Builder
avoiding the need to
create one manually via UpdateGroupRequest.builder()
updateGroupRequest
- A Consumer
that will call methods on UpdateGroupRequest.Builder
to create a request.InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateSamplingRuleResponse updateSamplingRule(UpdateSamplingRuleRequest updateSamplingRuleRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Modifies a sampling rule's configuration.
updateSamplingRuleRequest
- InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateSamplingRuleResponse updateSamplingRule(Consumer<UpdateSamplingRuleRequest.Builder> updateSamplingRuleRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Modifies a sampling rule's configuration.
This is a convenience which creates an instance of the UpdateSamplingRuleRequest.Builder
avoiding the
need to create one manually via UpdateSamplingRuleRequest.builder()
updateSamplingRuleRequest
- A Consumer
that will call methods on UpdateSamplingRuleRequest.Builder
to create a
request.InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.