Interface XRayClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Amazon Web Services X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault BatchGetTracesResponse
batchGetTraces
(Consumer<BatchGetTracesRequest.Builder> batchGetTracesRequest) Retrieves a list of traces specified by ID.default BatchGetTracesResponse
batchGetTraces
(BatchGetTracesRequest batchGetTracesRequest) Retrieves a list of traces specified by ID.default BatchGetTracesIterable
batchGetTracesPaginator
(Consumer<BatchGetTracesRequest.Builder> batchGetTracesRequest) This is a variant ofbatchGetTraces(software.amazon.awssdk.services.xray.model.BatchGetTracesRequest)
operation.default BatchGetTracesIterable
batchGetTracesPaginator
(BatchGetTracesRequest batchGetTracesRequest) This is a variant ofbatchGetTraces(software.amazon.awssdk.services.xray.model.BatchGetTracesRequest)
operation.static XRayClientBuilder
builder()
Create a builder that can be used to configure and create aXRayClient
.static XRayClient
create()
Create aXRayClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.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 DeleteResourcePolicyResponse
deleteResourcePolicy
(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest) Deletes a resource policy from the target Amazon Web Services account.default DeleteResourcePolicyResponse
deleteResourcePolicy
(DeleteResourcePolicyRequest deleteResourcePolicyRequest) Deletes a resource policy from the target Amazon Web Services account.default DeleteSamplingRuleResponse
deleteSamplingRule
(Consumer<DeleteSamplingRuleRequest.Builder> deleteSamplingRuleRequest) Deletes a sampling rule.default DeleteSamplingRuleResponse
deleteSamplingRule
(DeleteSamplingRuleRequest deleteSamplingRuleRequest) Deletes a sampling rule.default GetEncryptionConfigResponse
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
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 GetGroupsIterable
This is a variant ofgetGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest)
operation.default GetGroupsIterable
getGroupsPaginator
(Consumer<GetGroupsRequest.Builder> getGroupsRequest) This is a variant ofgetGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest)
operation.default GetGroupsIterable
getGroupsPaginator
(GetGroupsRequest getGroupsRequest) This is a variant ofgetGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest)
operation.default GetInsightResponse
getInsight
(Consumer<GetInsightRequest.Builder> getInsightRequest) Retrieves the summary information of an insight.default GetInsightResponse
getInsight
(GetInsightRequest getInsightRequest) Retrieves the summary information of an insight.default GetInsightEventsResponse
getInsightEvents
(Consumer<GetInsightEventsRequest.Builder> getInsightEventsRequest) X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event.default GetInsightEventsResponse
getInsightEvents
(GetInsightEventsRequest getInsightEventsRequest) X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event.default GetInsightEventsIterable
getInsightEventsPaginator
(Consumer<GetInsightEventsRequest.Builder> getInsightEventsRequest) This is a variant ofgetInsightEvents(software.amazon.awssdk.services.xray.model.GetInsightEventsRequest)
operation.default GetInsightEventsIterable
getInsightEventsPaginator
(GetInsightEventsRequest getInsightEventsRequest) This is a variant ofgetInsightEvents(software.amazon.awssdk.services.xray.model.GetInsightEventsRequest)
operation.default GetInsightImpactGraphResponse
getInsightImpactGraph
(Consumer<GetInsightImpactGraphRequest.Builder> getInsightImpactGraphRequest) Retrieves a service graph structure filtered by the specified insight.default GetInsightImpactGraphResponse
getInsightImpactGraph
(GetInsightImpactGraphRequest getInsightImpactGraphRequest) Retrieves a service graph structure filtered by the specified insight.default GetInsightSummariesResponse
getInsightSummaries
(Consumer<GetInsightSummariesRequest.Builder> getInsightSummariesRequest) Retrieves the summaries of all insights in the specified group matching the provided filter values.default GetInsightSummariesResponse
getInsightSummaries
(GetInsightSummariesRequest getInsightSummariesRequest) Retrieves the summaries of all insights in the specified group matching the provided filter values.default GetInsightSummariesIterable
getInsightSummariesPaginator
(Consumer<GetInsightSummariesRequest.Builder> getInsightSummariesRequest) This is a variant ofgetInsightSummaries(software.amazon.awssdk.services.xray.model.GetInsightSummariesRequest)
operation.default GetInsightSummariesIterable
getInsightSummariesPaginator
(GetInsightSummariesRequest getInsightSummariesRequest) This is a variant ofgetInsightSummaries(software.amazon.awssdk.services.xray.model.GetInsightSummariesRequest)
operation.default GetSamplingRulesResponse
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 GetSamplingRulesIterable
This is a variant ofgetSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest)
operation.default GetSamplingRulesIterable
getSamplingRulesPaginator
(Consumer<GetSamplingRulesRequest.Builder> getSamplingRulesRequest) This is a variant ofgetSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest)
operation.default GetSamplingRulesIterable
getSamplingRulesPaginator
(GetSamplingRulesRequest getSamplingRulesRequest) This is a variant ofgetSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest)
operation.Retrieves information about recent sampling results for all sampling rules.getSamplingStatisticSummaries
(Consumer<GetSamplingStatisticSummariesRequest.Builder> getSamplingStatisticSummariesRequest) Retrieves information about recent sampling results for all sampling rules.getSamplingStatisticSummaries
(GetSamplingStatisticSummariesRequest getSamplingStatisticSummariesRequest) Retrieves information about recent sampling results for all sampling rules.This is a variant ofgetSamplingStatisticSummaries(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest)
operation.getSamplingStatisticSummariesPaginator
(Consumer<GetSamplingStatisticSummariesRequest.Builder> getSamplingStatisticSummariesRequest) This is a variant ofgetSamplingStatisticSummaries(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest)
operation.getSamplingStatisticSummariesPaginator
(GetSamplingStatisticSummariesRequest getSamplingStatisticSummariesRequest) This is a variant ofgetSamplingStatisticSummaries(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest)
operation.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) This is a variant ofgetServiceGraph(software.amazon.awssdk.services.xray.model.GetServiceGraphRequest)
operation.default GetServiceGraphIterable
getServiceGraphPaginator
(GetServiceGraphRequest getServiceGraphRequest) This is a variant ofgetServiceGraph(software.amazon.awssdk.services.xray.model.GetServiceGraphRequest)
operation.getTimeSeriesServiceStatistics
(Consumer<GetTimeSeriesServiceStatisticsRequest.Builder> getTimeSeriesServiceStatisticsRequest) Get an aggregation of service statistics defined by a specific time range.getTimeSeriesServiceStatistics
(GetTimeSeriesServiceStatisticsRequest getTimeSeriesServiceStatisticsRequest) Get an aggregation of service statistics defined by a specific time range.getTimeSeriesServiceStatisticsPaginator
(Consumer<GetTimeSeriesServiceStatisticsRequest.Builder> getTimeSeriesServiceStatisticsRequest) This is a variant ofgetTimeSeriesServiceStatistics(software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsRequest)
operation.getTimeSeriesServiceStatisticsPaginator
(GetTimeSeriesServiceStatisticsRequest getTimeSeriesServiceStatisticsRequest) This is a variant ofgetTimeSeriesServiceStatistics(software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsRequest)
operation.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) This is a variant ofgetTraceGraph(software.amazon.awssdk.services.xray.model.GetTraceGraphRequest)
operation.default GetTraceGraphIterable
getTraceGraphPaginator
(GetTraceGraphRequest getTraceGraphRequest) This is a variant ofgetTraceGraph(software.amazon.awssdk.services.xray.model.GetTraceGraphRequest)
operation.default GetTraceSummariesResponse
getTraceSummaries
(Consumer<GetTraceSummariesRequest.Builder> getTraceSummariesRequest) Retrieves IDs and annotations for traces available for a specified time frame using an optional filter.default GetTraceSummariesResponse
getTraceSummaries
(GetTraceSummariesRequest getTraceSummariesRequest) Retrieves IDs and annotations for traces available for a specified time frame using an optional filter.default GetTraceSummariesIterable
getTraceSummariesPaginator
(Consumer<GetTraceSummariesRequest.Builder> getTraceSummariesRequest) This is a variant ofgetTraceSummaries(software.amazon.awssdk.services.xray.model.GetTraceSummariesRequest)
operation.default GetTraceSummariesIterable
getTraceSummariesPaginator
(GetTraceSummariesRequest getTraceSummariesRequest) This is a variant ofgetTraceSummaries(software.amazon.awssdk.services.xray.model.GetTraceSummariesRequest)
operation.default ListResourcePoliciesResponse
listResourcePolicies
(Consumer<ListResourcePoliciesRequest.Builder> listResourcePoliciesRequest) Returns the list of resource policies in the target Amazon Web Services account.default ListResourcePoliciesResponse
listResourcePolicies
(ListResourcePoliciesRequest listResourcePoliciesRequest) Returns the list of resource policies in the target Amazon Web Services account.default ListResourcePoliciesIterable
listResourcePoliciesPaginator
(Consumer<ListResourcePoliciesRequest.Builder> listResourcePoliciesRequest) This is a variant oflistResourcePolicies(software.amazon.awssdk.services.xray.model.ListResourcePoliciesRequest)
operation.default ListResourcePoliciesIterable
listResourcePoliciesPaginator
(ListResourcePoliciesRequest listResourcePoliciesRequest) This is a variant oflistResourcePolicies(software.amazon.awssdk.services.xray.model.ListResourcePoliciesRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.default ListTagsForResourceIterable
listTagsForResourcePaginator
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.xray.model.ListTagsForResourceRequest)
operation.default ListTagsForResourceIterable
listTagsForResourcePaginator
(ListTagsForResourceRequest listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.xray.model.ListTagsForResourceRequest)
operation.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 PutResourcePolicyResponse
putResourcePolicy
(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest) Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access X-Ray.default PutResourcePolicyResponse
putResourcePolicy
(PutResourcePolicyRequest putResourcePolicyRequest) Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access X-Ray.default PutTelemetryRecordsResponse
putTelemetryRecords
(Consumer<PutTelemetryRecordsRequest.Builder> putTelemetryRecordsRequest) Used by the Amazon Web Services X-Ray daemon to upload telemetry.default PutTelemetryRecordsResponse
putTelemetryRecords
(PutTelemetryRecordsRequest putTelemetryRecordsRequest) Used by the Amazon Web Services X-Ray daemon to upload telemetry.default PutTraceSegmentsResponse
putTraceSegments
(Consumer<PutTraceSegmentsRequest.Builder> putTraceSegmentsRequest) Uploads segment documents to Amazon Web Services X-Ray.default PutTraceSegmentsResponse
putTraceSegments
(PutTraceSegmentsRequest putTraceSegmentsRequest) Uploads segment documents to Amazon Web Services X-Ray.default XRayServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from an Amazon Web Services X-Ray group or sampling rule.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes tags from an Amazon Web Services X-Ray group or sampling rule.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.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
batchGetTraces
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.- Parameters:
batchGetTracesRequest
-- Returns:
- Result of the BatchGetTraces operation returned by the service.
- See Also:
-
batchGetTraces
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 viaBatchGetTracesRequest.builder()
- Parameters:
batchGetTracesRequest
- AConsumer
that will call methods onBatchGetTracesRequest.Builder
to create a request.- Returns:
- Result of the BatchGetTraces operation returned by the service.
- See Also:
-
batchGetTracesPaginator
default BatchGetTracesIterable batchGetTracesPaginator(BatchGetTracesRequest batchGetTracesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException 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 Streamsoftware.amazon.awssdk.services.xray.paginators.BatchGetTracesIterable responses = client.batchGetTracesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.amazon.awssdk.services.xray.paginators.BatchGetTracesIterable responses = client.batchGetTracesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
batchGetTraces(software.amazon.awssdk.services.xray.model.BatchGetTracesRequest)
operation.- Parameters:
batchGetTracesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
batchGetTracesPaginator
default BatchGetTracesIterable batchGetTracesPaginator(Consumer<BatchGetTracesRequest.Builder> batchGetTracesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException 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 Streamsoftware.amazon.awssdk.services.xray.paginators.BatchGetTracesIterable responses = client.batchGetTracesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.amazon.awssdk.services.xray.paginators.BatchGetTracesIterable responses = client.batchGetTracesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 viaBatchGetTracesRequest.builder()
- Parameters:
batchGetTracesRequest
- AConsumer
that will call methods onBatchGetTracesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
createGroup
default CreateGroupResponse createGroup(CreateGroupRequest createGroupRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException Creates a group resource with a name and a filter expression.
- Parameters:
createGroupRequest
-- Returns:
- Result of the CreateGroup operation returned by the service.
- See Also:
-
createGroup
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 viaCreateGroupRequest.builder()
- Parameters:
createGroupRequest
- AConsumer
that will call methods onCreateGroupRequest.Builder
to create a request.- Returns:
- Result of the CreateGroup operation returned by the service.
- See Also:
-
createSamplingRule
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.
- Parameters:
createSamplingRuleRequest
-- Returns:
- Result of the CreateSamplingRule operation returned by the service.
- See Also:
-
createSamplingRule
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 viaCreateSamplingRuleRequest.builder()
- Parameters:
createSamplingRuleRequest
- AConsumer
that will call methods onCreateSamplingRuleRequest.Builder
to create a request.- Returns:
- Result of the CreateSamplingRule operation returned by the service.
- See Also:
-
deleteGroup
default DeleteGroupResponse deleteGroup(DeleteGroupRequest deleteGroupRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException Deletes a group resource.
- Parameters:
deleteGroupRequest
-- Returns:
- Result of the DeleteGroup operation returned by the service.
- See Also:
-
deleteGroup
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 viaDeleteGroupRequest.builder()
- Parameters:
deleteGroupRequest
- AConsumer
that will call methods onDeleteGroupRequest.Builder
to create a request.- Returns:
- Result of the DeleteGroup operation returned by the service.
- See Also:
-
deleteResourcePolicy
default DeleteResourcePolicyResponse deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest) throws InvalidRequestException, InvalidPolicyRevisionIdException, ThrottledException, AwsServiceException, SdkClientException, XRayException Deletes a resource policy from the target Amazon Web Services account.
- Parameters:
deleteResourcePolicyRequest
-- Returns:
- Result of the DeleteResourcePolicy operation returned by the service.
- See Also:
-
deleteResourcePolicy
default DeleteResourcePolicyResponse deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest) throws InvalidRequestException, InvalidPolicyRevisionIdException, ThrottledException, AwsServiceException, SdkClientException, XRayException Deletes a resource policy from the target Amazon Web Services account.
This is a convenience which creates an instance of the
DeleteResourcePolicyRequest.Builder
avoiding the need to create one manually viaDeleteResourcePolicyRequest.builder()
- Parameters:
deleteResourcePolicyRequest
- AConsumer
that will call methods onDeleteResourcePolicyRequest.Builder
to create a request.- Returns:
- Result of the DeleteResourcePolicy operation returned by the service.
- See Also:
-
deleteSamplingRule
default DeleteSamplingRuleResponse deleteSamplingRule(DeleteSamplingRuleRequest deleteSamplingRuleRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException Deletes a sampling rule.
- Parameters:
deleteSamplingRuleRequest
-- Returns:
- Result of the DeleteSamplingRule operation returned by the service.
- See Also:
-
deleteSamplingRule
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 viaDeleteSamplingRuleRequest.builder()
- Parameters:
deleteSamplingRuleRequest
- AConsumer
that will call methods onDeleteSamplingRuleRequest.Builder
to create a request.- Returns:
- Result of the DeleteSamplingRule operation returned by the service.
- See Also:
-
getEncryptionConfig
default GetEncryptionConfigResponse getEncryptionConfig(GetEncryptionConfigRequest getEncryptionConfigRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException Retrieves the current encryption configuration for X-Ray data.
- Parameters:
getEncryptionConfigRequest
-- Returns:
- Result of the GetEncryptionConfig operation returned by the service.
- See Also:
-
getEncryptionConfig
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 viaGetEncryptionConfigRequest.builder()
- Parameters:
getEncryptionConfigRequest
- AConsumer
that will call methods onGetEncryptionConfigRequest.Builder
to create a request.- Returns:
- Result of the GetEncryptionConfig operation returned by the service.
- See Also:
-
getEncryptionConfig
default GetEncryptionConfigResponse getEncryptionConfig() throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayExceptionRetrieves the current encryption configuration for X-Ray data.
- Returns:
- Result of the GetEncryptionConfig operation returned by the service.
- See Also:
-
getGroup
default GetGroupResponse getGroup(GetGroupRequest getGroupRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException Retrieves group resource details.
- Parameters:
getGroupRequest
-- Returns:
- Result of the GetGroup operation returned by the service.
- See Also:
-
getGroup
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 viaGetGroupRequest.builder()
- Parameters:
getGroupRequest
- AConsumer
that will call methods onGetGroupRequest.Builder
to create a request.- Returns:
- Result of the GetGroup operation returned by the service.
- See Also:
-
getGroups
default GetGroupsResponse getGroups(GetGroupsRequest getGroupsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException Retrieves all active group details.
- Parameters:
getGroupsRequest
-- Returns:
- Result of the GetGroups operation returned by the service.
- See Also:
-
getGroups
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 viaGetGroupsRequest.builder()
- Parameters:
getGroupsRequest
- AConsumer
that will call methods onGetGroupsRequest.Builder
to create a request.- Returns:
- Result of the GetGroups operation returned by the service.
- See Also:
-
getGroups
default GetGroupsResponse getGroups() throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayExceptionRetrieves all active group details.
- Returns:
- Result of the GetGroups operation returned by the service.
- See Also:
-
getGroupsPaginator
default GetGroupsIterable getGroupsPaginator() throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayExceptionThis is a variant of
getGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest)
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 Streamsoftware.amazon.awssdk.services.xray.paginators.GetGroupsIterable responses = client.getGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.xray.paginators.GetGroupsIterable responses = client.getGroupsPaginator(request); for (software.amazon.awssdk.services.xray.model.GetGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.xray.paginators.GetGroupsIterable responses = client.getGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getGroupsPaginator
default GetGroupsIterable getGroupsPaginator(GetGroupsRequest getGroupsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException This is a variant of
getGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest)
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 Streamsoftware.amazon.awssdk.services.xray.paginators.GetGroupsIterable responses = client.getGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.xray.paginators.GetGroupsIterable responses = client.getGroupsPaginator(request); for (software.amazon.awssdk.services.xray.model.GetGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.xray.paginators.GetGroupsIterable responses = client.getGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest)
operation.- Parameters:
getGroupsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getGroupsPaginator
default GetGroupsIterable getGroupsPaginator(Consumer<GetGroupsRequest.Builder> getGroupsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException This is a variant of
getGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest)
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 Streamsoftware.amazon.awssdk.services.xray.paginators.GetGroupsIterable responses = client.getGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.xray.paginators.GetGroupsIterable responses = client.getGroupsPaginator(request); for (software.amazon.awssdk.services.xray.model.GetGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.xray.paginators.GetGroupsIterable responses = client.getGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest)
operation.
This is a convenience which creates an instance of the
GetGroupsRequest.Builder
avoiding the need to create one manually viaGetGroupsRequest.builder()
- Parameters:
getGroupsRequest
- AConsumer
that will call methods onGetGroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getInsight
default GetInsightResponse getInsight(GetInsightRequest getInsightRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException 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.
- Parameters:
getInsightRequest
-- Returns:
- Result of the GetInsight operation returned by the service.
- See Also:
-
getInsight
default GetInsightResponse getInsight(Consumer<GetInsightRequest.Builder> getInsightRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException 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.
This is a convenience which creates an instance of the
GetInsightRequest.Builder
avoiding the need to create one manually viaGetInsightRequest.builder()
- Parameters:
getInsightRequest
- AConsumer
that will call methods onGetInsightRequest.Builder
to create a request.- Returns:
- Result of the GetInsight operation returned by the service.
- See Also:
-
getInsightEvents
default GetInsightEventsResponse getInsightEvents(GetInsightEventsRequest getInsightEventsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException 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.
- Parameters:
getInsightEventsRequest
-- Returns:
- Result of the GetInsightEvents operation returned by the service.
- See Also:
-
getInsightEvents
default GetInsightEventsResponse getInsightEvents(Consumer<GetInsightEventsRequest.Builder> getInsightEventsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException 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.
This is a convenience which creates an instance of the
GetInsightEventsRequest.Builder
avoiding the need to create one manually viaGetInsightEventsRequest.builder()
- Parameters:
getInsightEventsRequest
- AConsumer
that will call methods onGetInsightEventsRequest.Builder
to create a request.- Returns:
- Result of the GetInsightEvents operation returned by the service.
- See Also:
-
getInsightEventsPaginator
default GetInsightEventsIterable getInsightEventsPaginator(GetInsightEventsRequest getInsightEventsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException This is a variant of
getInsightEvents(software.amazon.awssdk.services.xray.model.GetInsightEventsRequest)
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 Streamsoftware.amazon.awssdk.services.xray.paginators.GetInsightEventsIterable responses = client.getInsightEventsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.xray.paginators.GetInsightEventsIterable responses = client .getInsightEventsPaginator(request); for (software.amazon.awssdk.services.xray.model.GetInsightEventsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.xray.paginators.GetInsightEventsIterable responses = client.getInsightEventsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getInsightEvents(software.amazon.awssdk.services.xray.model.GetInsightEventsRequest)
operation.- Parameters:
getInsightEventsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getInsightEventsPaginator
default GetInsightEventsIterable getInsightEventsPaginator(Consumer<GetInsightEventsRequest.Builder> getInsightEventsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException This is a variant of
getInsightEvents(software.amazon.awssdk.services.xray.model.GetInsightEventsRequest)
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 Streamsoftware.amazon.awssdk.services.xray.paginators.GetInsightEventsIterable responses = client.getInsightEventsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.xray.paginators.GetInsightEventsIterable responses = client .getInsightEventsPaginator(request); for (software.amazon.awssdk.services.xray.model.GetInsightEventsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.xray.paginators.GetInsightEventsIterable responses = client.getInsightEventsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getInsightEvents(software.amazon.awssdk.services.xray.model.GetInsightEventsRequest)
operation.
This is a convenience which creates an instance of the
GetInsightEventsRequest.Builder
avoiding the need to create one manually viaGetInsightEventsRequest.builder()
- Parameters:
getInsightEventsRequest
- AConsumer
that will call methods onGetInsightEventsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getInsightImpactGraph
default GetInsightImpactGraphResponse getInsightImpactGraph(GetInsightImpactGraphRequest getInsightImpactGraphRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException Retrieves a service graph structure filtered by the specified insight. The service graph is limited to only structural information. For a complete service graph, use this API with the GetServiceGraph API.
- Parameters:
getInsightImpactGraphRequest
-- Returns:
- Result of the GetInsightImpactGraph operation returned by the service.
- See Also:
-
getInsightImpactGraph
default GetInsightImpactGraphResponse getInsightImpactGraph(Consumer<GetInsightImpactGraphRequest.Builder> getInsightImpactGraphRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException Retrieves a service graph structure filtered by the specified insight. The service graph is limited to only structural information. For a complete service graph, use this API with the GetServiceGraph API.
This is a convenience which creates an instance of the
GetInsightImpactGraphRequest.Builder
avoiding the need to create one manually viaGetInsightImpactGraphRequest.builder()
- Parameters:
getInsightImpactGraphRequest
- AConsumer
that will call methods onGetInsightImpactGraphRequest.Builder
to create a request.- Returns:
- Result of the GetInsightImpactGraph operation returned by the service.
- See Also:
-
getInsightSummaries
default GetInsightSummariesResponse getInsightSummaries(GetInsightSummariesRequest getInsightSummariesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException Retrieves the summaries of all insights in the specified group matching the provided filter values.
- Parameters:
getInsightSummariesRequest
-- Returns:
- Result of the GetInsightSummaries operation returned by the service.
- See Also:
-
getInsightSummaries
default GetInsightSummariesResponse getInsightSummaries(Consumer<GetInsightSummariesRequest.Builder> getInsightSummariesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException Retrieves the summaries of all insights in the specified group matching the provided filter values.
This is a convenience which creates an instance of the
GetInsightSummariesRequest.Builder
avoiding the need to create one manually viaGetInsightSummariesRequest.builder()
- Parameters:
getInsightSummariesRequest
- AConsumer
that will call methods onGetInsightSummariesRequest.Builder
to create a request.- Returns:
- Result of the GetInsightSummaries operation returned by the service.
- See Also:
-
getInsightSummariesPaginator
default GetInsightSummariesIterable getInsightSummariesPaginator(GetInsightSummariesRequest getInsightSummariesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException This is a variant of
getInsightSummaries(software.amazon.awssdk.services.xray.model.GetInsightSummariesRequest)
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 Streamsoftware.amazon.awssdk.services.xray.paginators.GetInsightSummariesIterable responses = client.getInsightSummariesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.xray.paginators.GetInsightSummariesIterable responses = client .getInsightSummariesPaginator(request); for (software.amazon.awssdk.services.xray.model.GetInsightSummariesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.xray.paginators.GetInsightSummariesIterable responses = client.getInsightSummariesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getInsightSummaries(software.amazon.awssdk.services.xray.model.GetInsightSummariesRequest)
operation.- Parameters:
getInsightSummariesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getInsightSummariesPaginator
default GetInsightSummariesIterable getInsightSummariesPaginator(Consumer<GetInsightSummariesRequest.Builder> getInsightSummariesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException This is a variant of
getInsightSummaries(software.amazon.awssdk.services.xray.model.GetInsightSummariesRequest)
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 Streamsoftware.amazon.awssdk.services.xray.paginators.GetInsightSummariesIterable responses = client.getInsightSummariesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.xray.paginators.GetInsightSummariesIterable responses = client .getInsightSummariesPaginator(request); for (software.amazon.awssdk.services.xray.model.GetInsightSummariesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.xray.paginators.GetInsightSummariesIterable responses = client.getInsightSummariesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getInsightSummaries(software.amazon.awssdk.services.xray.model.GetInsightSummariesRequest)
operation.
This is a convenience which creates an instance of the
GetInsightSummariesRequest.Builder
avoiding the need to create one manually viaGetInsightSummariesRequest.builder()
- Parameters:
getInsightSummariesRequest
- AConsumer
that will call methods onGetInsightSummariesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getSamplingRules
default GetSamplingRulesResponse getSamplingRules(GetSamplingRulesRequest getSamplingRulesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException Retrieves all sampling rules.
- Parameters:
getSamplingRulesRequest
-- Returns:
- Result of the GetSamplingRules operation returned by the service.
- See Also:
-
getSamplingRules
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 viaGetSamplingRulesRequest.builder()
- Parameters:
getSamplingRulesRequest
- AConsumer
that will call methods onGetSamplingRulesRequest.Builder
to create a request.- Returns:
- Result of the GetSamplingRules operation returned by the service.
- See Also:
-
getSamplingRules
default GetSamplingRulesResponse getSamplingRules() throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayExceptionRetrieves all sampling rules.
- Returns:
- Result of the GetSamplingRules operation returned by the service.
- See Also:
-
getSamplingRulesPaginator
default GetSamplingRulesIterable getSamplingRulesPaginator() throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayExceptionThis is a variant of
getSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest)
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 Streamsoftware.amazon.awssdk.services.xray.paginators.GetSamplingRulesIterable responses = client.getSamplingRulesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.xray.paginators.GetSamplingRulesIterable responses = client .getSamplingRulesPaginator(request); for (software.amazon.awssdk.services.xray.model.GetSamplingRulesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.xray.paginators.GetSamplingRulesIterable responses = client.getSamplingRulesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getSamplingRulesPaginator
default GetSamplingRulesIterable getSamplingRulesPaginator(GetSamplingRulesRequest getSamplingRulesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException This is a variant of
getSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest)
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 Streamsoftware.amazon.awssdk.services.xray.paginators.GetSamplingRulesIterable responses = client.getSamplingRulesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.xray.paginators.GetSamplingRulesIterable responses = client .getSamplingRulesPaginator(request); for (software.amazon.awssdk.services.xray.model.GetSamplingRulesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.xray.paginators.GetSamplingRulesIterable responses = client.getSamplingRulesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest)
operation.- Parameters:
getSamplingRulesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getSamplingRulesPaginator
default GetSamplingRulesIterable getSamplingRulesPaginator(Consumer<GetSamplingRulesRequest.Builder> getSamplingRulesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException This is a variant of
getSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest)
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 Streamsoftware.amazon.awssdk.services.xray.paginators.GetSamplingRulesIterable responses = client.getSamplingRulesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.xray.paginators.GetSamplingRulesIterable responses = client .getSamplingRulesPaginator(request); for (software.amazon.awssdk.services.xray.model.GetSamplingRulesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.xray.paginators.GetSamplingRulesIterable responses = client.getSamplingRulesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest)
operation.
This is a convenience which creates an instance of the
GetSamplingRulesRequest.Builder
avoiding the need to create one manually viaGetSamplingRulesRequest.builder()
- Parameters:
getSamplingRulesRequest
- AConsumer
that will call methods onGetSamplingRulesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getSamplingStatisticSummaries
default GetSamplingStatisticSummariesResponse getSamplingStatisticSummaries(GetSamplingStatisticSummariesRequest getSamplingStatisticSummariesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException Retrieves information about recent sampling results for all sampling rules.
- Parameters:
getSamplingStatisticSummariesRequest
-- Returns:
- Result of the GetSamplingStatisticSummaries operation returned by the service.
- See Also:
-
getSamplingStatisticSummaries
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 viaGetSamplingStatisticSummariesRequest.builder()
- Parameters:
getSamplingStatisticSummariesRequest
- AConsumer
that will call methods onGetSamplingStatisticSummariesRequest.Builder
to create a request.- Returns:
- Result of the GetSamplingStatisticSummaries operation returned by the service.
- See Also:
-
getSamplingStatisticSummaries
default GetSamplingStatisticSummariesResponse getSamplingStatisticSummaries() throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayExceptionRetrieves information about recent sampling results for all sampling rules.
- Returns:
- Result of the GetSamplingStatisticSummaries operation returned by the service.
- See Also:
-
getSamplingStatisticSummariesPaginator
default GetSamplingStatisticSummariesIterable getSamplingStatisticSummariesPaginator() throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayExceptionThis is a variant of
getSamplingStatisticSummaries(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest)
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 Streamsoftware.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesIterable responses = client.getSamplingStatisticSummariesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesIterable responses = client .getSamplingStatisticSummariesPaginator(request); for (software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesIterable responses = client.getSamplingStatisticSummariesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getSamplingStatisticSummaries(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getSamplingStatisticSummariesPaginator
default GetSamplingStatisticSummariesIterable getSamplingStatisticSummariesPaginator(GetSamplingStatisticSummariesRequest getSamplingStatisticSummariesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException This is a variant of
getSamplingStatisticSummaries(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest)
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 Streamsoftware.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesIterable responses = client.getSamplingStatisticSummariesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesIterable responses = client .getSamplingStatisticSummariesPaginator(request); for (software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesIterable responses = client.getSamplingStatisticSummariesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getSamplingStatisticSummaries(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest)
operation.- Parameters:
getSamplingStatisticSummariesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getSamplingStatisticSummariesPaginator
default GetSamplingStatisticSummariesIterable getSamplingStatisticSummariesPaginator(Consumer<GetSamplingStatisticSummariesRequest.Builder> getSamplingStatisticSummariesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException This is a variant of
getSamplingStatisticSummaries(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest)
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 Streamsoftware.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesIterable responses = client.getSamplingStatisticSummariesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesIterable responses = client .getSamplingStatisticSummariesPaginator(request); for (software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesIterable responses = client.getSamplingStatisticSummariesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getSamplingStatisticSummaries(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest)
operation.
This is a convenience which creates an instance of the
GetSamplingStatisticSummariesRequest.Builder
avoiding the need to create one manually viaGetSamplingStatisticSummariesRequest.builder()
- Parameters:
getSamplingStatisticSummariesRequest
- AConsumer
that will call methods onGetSamplingStatisticSummariesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getSamplingTargets
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.
- Parameters:
getSamplingTargetsRequest
-- Returns:
- Result of the GetSamplingTargets operation returned by the service.
- See Also:
-
getSamplingTargets
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 viaGetSamplingTargetsRequest.builder()
- Parameters:
getSamplingTargetsRequest
- AConsumer
that will call methods onGetSamplingTargetsRequest.Builder
to create a request.- Returns:
- Result of the GetSamplingTargets operation returned by the service.
- See Also:
-
getServiceGraph
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 Amazon Web Services X-Ray SDK. Downstream services can be other applications, Amazon Web Services resources, HTTP web APIs, or SQL databases.
- Parameters:
getServiceGraphRequest
-- Returns:
- Result of the GetServiceGraph operation returned by the service.
- See Also:
-
getServiceGraph
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 Amazon Web Services X-Ray SDK. Downstream services can be other applications, Amazon Web Services 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 viaGetServiceGraphRequest.builder()
- Parameters:
getServiceGraphRequest
- AConsumer
that will call methods onGetServiceGraphRequest.Builder
to create a request.- Returns:
- Result of the GetServiceGraph operation returned by the service.
- See Also:
-
getServiceGraphPaginator
default GetServiceGraphIterable getServiceGraphPaginator(GetServiceGraphRequest getServiceGraphRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException 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 Streamsoftware.amazon.awssdk.services.xray.paginators.GetServiceGraphIterable responses = client.getServiceGraphPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.amazon.awssdk.services.xray.paginators.GetServiceGraphIterable responses = client.getServiceGraphPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getServiceGraph(software.amazon.awssdk.services.xray.model.GetServiceGraphRequest)
operation.- Parameters:
getServiceGraphRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getServiceGraphPaginator
default GetServiceGraphIterable getServiceGraphPaginator(Consumer<GetServiceGraphRequest.Builder> getServiceGraphRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException 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 Streamsoftware.amazon.awssdk.services.xray.paginators.GetServiceGraphIterable responses = client.getServiceGraphPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.amazon.awssdk.services.xray.paginators.GetServiceGraphIterable responses = client.getServiceGraphPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 viaGetServiceGraphRequest.builder()
- Parameters:
getServiceGraphRequest
- AConsumer
that will call methods onGetServiceGraphRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getTimeSeriesServiceStatistics
default GetTimeSeriesServiceStatisticsResponse getTimeSeriesServiceStatistics(GetTimeSeriesServiceStatisticsRequest getTimeSeriesServiceStatisticsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException Get an aggregation of service statistics defined by a specific time range.
- Parameters:
getTimeSeriesServiceStatisticsRequest
-- Returns:
- Result of the GetTimeSeriesServiceStatistics operation returned by the service.
- See Also:
-
getTimeSeriesServiceStatistics
default GetTimeSeriesServiceStatisticsResponse getTimeSeriesServiceStatistics(Consumer<GetTimeSeriesServiceStatisticsRequest.Builder> getTimeSeriesServiceStatisticsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException Get an aggregation of service statistics defined by a specific time range.
This is a convenience which creates an instance of the
GetTimeSeriesServiceStatisticsRequest.Builder
avoiding the need to create one manually viaGetTimeSeriesServiceStatisticsRequest.builder()
- Parameters:
getTimeSeriesServiceStatisticsRequest
- AConsumer
that will call methods onGetTimeSeriesServiceStatisticsRequest.Builder
to create a request.- Returns:
- Result of the GetTimeSeriesServiceStatistics operation returned by the service.
- See Also:
-
getTimeSeriesServiceStatisticsPaginator
default GetTimeSeriesServiceStatisticsIterable getTimeSeriesServiceStatisticsPaginator(GetTimeSeriesServiceStatisticsRequest getTimeSeriesServiceStatisticsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException This is a variant of
getTimeSeriesServiceStatistics(software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsRequest)
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 Streamsoftware.amazon.awssdk.services.xray.paginators.GetTimeSeriesServiceStatisticsIterable responses = client.getTimeSeriesServiceStatisticsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.xray.paginators.GetTimeSeriesServiceStatisticsIterable responses = client .getTimeSeriesServiceStatisticsPaginator(request); for (software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.xray.paginators.GetTimeSeriesServiceStatisticsIterable responses = client.getTimeSeriesServiceStatisticsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getTimeSeriesServiceStatistics(software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsRequest)
operation.- Parameters:
getTimeSeriesServiceStatisticsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getTimeSeriesServiceStatisticsPaginator
default GetTimeSeriesServiceStatisticsIterable getTimeSeriesServiceStatisticsPaginator(Consumer<GetTimeSeriesServiceStatisticsRequest.Builder> getTimeSeriesServiceStatisticsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException This is a variant of
getTimeSeriesServiceStatistics(software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsRequest)
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 Streamsoftware.amazon.awssdk.services.xray.paginators.GetTimeSeriesServiceStatisticsIterable responses = client.getTimeSeriesServiceStatisticsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.xray.paginators.GetTimeSeriesServiceStatisticsIterable responses = client .getTimeSeriesServiceStatisticsPaginator(request); for (software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.xray.paginators.GetTimeSeriesServiceStatisticsIterable responses = client.getTimeSeriesServiceStatisticsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getTimeSeriesServiceStatistics(software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsRequest)
operation.
This is a convenience which creates an instance of the
GetTimeSeriesServiceStatisticsRequest.Builder
avoiding the need to create one manually viaGetTimeSeriesServiceStatisticsRequest.builder()
- Parameters:
getTimeSeriesServiceStatisticsRequest
- AConsumer
that will call methods onGetTimeSeriesServiceStatisticsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getTraceGraph
default GetTraceGraphResponse getTraceGraph(GetTraceGraphRequest getTraceGraphRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException Retrieves a service graph for one or more specific trace IDs.
- Parameters:
getTraceGraphRequest
-- Returns:
- Result of the GetTraceGraph operation returned by the service.
- See Also:
-
getTraceGraph
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 viaGetTraceGraphRequest.builder()
- Parameters:
getTraceGraphRequest
- AConsumer
that will call methods onGetTraceGraphRequest.Builder
to create a request.- Returns:
- Result of the GetTraceGraph operation returned by the service.
- See Also:
-
getTraceGraphPaginator
default GetTraceGraphIterable getTraceGraphPaginator(GetTraceGraphRequest getTraceGraphRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException 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 Streamsoftware.amazon.awssdk.services.xray.paginators.GetTraceGraphIterable responses = client.getTraceGraphPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.amazon.awssdk.services.xray.paginators.GetTraceGraphIterable responses = client.getTraceGraphPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getTraceGraph(software.amazon.awssdk.services.xray.model.GetTraceGraphRequest)
operation.- Parameters:
getTraceGraphRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getTraceGraphPaginator
default GetTraceGraphIterable getTraceGraphPaginator(Consumer<GetTraceGraphRequest.Builder> getTraceGraphRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException 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 Streamsoftware.amazon.awssdk.services.xray.paginators.GetTraceGraphIterable responses = client.getTraceGraphPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.amazon.awssdk.services.xray.paginators.GetTraceGraphIterable responses = client.getTraceGraphPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 viaGetTraceGraphRequest.builder()
- Parameters:
getTraceGraphRequest
- AConsumer
that will call methods onGetTraceGraphRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getTraceSummaries
default GetTraceSummariesResponse getTraceSummaries(GetTraceSummariesRequest getTraceSummariesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException 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 value12345
: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.
- Parameters:
getTraceSummariesRequest
-- Returns:
- Result of the GetTraceSummaries operation returned by the service.
- See Also:
-
getTraceSummaries
default GetTraceSummariesResponse getTraceSummaries(Consumer<GetTraceSummariesRequest.Builder> getTraceSummariesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException 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 value12345
: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.
This is a convenience which creates an instance of the
GetTraceSummariesRequest.Builder
avoiding the need to create one manually viaGetTraceSummariesRequest.builder()
- Parameters:
getTraceSummariesRequest
- AConsumer
that will call methods onGetTraceSummariesRequest.Builder
to create a request.- Returns:
- Result of the GetTraceSummaries operation returned by the service.
- See Also:
-
getTraceSummariesPaginator
default GetTraceSummariesIterable getTraceSummariesPaginator(GetTraceSummariesRequest getTraceSummariesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException 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 Streamsoftware.amazon.awssdk.services.xray.paginators.GetTraceSummariesIterable responses = client.getTraceSummariesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.amazon.awssdk.services.xray.paginators.GetTraceSummariesIterable responses = client.getTraceSummariesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getTraceSummaries(software.amazon.awssdk.services.xray.model.GetTraceSummariesRequest)
operation.- Parameters:
getTraceSummariesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getTraceSummariesPaginator
default GetTraceSummariesIterable getTraceSummariesPaginator(Consumer<GetTraceSummariesRequest.Builder> getTraceSummariesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException 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 Streamsoftware.amazon.awssdk.services.xray.paginators.GetTraceSummariesIterable responses = client.getTraceSummariesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.amazon.awssdk.services.xray.paginators.GetTraceSummariesIterable responses = client.getTraceSummariesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 viaGetTraceSummariesRequest.builder()
- Parameters:
getTraceSummariesRequest
- AConsumer
that will call methods onGetTraceSummariesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listResourcePolicies
default ListResourcePoliciesResponse listResourcePolicies(ListResourcePoliciesRequest listResourcePoliciesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException Returns the list of resource policies in the target Amazon Web Services account.
- Parameters:
listResourcePoliciesRequest
-- Returns:
- Result of the ListResourcePolicies operation returned by the service.
- See Also:
-
listResourcePolicies
default ListResourcePoliciesResponse listResourcePolicies(Consumer<ListResourcePoliciesRequest.Builder> listResourcePoliciesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException Returns the list of resource policies in the target Amazon Web Services account.
This is a convenience which creates an instance of the
ListResourcePoliciesRequest.Builder
avoiding the need to create one manually viaListResourcePoliciesRequest.builder()
- Parameters:
listResourcePoliciesRequest
- AConsumer
that will call methods onListResourcePoliciesRequest.Builder
to create a request.- Returns:
- Result of the ListResourcePolicies operation returned by the service.
- See Also:
-
listResourcePoliciesPaginator
default ListResourcePoliciesIterable listResourcePoliciesPaginator(ListResourcePoliciesRequest listResourcePoliciesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException This is a variant of
listResourcePolicies(software.amazon.awssdk.services.xray.model.ListResourcePoliciesRequest)
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 Streamsoftware.amazon.awssdk.services.xray.paginators.ListResourcePoliciesIterable responses = client.listResourcePoliciesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.xray.paginators.ListResourcePoliciesIterable responses = client .listResourcePoliciesPaginator(request); for (software.amazon.awssdk.services.xray.model.ListResourcePoliciesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.xray.paginators.ListResourcePoliciesIterable responses = client.listResourcePoliciesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourcePolicies(software.amazon.awssdk.services.xray.model.ListResourcePoliciesRequest)
operation.- Parameters:
listResourcePoliciesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listResourcePoliciesPaginator
default ListResourcePoliciesIterable listResourcePoliciesPaginator(Consumer<ListResourcePoliciesRequest.Builder> listResourcePoliciesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException This is a variant of
listResourcePolicies(software.amazon.awssdk.services.xray.model.ListResourcePoliciesRequest)
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 Streamsoftware.amazon.awssdk.services.xray.paginators.ListResourcePoliciesIterable responses = client.listResourcePoliciesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.xray.paginators.ListResourcePoliciesIterable responses = client .listResourcePoliciesPaginator(request); for (software.amazon.awssdk.services.xray.model.ListResourcePoliciesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.xray.paginators.ListResourcePoliciesIterable responses = client.listResourcePoliciesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourcePolicies(software.amazon.awssdk.services.xray.model.ListResourcePoliciesRequest)
operation.
This is a convenience which creates an instance of the
ListResourcePoliciesRequest.Builder
avoiding the need to create one manually viaListResourcePoliciesRequest.builder()
- Parameters:
listResourcePoliciesRequest
- AConsumer
that will call methods onListResourcePoliciesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidRequestException, ThrottledException, ResourceNotFoundException, AwsServiceException, SdkClientException, XRayException Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidRequestException, ThrottledException, ResourceNotFoundException, AwsServiceException, SdkClientException, XRayException Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourceIterable listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidRequestException, ThrottledException, ResourceNotFoundException, AwsServiceException, SdkClientException, XRayException This is a variant of
listTagsForResource(software.amazon.awssdk.services.xray.model.ListTagsForResourceRequest)
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 Streamsoftware.amazon.awssdk.services.xray.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.xray.paginators.ListTagsForResourceIterable responses = client .listTagsForResourcePaginator(request); for (software.amazon.awssdk.services.xray.model.ListTagsForResourceResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.xray.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.xray.model.ListTagsForResourceRequest)
operation.- Parameters:
listTagsForResourceRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourceIterable listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidRequestException, ThrottledException, ResourceNotFoundException, AwsServiceException, SdkClientException, XRayException This is a variant of
listTagsForResource(software.amazon.awssdk.services.xray.model.ListTagsForResourceRequest)
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 Streamsoftware.amazon.awssdk.services.xray.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.xray.paginators.ListTagsForResourceIterable responses = client .listTagsForResourcePaginator(request); for (software.amazon.awssdk.services.xray.model.ListTagsForResourceResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.xray.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.xray.model.ListTagsForResourceRequest)
operation.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
putEncryptionConfig
default PutEncryptionConfigResponse putEncryptionConfig(PutEncryptionConfigRequest putEncryptionConfigRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException Updates the encryption configuration for X-Ray data.
- Parameters:
putEncryptionConfigRequest
-- Returns:
- Result of the PutEncryptionConfig operation returned by the service.
- See Also:
-
putEncryptionConfig
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 viaPutEncryptionConfigRequest.builder()
- Parameters:
putEncryptionConfigRequest
- AConsumer
that will call methods onPutEncryptionConfigRequest.Builder
to create a request.- Returns:
- Result of the PutEncryptionConfig operation returned by the service.
- See Also:
-
putResourcePolicy
default PutResourcePolicyResponse putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest) throws MalformedPolicyDocumentException, LockoutPreventionException, InvalidPolicyRevisionIdException, PolicySizeLimitExceededException, PolicyCountLimitExceededException, ThrottledException, AwsServiceException, SdkClientException, XRayException 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.
- Parameters:
putResourcePolicyRequest
-- Returns:
- Result of the PutResourcePolicy operation returned by the service.
- See Also:
-
putResourcePolicy
default PutResourcePolicyResponse putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest) throws MalformedPolicyDocumentException, LockoutPreventionException, InvalidPolicyRevisionIdException, PolicySizeLimitExceededException, PolicyCountLimitExceededException, ThrottledException, AwsServiceException, SdkClientException, XRayException 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.
This is a convenience which creates an instance of the
PutResourcePolicyRequest.Builder
avoiding the need to create one manually viaPutResourcePolicyRequest.builder()
- Parameters:
putResourcePolicyRequest
- AConsumer
that will call methods onPutResourcePolicyRequest.Builder
to create a request.- Returns:
- Result of the PutResourcePolicy operation returned by the service.
- See Also:
-
putTelemetryRecords
default PutTelemetryRecordsResponse putTelemetryRecords(PutTelemetryRecordsRequest putTelemetryRecordsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException Used by the Amazon Web Services X-Ray daemon to upload telemetry.
- Parameters:
putTelemetryRecordsRequest
-- Returns:
- Result of the PutTelemetryRecords operation returned by the service.
- See Also:
-
putTelemetryRecords
default PutTelemetryRecordsResponse putTelemetryRecords(Consumer<PutTelemetryRecordsRequest.Builder> putTelemetryRecordsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException Used by the Amazon Web Services 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 viaPutTelemetryRecordsRequest.builder()
- Parameters:
putTelemetryRecordsRequest
- AConsumer
that will call methods onPutTelemetryRecordsRequest.Builder
to create a request.- Returns:
- Result of the PutTelemetryRecords operation returned by the service.
- See Also:
-
putTraceSegments
default PutTraceSegmentsResponse putTraceSegments(PutTraceSegmentsRequest putTraceSegmentsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException 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
or1.480615200010E9
. -
end_time
- Time the segment or subsegment was closed. For example,1480615200.090
or1.480615200090E9
. Specify either anend_time
orin_progress
. -
in_progress
- Set totrue
instead of specifying anend_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, or58406520
in hexadecimal. -
A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits.
- Parameters:
putTraceSegmentsRequest
-- Returns:
- Result of the PutTraceSegments operation returned by the service.
- See Also:
-
-
putTraceSegments
default PutTraceSegmentsResponse putTraceSegments(Consumer<PutTraceSegmentsRequest.Builder> putTraceSegmentsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException 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
or1.480615200010E9
. -
end_time
- Time the segment or subsegment was closed. For example,1480615200.090
or1.480615200090E9
. Specify either anend_time
orin_progress
. -
in_progress
- Set totrue
instead of specifying anend_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, or58406520
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 viaPutTraceSegmentsRequest.builder()
- Parameters:
putTraceSegmentsRequest
- AConsumer
that will call methods onPutTraceSegmentsRequest.Builder
to create a request.- Returns:
- Result of the PutTraceSegments operation returned by the service.
- See Also:
-
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidRequestException, ThrottledException, ResourceNotFoundException, TooManyTagsException, AwsServiceException, SdkClientException, XRayException Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InvalidRequestException, ThrottledException, ResourceNotFoundException, TooManyTagsException, AwsServiceException, SdkClientException, XRayException Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InvalidRequestException, ThrottledException, ResourceNotFoundException, AwsServiceException, SdkClientException, XRayException Removes tags from an Amazon Web Services X-Ray group or sampling rule. You cannot edit or delete system tags (those with an
aws:
prefix).- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InvalidRequestException, ThrottledException, ResourceNotFoundException, AwsServiceException, SdkClientException, XRayException Removes tags from an Amazon Web Services X-Ray group or sampling rule. You cannot edit or delete system tags (those with an
aws:
prefix).
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateGroup
default UpdateGroupResponse updateGroup(UpdateGroupRequest updateGroupRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException Updates a group resource.
- Parameters:
updateGroupRequest
-- Returns:
- Result of the UpdateGroup operation returned by the service.
- See Also:
-
updateGroup
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 viaUpdateGroupRequest.builder()
- Parameters:
updateGroupRequest
- AConsumer
that will call methods onUpdateGroupRequest.Builder
to create a request.- Returns:
- Result of the UpdateGroup operation returned by the service.
- See Also:
-
updateSamplingRule
default UpdateSamplingRuleResponse updateSamplingRule(UpdateSamplingRuleRequest updateSamplingRuleRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException Modifies a sampling rule's configuration.
- Parameters:
updateSamplingRuleRequest
-- Returns:
- Result of the UpdateSamplingRule operation returned by the service.
- See Also:
-
updateSamplingRule
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 viaUpdateSamplingRuleRequest.builder()
- Parameters:
updateSamplingRuleRequest
- AConsumer
that will call methods onUpdateSamplingRuleRequest.Builder
to create a request.- Returns:
- Result of the UpdateSamplingRule operation returned by the service.
- See Also:
-
create
Create aXRayClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aXRayClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-