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
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptiondefault BatchGetTracesResponsebatchGetTraces(Consumer<BatchGetTracesRequest.Builder> batchGetTracesRequest) Retrieves a list of traces specified by ID.default BatchGetTracesResponsebatchGetTraces(BatchGetTracesRequest batchGetTracesRequest) Retrieves a list of traces specified by ID.default BatchGetTracesIterablebatchGetTracesPaginator(Consumer<BatchGetTracesRequest.Builder> batchGetTracesRequest) This is a variant ofbatchGetTraces(software.amazon.awssdk.services.xray.model.BatchGetTracesRequest)operation.default BatchGetTracesIterablebatchGetTracesPaginator(BatchGetTracesRequest batchGetTracesRequest) This is a variant ofbatchGetTraces(software.amazon.awssdk.services.xray.model.BatchGetTracesRequest)operation.static XRayClientBuilderbuilder()Create a builder that can be used to configure and create aXRayClient.static XRayClientcreate()Create aXRayClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateGroupResponsecreateGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest) Creates a group resource with a name and a filter expression.default CreateGroupResponsecreateGroup(CreateGroupRequest createGroupRequest) Creates a group resource with a name and a filter expression.default CreateSamplingRuleResponsecreateSamplingRule(Consumer<CreateSamplingRuleRequest.Builder> createSamplingRuleRequest) Creates a rule to control sampling behavior for instrumented applications.default CreateSamplingRuleResponsecreateSamplingRule(CreateSamplingRuleRequest createSamplingRuleRequest) Creates a rule to control sampling behavior for instrumented applications.default DeleteGroupResponsedeleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest) Deletes a group resource.default DeleteGroupResponsedeleteGroup(DeleteGroupRequest deleteGroupRequest) Deletes a group resource.default DeleteResourcePolicyResponsedeleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest) Deletes a resource policy from the target Amazon Web Services account.default DeleteResourcePolicyResponsedeleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest) Deletes a resource policy from the target Amazon Web Services account.default DeleteSamplingRuleResponsedeleteSamplingRule(Consumer<DeleteSamplingRuleRequest.Builder> deleteSamplingRuleRequest) Deletes a sampling rule.default DeleteSamplingRuleResponsedeleteSamplingRule(DeleteSamplingRuleRequest deleteSamplingRuleRequest) Deletes a sampling rule.default GetEncryptionConfigResponseRetrieves the current encryption configuration for X-Ray data.default GetEncryptionConfigResponsegetEncryptionConfig(Consumer<GetEncryptionConfigRequest.Builder> getEncryptionConfigRequest) Retrieves the current encryption configuration for X-Ray data.default GetEncryptionConfigResponsegetEncryptionConfig(GetEncryptionConfigRequest getEncryptionConfigRequest) Retrieves the current encryption configuration for X-Ray data.default GetGroupResponsegetGroup(Consumer<GetGroupRequest.Builder> getGroupRequest) Retrieves group resource details.default GetGroupResponsegetGroup(GetGroupRequest getGroupRequest) Retrieves group resource details.default GetGroupsResponseRetrieves all active group details.default GetGroupsResponsegetGroups(Consumer<GetGroupsRequest.Builder> getGroupsRequest) Retrieves all active group details.default GetGroupsResponsegetGroups(GetGroupsRequest getGroupsRequest) Retrieves all active group details.default GetGroupsIterableThis is a variant ofgetGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest)operation.default GetGroupsIterablegetGroupsPaginator(Consumer<GetGroupsRequest.Builder> getGroupsRequest) This is a variant ofgetGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest)operation.default GetGroupsIterablegetGroupsPaginator(GetGroupsRequest getGroupsRequest) This is a variant ofgetGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest)operation.default GetInsightResponsegetInsight(Consumer<GetInsightRequest.Builder> getInsightRequest) Retrieves the summary information of an insight.default GetInsightResponsegetInsight(GetInsightRequest getInsightRequest) Retrieves the summary information of an insight.default GetInsightEventsResponsegetInsightEvents(Consumer<GetInsightEventsRequest.Builder> getInsightEventsRequest) X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event.default GetInsightEventsResponsegetInsightEvents(GetInsightEventsRequest getInsightEventsRequest) X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event.default GetInsightEventsIterablegetInsightEventsPaginator(Consumer<GetInsightEventsRequest.Builder> getInsightEventsRequest) This is a variant ofgetInsightEvents(software.amazon.awssdk.services.xray.model.GetInsightEventsRequest)operation.default GetInsightEventsIterablegetInsightEventsPaginator(GetInsightEventsRequest getInsightEventsRequest) This is a variant ofgetInsightEvents(software.amazon.awssdk.services.xray.model.GetInsightEventsRequest)operation.default GetInsightImpactGraphResponsegetInsightImpactGraph(Consumer<GetInsightImpactGraphRequest.Builder> getInsightImpactGraphRequest) Retrieves a service graph structure filtered by the specified insight.default GetInsightImpactGraphResponsegetInsightImpactGraph(GetInsightImpactGraphRequest getInsightImpactGraphRequest) Retrieves a service graph structure filtered by the specified insight.default GetInsightSummariesResponsegetInsightSummaries(Consumer<GetInsightSummariesRequest.Builder> getInsightSummariesRequest) Retrieves the summaries of all insights in the specified group matching the provided filter values.default GetInsightSummariesResponsegetInsightSummaries(GetInsightSummariesRequest getInsightSummariesRequest) Retrieves the summaries of all insights in the specified group matching the provided filter values.default GetInsightSummariesIterablegetInsightSummariesPaginator(Consumer<GetInsightSummariesRequest.Builder> getInsightSummariesRequest) This is a variant ofgetInsightSummaries(software.amazon.awssdk.services.xray.model.GetInsightSummariesRequest)operation.default GetInsightSummariesIterablegetInsightSummariesPaginator(GetInsightSummariesRequest getInsightSummariesRequest) This is a variant ofgetInsightSummaries(software.amazon.awssdk.services.xray.model.GetInsightSummariesRequest)operation.default GetSamplingRulesResponseRetrieves all sampling rules.default GetSamplingRulesResponsegetSamplingRules(Consumer<GetSamplingRulesRequest.Builder> getSamplingRulesRequest) Retrieves all sampling rules.default GetSamplingRulesResponsegetSamplingRules(GetSamplingRulesRequest getSamplingRulesRequest) Retrieves all sampling rules.default GetSamplingRulesIterableThis is a variant ofgetSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest)operation.default GetSamplingRulesIterablegetSamplingRulesPaginator(Consumer<GetSamplingRulesRequest.Builder> getSamplingRulesRequest) This is a variant ofgetSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest)operation.default GetSamplingRulesIterablegetSamplingRulesPaginator(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 GetSamplingTargetsResponsegetSamplingTargets(Consumer<GetSamplingTargetsRequest.Builder> getSamplingTargetsRequest) Requests a sampling quota for rules that the service is using to sample requests.default GetSamplingTargetsResponsegetSamplingTargets(GetSamplingTargetsRequest getSamplingTargetsRequest) Requests a sampling quota for rules that the service is using to sample requests.default GetServiceGraphResponsegetServiceGraph(Consumer<GetServiceGraphRequest.Builder> getServiceGraphRequest) Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result.default GetServiceGraphResponsegetServiceGraph(GetServiceGraphRequest getServiceGraphRequest) Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result.default GetServiceGraphIterablegetServiceGraphPaginator(Consumer<GetServiceGraphRequest.Builder> getServiceGraphRequest) This is a variant ofgetServiceGraph(software.amazon.awssdk.services.xray.model.GetServiceGraphRequest)operation.default GetServiceGraphIterablegetServiceGraphPaginator(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 GetTraceGraphResponsegetTraceGraph(Consumer<GetTraceGraphRequest.Builder> getTraceGraphRequest) Retrieves a service graph for one or more specific trace IDs.default GetTraceGraphResponsegetTraceGraph(GetTraceGraphRequest getTraceGraphRequest) Retrieves a service graph for one or more specific trace IDs.default GetTraceGraphIterablegetTraceGraphPaginator(Consumer<GetTraceGraphRequest.Builder> getTraceGraphRequest) This is a variant ofgetTraceGraph(software.amazon.awssdk.services.xray.model.GetTraceGraphRequest)operation.default GetTraceGraphIterablegetTraceGraphPaginator(GetTraceGraphRequest getTraceGraphRequest) This is a variant ofgetTraceGraph(software.amazon.awssdk.services.xray.model.GetTraceGraphRequest)operation.default GetTraceSummariesResponsegetTraceSummaries(Consumer<GetTraceSummariesRequest.Builder> getTraceSummariesRequest) Retrieves IDs and annotations for traces available for a specified time frame using an optional filter.default GetTraceSummariesResponsegetTraceSummaries(GetTraceSummariesRequest getTraceSummariesRequest) Retrieves IDs and annotations for traces available for a specified time frame using an optional filter.default GetTraceSummariesIterablegetTraceSummariesPaginator(Consumer<GetTraceSummariesRequest.Builder> getTraceSummariesRequest) This is a variant ofgetTraceSummaries(software.amazon.awssdk.services.xray.model.GetTraceSummariesRequest)operation.default GetTraceSummariesIterablegetTraceSummariesPaginator(GetTraceSummariesRequest getTraceSummariesRequest) This is a variant ofgetTraceSummaries(software.amazon.awssdk.services.xray.model.GetTraceSummariesRequest)operation.default ListResourcePoliciesResponselistResourcePolicies(Consumer<ListResourcePoliciesRequest.Builder> listResourcePoliciesRequest) Returns the list of resource policies in the target Amazon Web Services account.default ListResourcePoliciesResponselistResourcePolicies(ListResourcePoliciesRequest listResourcePoliciesRequest) Returns the list of resource policies in the target Amazon Web Services account.default ListResourcePoliciesIterablelistResourcePoliciesPaginator(Consumer<ListResourcePoliciesRequest.Builder> listResourcePoliciesRequest) This is a variant oflistResourcePolicies(software.amazon.awssdk.services.xray.model.ListResourcePoliciesRequest)operation.default ListResourcePoliciesIterablelistResourcePoliciesPaginator(ListResourcePoliciesRequest listResourcePoliciesRequest) This is a variant oflistResourcePolicies(software.amazon.awssdk.services.xray.model.ListResourcePoliciesRequest)operation.default ListTagsForResourceResponselistTagsForResource(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 ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.default ListTagsForResourceIterablelistTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.xray.model.ListTagsForResourceRequest)operation.default ListTagsForResourceIterablelistTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.xray.model.ListTagsForResourceRequest)operation.default PutEncryptionConfigResponseputEncryptionConfig(Consumer<PutEncryptionConfigRequest.Builder> putEncryptionConfigRequest) Updates the encryption configuration for X-Ray data.default PutEncryptionConfigResponseputEncryptionConfig(PutEncryptionConfigRequest putEncryptionConfigRequest) Updates the encryption configuration for X-Ray data.default PutResourcePolicyResponseputResourcePolicy(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 PutResourcePolicyResponseputResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest) Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access X-Ray.default PutTelemetryRecordsResponseputTelemetryRecords(Consumer<PutTelemetryRecordsRequest.Builder> putTelemetryRecordsRequest) Used by the Amazon Web Services X-Ray daemon to upload telemetry.default PutTelemetryRecordsResponseputTelemetryRecords(PutTelemetryRecordsRequest putTelemetryRecordsRequest) Used by the Amazon Web Services X-Ray daemon to upload telemetry.default PutTraceSegmentsResponseputTraceSegments(Consumer<PutTraceSegmentsRequest.Builder> putTraceSegmentsRequest) Uploads segment documents to Amazon Web Services X-Ray.default PutTraceSegmentsResponseputTraceSegments(PutTraceSegmentsRequest putTraceSegmentsRequest) Uploads segment documents to Amazon Web Services X-Ray.default XRayServiceClientConfigurationThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadatadefault TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest) Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from an Amazon Web Services X-Ray group or sampling rule.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest) Removes tags from an Amazon Web Services X-Ray group or sampling rule.default UpdateGroupResponseupdateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest) Updates a group resource.default UpdateGroupResponseupdateGroup(UpdateGroupRequest updateGroupRequest) Updates a group resource.default UpdateSamplingRuleResponseupdateSamplingRule(Consumer<UpdateSamplingRuleRequest.Builder> updateSamplingRuleRequest) Modifies a sampling rule's configuration.default UpdateSamplingRuleResponseupdateSamplingRule(UpdateSamplingRuleRequest updateSamplingRuleRequest) Modifies a sampling rule's configuration.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods 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
GetTraceSummariesto 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
GetTraceSummariesto get a list of trace IDs.
This is a convenience which creates an instance of the
BatchGetTracesRequest.Builderavoiding the need to create one manually viaBatchGetTracesRequest.builder()- Parameters:
batchGetTracesRequest- AConsumerthat will call methods onBatchGetTracesRequest.Builderto 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 Stream
2) Using For loopsoftware.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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaBatchGetTracesRequest.builder()- Parameters:
batchGetTracesRequest- AConsumerthat will call methods onBatchGetTracesRequest.Builderto 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.Builderavoiding the need to create one manually viaCreateGroupRequest.builder()- Parameters:
createGroupRequest- AConsumerthat will call methods onCreateGroupRequest.Builderto 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.Builderavoiding the need to create one manually viaCreateSamplingRuleRequest.builder()- Parameters:
createSamplingRuleRequest- AConsumerthat will call methods onCreateSamplingRuleRequest.Builderto 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.Builderavoiding the need to create one manually viaDeleteGroupRequest.builder()- Parameters:
deleteGroupRequest- AConsumerthat will call methods onDeleteGroupRequest.Builderto 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.Builderavoiding the need to create one manually viaDeleteResourcePolicyRequest.builder()- Parameters:
deleteResourcePolicyRequest- AConsumerthat will call methods onDeleteResourcePolicyRequest.Builderto 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.Builderavoiding the need to create one manually viaDeleteSamplingRuleRequest.builder()- Parameters:
deleteSamplingRuleRequest- AConsumerthat will call methods onDeleteSamplingRuleRequest.Builderto 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.Builderavoiding the need to create one manually viaGetEncryptionConfigRequest.builder()- Parameters:
getEncryptionConfigRequest- AConsumerthat will call methods onGetEncryptionConfigRequest.Builderto 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.Builderavoiding the need to create one manually viaGetGroupRequest.builder()- Parameters:
getGroupRequest- AConsumerthat will call methods onGetGroupRequest.Builderto 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.Builderavoiding the need to create one manually viaGetGroupsRequest.builder()- Parameters:
getGroupsRequest- AConsumerthat will call methods onGetGroupsRequest.Builderto 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 Stream
2) Using For loopsoftware.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 Stream
2) Using For loopsoftware.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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaGetGroupsRequest.builder()- Parameters:
getGroupsRequest- AConsumerthat will call methods onGetGroupsRequest.Builderto 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.Builderavoiding the need to create one manually viaGetInsightRequest.builder()- Parameters:
getInsightRequest- AConsumerthat will call methods onGetInsightRequest.Builderto 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.Builderavoiding the need to create one manually viaGetInsightEventsRequest.builder()- Parameters:
getInsightEventsRequest- AConsumerthat will call methods onGetInsightEventsRequest.Builderto 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 Stream
2) Using For loopsoftware.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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaGetInsightEventsRequest.builder()- Parameters:
getInsightEventsRequest- AConsumerthat will call methods onGetInsightEventsRequest.Builderto 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.Builderavoiding the need to create one manually viaGetInsightImpactGraphRequest.builder()- Parameters:
getInsightImpactGraphRequest- AConsumerthat will call methods onGetInsightImpactGraphRequest.Builderto 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.Builderavoiding the need to create one manually viaGetInsightSummariesRequest.builder()- Parameters:
getInsightSummariesRequest- AConsumerthat will call methods onGetInsightSummariesRequest.Builderto 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 Stream
2) Using For loopsoftware.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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaGetInsightSummariesRequest.builder()- Parameters:
getInsightSummariesRequest- AConsumerthat will call methods onGetInsightSummariesRequest.Builderto 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.Builderavoiding the need to create one manually viaGetSamplingRulesRequest.builder()- Parameters:
getSamplingRulesRequest- AConsumerthat will call methods onGetSamplingRulesRequest.Builderto 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 Stream
2) Using For loopsoftware.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 Stream
2) Using For loopsoftware.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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaGetSamplingRulesRequest.builder()- Parameters:
getSamplingRulesRequest- AConsumerthat will call methods onGetSamplingRulesRequest.Builderto 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.Builderavoiding the need to create one manually viaGetSamplingStatisticSummariesRequest.builder()- Parameters:
getSamplingStatisticSummariesRequest- AConsumerthat will call methods onGetSamplingStatisticSummariesRequest.Builderto 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 Stream
2) Using For loopsoftware.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 Stream
2) Using For loopsoftware.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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaGetSamplingStatisticSummariesRequest.builder()- Parameters:
getSamplingStatisticSummariesRequest- AConsumerthat will call methods onGetSamplingStatisticSummariesRequest.Builderto 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.Builderavoiding the need to create one manually viaGetSamplingTargetsRequest.builder()- Parameters:
getSamplingTargetsRequest- AConsumerthat will call methods onGetSamplingTargetsRequest.Builderto 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.Builderavoiding the need to create one manually viaGetServiceGraphRequest.builder()- Parameters:
getServiceGraphRequest- AConsumerthat will call methods onGetServiceGraphRequest.Builderto 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 Stream
2) Using For loopsoftware.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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaGetServiceGraphRequest.builder()- Parameters:
getServiceGraphRequest- AConsumerthat will call methods onGetServiceGraphRequest.Builderto 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.Builderavoiding the need to create one manually viaGetTimeSeriesServiceStatisticsRequest.builder()- Parameters:
getTimeSeriesServiceStatisticsRequest- AConsumerthat will call methods onGetTimeSeriesServiceStatisticsRequest.Builderto 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 Stream
2) Using For loopsoftware.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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaGetTimeSeriesServiceStatisticsRequest.builder()- Parameters:
getTimeSeriesServiceStatisticsRequest- AConsumerthat will call methods onGetTimeSeriesServiceStatisticsRequest.Builderto 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.Builderavoiding the need to create one manually viaGetTraceGraphRequest.builder()- Parameters:
getTraceGraphRequest- AConsumerthat will call methods onGetTraceGraphRequest.Builderto 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 Stream
2) Using For loopsoftware.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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaGetTraceGraphRequest.builder()- Parameters:
getTraceGraphRequest- AConsumerthat will call methods onGetTraceGraphRequest.Builderto 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
accountwith 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
accountwith 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.Builderavoiding the need to create one manually viaGetTraceSummariesRequest.builder()- Parameters:
getTraceSummariesRequest- AConsumerthat will call methods onGetTraceSummariesRequest.Builderto 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 Stream
2) Using For loopsoftware.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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaGetTraceSummariesRequest.builder()- Parameters:
getTraceSummariesRequest- AConsumerthat will call methods onGetTraceSummariesRequest.Builderto 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.Builderavoiding the need to create one manually viaListResourcePoliciesRequest.builder()- Parameters:
listResourcePoliciesRequest- AConsumerthat will call methods onListResourcePoliciesRequest.Builderto 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 Stream
2) Using For loopsoftware.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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaListResourcePoliciesRequest.builder()- Parameters:
listResourcePoliciesRequest- AConsumerthat will call methods onListResourcePoliciesRequest.Builderto 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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto 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 Stream
2) Using For loopsoftware.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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto 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.Builderavoiding the need to create one manually viaPutEncryptionConfigRequest.builder()- Parameters:
putEncryptionConfigRequest- AConsumerthat will call methods onPutEncryptionConfigRequest.Builderto 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.Builderavoiding the need to create one manually viaPutResourcePolicyRequest.builder()- Parameters:
putResourcePolicyRequest- AConsumerthat will call methods onPutResourcePolicyRequest.Builderto 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.Builderavoiding the need to create one manually viaPutTelemetryRecordsRequest.builder()- Parameters:
putTelemetryRecordsRequest- AConsumerthat will call methods onPutTelemetryRecordsRequest.Builderto 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.010or1.480615200010E9. -
end_time- Time the segment or subsegment was closed. For example,1480615200.090or1.480615200090E9. Specify either anend_timeorin_progress. -
in_progress- Set totrueinstead of specifying anend_timeto 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_idconsists 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
1480615200seconds, or58406520in 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.010or1.480615200010E9. -
end_time- Time the segment or subsegment was closed. For example,1480615200.090or1.480615200090E9. Specify either anend_timeorin_progress. -
in_progress- Set totrueinstead of specifying anend_timeto 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_idconsists 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
1480615200seconds, or58406520in 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.Builderavoiding the need to create one manually viaPutTraceSegmentsRequest.builder()- Parameters:
putTraceSegmentsRequest- AConsumerthat will call methods onPutTraceSegmentsRequest.Builderto 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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto 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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto 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.Builderavoiding the need to create one manually viaUpdateGroupRequest.builder()- Parameters:
updateGroupRequest- AConsumerthat will call methods onUpdateGroupRequest.Builderto 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.Builderavoiding the need to create one manually viaUpdateSamplingRuleRequest.builder()- Parameters:
updateSamplingRuleRequest- AConsumerthat will call methods onUpdateSamplingRuleRequest.Builderto create a request.- Returns:
- Result of the UpdateSamplingRule operation returned by the service.
- See Also:
-
create
Create aXRayClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aXRayClient. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-