Interface XRayClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface XRayClient extends AwsClient
Service client for accessing AWS X-Ray. This can be created using the staticbuilder()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
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.RuleLimitExceededException- You have reached the maximum number of sampling rules.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.RuleLimitExceededException- You have reached the maximum number of sampling rules.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.InvalidPolicyRevisionIdException- A policy revision id was provided which does not match the latest policy revision. This exception is also if a policy revision id of 0 is provided viaPutResourcePolicyand a policy with the same name already exists.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.InvalidPolicyRevisionIdException- A policy revision id was provided which does not match the latest policy revision. This exception is also if a policy revision id of 0 is provided viaPutResourcePolicyand a policy with the same name already exists.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getEncryptionConfig
default GetEncryptionConfigResponse getEncryptionConfig() throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves the current encryption configuration for X-Ray data.
- Returns:
- Result of the GetEncryptionConfig operation returned by the service.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
getEncryptionConfig(GetEncryptionConfigRequest), AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getGroups
default GetGroupsResponse getGroups() throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves all active group details.
- Returns:
- Result of the GetGroups operation returned by the service.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
getGroups(GetGroupsRequest), AWS API Documentation
-
getGroupsPaginator
default GetGroupsIterable getGroupsPaginator() 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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
getGroupsPaginator(GetGroupsRequest), AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getSamplingRules
default GetSamplingRulesResponse getSamplingRules() throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves all sampling rules.
- Returns:
- Result of the GetSamplingRules operation returned by the service.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
getSamplingRules(GetSamplingRulesRequest), AWS API Documentation
-
getSamplingRulesPaginator
default GetSamplingRulesIterable getSamplingRulesPaginator() 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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
getSamplingRulesPaginator(GetSamplingRulesRequest), AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getSamplingStatisticSummaries
default GetSamplingStatisticSummariesResponse getSamplingStatisticSummaries() throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves information about recent sampling results for all sampling rules.
- Returns:
- Result of the GetSamplingStatisticSummaries operation returned by the service.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
getSamplingStatisticSummaries(GetSamplingStatisticSummariesRequest), AWS API Documentation
-
getSamplingStatisticSummariesPaginator
default GetSamplingStatisticSummariesIterable getSamplingStatisticSummariesPaginator() 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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
getSamplingStatisticSummariesPaginator(GetSamplingStatisticSummariesRequest), AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.ResourceNotFoundException- The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.ResourceNotFoundException- The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.ResourceNotFoundException- The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.ResourceNotFoundException- The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
MalformedPolicyDocumentException- Invalid policy document provided in request.LockoutPreventionException- The provided resource policy would prevent the caller of this request from calling PutResourcePolicy in the future.InvalidPolicyRevisionIdException- A policy revision id was provided which does not match the latest policy revision. This exception is also if a policy revision id of 0 is provided viaPutResourcePolicyand a policy with the same name already exists.PolicySizeLimitExceededException- Exceeded the maximum size for a resource policy.PolicyCountLimitExceededException- Exceeded the maximum number of resource policies for a target Amazon Web Services account.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
MalformedPolicyDocumentException- Invalid policy document provided in request.LockoutPreventionException- The provided resource policy would prevent the caller of this request from calling PutResourcePolicy in the future.InvalidPolicyRevisionIdException- A policy revision id was provided which does not match the latest policy revision. This exception is also if a policy revision id of 0 is provided viaPutResourcePolicyand a policy with the same name already exists.PolicySizeLimitExceededException- Exceeded the maximum size for a resource policy.PolicyCountLimitExceededException- Exceeded the maximum number of resource policies for a target Amazon Web Services account.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.ResourceNotFoundException- The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.TooManyTagsException- You have exceeded the maximum number of tags you can apply to this resource.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.ResourceNotFoundException- The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.TooManyTagsException- You have exceeded the maximum number of tags you can apply to this resource.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.ResourceNotFoundException- The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.ResourceNotFoundException- The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The request is missing required parameters or has invalid parameters.ThrottledException- The request exceeds the maximum number of requests per second.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
create
static XRayClient create()
Create aXRayClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static XRayClientBuilder builder()
Create a builder that can be used to configure and create aXRayClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default XRayServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-