Interface BraketClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
The Amazon Braket API Reference provides information about the operations and structures supported in Amazon Braket.
Additional Resources:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic BraketClientBuilder
builder()
Create a builder that can be used to configure and create aBraketClient
.default CancelJobResponse
cancelJob
(Consumer<CancelJobRequest.Builder> cancelJobRequest) Cancels an Amazon Braket job.default CancelJobResponse
cancelJob
(CancelJobRequest cancelJobRequest) Cancels an Amazon Braket job.default CancelQuantumTaskResponse
cancelQuantumTask
(Consumer<CancelQuantumTaskRequest.Builder> cancelQuantumTaskRequest) Cancels the specified task.default CancelQuantumTaskResponse
cancelQuantumTask
(CancelQuantumTaskRequest cancelQuantumTaskRequest) Cancels the specified task.static BraketClient
create()
Create aBraketClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateJobResponse
createJob
(Consumer<CreateJobRequest.Builder> createJobRequest) Creates an Amazon Braket job.default CreateJobResponse
createJob
(CreateJobRequest createJobRequest) Creates an Amazon Braket job.default CreateQuantumTaskResponse
createQuantumTask
(Consumer<CreateQuantumTaskRequest.Builder> createQuantumTaskRequest) Creates a quantum task.default CreateQuantumTaskResponse
createQuantumTask
(CreateQuantumTaskRequest createQuantumTaskRequest) Creates a quantum task.default GetDeviceResponse
getDevice
(Consumer<GetDeviceRequest.Builder> getDeviceRequest) Retrieves the devices available in Amazon Braket.default GetDeviceResponse
getDevice
(GetDeviceRequest getDeviceRequest) Retrieves the devices available in Amazon Braket.default GetJobResponse
getJob
(Consumer<GetJobRequest.Builder> getJobRequest) Retrieves the specified Amazon Braket job.default GetJobResponse
getJob
(GetJobRequest getJobRequest) Retrieves the specified Amazon Braket job.default GetQuantumTaskResponse
getQuantumTask
(Consumer<GetQuantumTaskRequest.Builder> getQuantumTaskRequest) Retrieves the specified quantum task.default GetQuantumTaskResponse
getQuantumTask
(GetQuantumTaskRequest getQuantumTaskRequest) Retrieves the specified quantum task.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Shows the tags associated with this resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Shows the tags associated with this resource.default SearchDevicesResponse
searchDevices
(Consumer<SearchDevicesRequest.Builder> searchDevicesRequest) Searches for devices using the specified filters.default SearchDevicesResponse
searchDevices
(SearchDevicesRequest searchDevicesRequest) Searches for devices using the specified filters.default SearchDevicesIterable
searchDevicesPaginator
(Consumer<SearchDevicesRequest.Builder> searchDevicesRequest) This is a variant ofsearchDevices(software.amazon.awssdk.services.braket.model.SearchDevicesRequest)
operation.default SearchDevicesIterable
searchDevicesPaginator
(SearchDevicesRequest searchDevicesRequest) This is a variant ofsearchDevices(software.amazon.awssdk.services.braket.model.SearchDevicesRequest)
operation.default SearchJobsResponse
searchJobs
(Consumer<SearchJobsRequest.Builder> searchJobsRequest) Searches for Amazon Braket jobs that match the specified filter values.default SearchJobsResponse
searchJobs
(SearchJobsRequest searchJobsRequest) Searches for Amazon Braket jobs that match the specified filter values.default SearchJobsIterable
searchJobsPaginator
(Consumer<SearchJobsRequest.Builder> searchJobsRequest) This is a variant ofsearchJobs(software.amazon.awssdk.services.braket.model.SearchJobsRequest)
operation.default SearchJobsIterable
searchJobsPaginator
(SearchJobsRequest searchJobsRequest) This is a variant ofsearchJobs(software.amazon.awssdk.services.braket.model.SearchJobsRequest)
operation.default SearchQuantumTasksResponse
searchQuantumTasks
(Consumer<SearchQuantumTasksRequest.Builder> searchQuantumTasksRequest) Searches for tasks that match the specified filter values.default SearchQuantumTasksResponse
searchQuantumTasks
(SearchQuantumTasksRequest searchQuantumTasksRequest) Searches for tasks that match the specified filter values.default SearchQuantumTasksIterable
searchQuantumTasksPaginator
(Consumer<SearchQuantumTasksRequest.Builder> searchQuantumTasksRequest) This is a variant ofsearchQuantumTasks(software.amazon.awssdk.services.braket.model.SearchQuantumTasksRequest)
operation.default SearchQuantumTasksIterable
searchQuantumTasksPaginator
(SearchQuantumTasksRequest searchQuantumTasksRequest) This is a variant ofsearchQuantumTasks(software.amazon.awssdk.services.braket.model.SearchQuantumTasksRequest)
operation.default BraketServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Add a tag to the specified resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Add a tag to the specified resource.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Remove tags from a resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Remove tags from a resource.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
cancelJob
default CancelJobResponse cancelJob(CancelJobRequest cancelJobRequest) throws ResourceNotFoundException, AccessDeniedException, ConflictException, ThrottlingException, InternalServiceException, ValidationException, AwsServiceException, SdkClientException, BraketException Cancels an Amazon Braket job.
- Parameters:
cancelJobRequest
-- Returns:
- Result of the CancelJob operation returned by the service.
- See Also:
-
cancelJob
default CancelJobResponse cancelJob(Consumer<CancelJobRequest.Builder> cancelJobRequest) throws ResourceNotFoundException, AccessDeniedException, ConflictException, ThrottlingException, InternalServiceException, ValidationException, AwsServiceException, SdkClientException, BraketException Cancels an Amazon Braket job.
This is a convenience which creates an instance of the
CancelJobRequest.Builder
avoiding the need to create one manually viaCancelJobRequest.builder()
- Parameters:
cancelJobRequest
- AConsumer
that will call methods onCancelJobRequest.Builder
to create a request.- Returns:
- Result of the CancelJob operation returned by the service.
- See Also:
-
cancelQuantumTask
default CancelQuantumTaskResponse cancelQuantumTask(CancelQuantumTaskRequest cancelQuantumTaskRequest) throws ResourceNotFoundException, AccessDeniedException, ConflictException, ThrottlingException, InternalServiceException, ValidationException, AwsServiceException, SdkClientException, BraketException Cancels the specified task.
- Parameters:
cancelQuantumTaskRequest
-- Returns:
- Result of the CancelQuantumTask operation returned by the service.
- See Also:
-
cancelQuantumTask
default CancelQuantumTaskResponse cancelQuantumTask(Consumer<CancelQuantumTaskRequest.Builder> cancelQuantumTaskRequest) throws ResourceNotFoundException, AccessDeniedException, ConflictException, ThrottlingException, InternalServiceException, ValidationException, AwsServiceException, SdkClientException, BraketException Cancels the specified task.
This is a convenience which creates an instance of the
CancelQuantumTaskRequest.Builder
avoiding the need to create one manually viaCancelQuantumTaskRequest.builder()
- Parameters:
cancelQuantumTaskRequest
- AConsumer
that will call methods onCancelQuantumTaskRequest.Builder
to create a request.- Returns:
- Result of the CancelQuantumTask operation returned by the service.
- See Also:
-
createJob
default CreateJobResponse createJob(CreateJobRequest createJobRequest) throws ConflictException, AccessDeniedException, ThrottlingException, DeviceOfflineException, DeviceRetiredException, InternalServiceException, ServiceQuotaExceededException, ValidationException, AwsServiceException, SdkClientException, BraketException Creates an Amazon Braket job.
- Parameters:
createJobRequest
-- Returns:
- Result of the CreateJob operation returned by the service.
- See Also:
-
createJob
default CreateJobResponse createJob(Consumer<CreateJobRequest.Builder> createJobRequest) throws ConflictException, AccessDeniedException, ThrottlingException, DeviceOfflineException, DeviceRetiredException, InternalServiceException, ServiceQuotaExceededException, ValidationException, AwsServiceException, SdkClientException, BraketException Creates an Amazon Braket job.
This is a convenience which creates an instance of the
CreateJobRequest.Builder
avoiding the need to create one manually viaCreateJobRequest.builder()
- Parameters:
createJobRequest
- AConsumer
that will call methods onCreateJobRequest.Builder
to create a request.- Returns:
- Result of the CreateJob operation returned by the service.
- See Also:
-
createQuantumTask
default CreateQuantumTaskResponse createQuantumTask(CreateQuantumTaskRequest createQuantumTaskRequest) throws AccessDeniedException, ThrottlingException, DeviceOfflineException, DeviceRetiredException, InternalServiceException, ServiceQuotaExceededException, ValidationException, AwsServiceException, SdkClientException, BraketException Creates a quantum task.
- Parameters:
createQuantumTaskRequest
-- Returns:
- Result of the CreateQuantumTask operation returned by the service.
- See Also:
-
createQuantumTask
default CreateQuantumTaskResponse createQuantumTask(Consumer<CreateQuantumTaskRequest.Builder> createQuantumTaskRequest) throws AccessDeniedException, ThrottlingException, DeviceOfflineException, DeviceRetiredException, InternalServiceException, ServiceQuotaExceededException, ValidationException, AwsServiceException, SdkClientException, BraketException Creates a quantum task.
This is a convenience which creates an instance of the
CreateQuantumTaskRequest.Builder
avoiding the need to create one manually viaCreateQuantumTaskRequest.builder()
- Parameters:
createQuantumTaskRequest
- AConsumer
that will call methods onCreateQuantumTaskRequest.Builder
to create a request.- Returns:
- Result of the CreateQuantumTask operation returned by the service.
- See Also:
-
getDevice
default GetDeviceResponse getDevice(GetDeviceRequest getDeviceRequest) throws ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServiceException, ValidationException, AwsServiceException, SdkClientException, BraketException Retrieves the devices available in Amazon Braket.
For backwards compatibility with older versions of BraketSchemas, OpenQASM information is omitted from GetDevice API calls. To get this information the user-agent needs to present a recent version of the BraketSchemas (1.8.0 or later). The Braket SDK automatically reports this for you. If you do not see OpenQASM results in the GetDevice response when using a Braket SDK, you may need to set AWS_EXECUTION_ENV environment variable to configure user-agent. See the code examples provided below for how to do this for the AWS CLI, Boto3, and the Go, Java, and JavaScript/TypeScript SDKs.
- Parameters:
getDeviceRequest
-- Returns:
- Result of the GetDevice operation returned by the service.
- See Also:
-
getDevice
default GetDeviceResponse getDevice(Consumer<GetDeviceRequest.Builder> getDeviceRequest) throws ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServiceException, ValidationException, AwsServiceException, SdkClientException, BraketException Retrieves the devices available in Amazon Braket.
For backwards compatibility with older versions of BraketSchemas, OpenQASM information is omitted from GetDevice API calls. To get this information the user-agent needs to present a recent version of the BraketSchemas (1.8.0 or later). The Braket SDK automatically reports this for you. If you do not see OpenQASM results in the GetDevice response when using a Braket SDK, you may need to set AWS_EXECUTION_ENV environment variable to configure user-agent. See the code examples provided below for how to do this for the AWS CLI, Boto3, and the Go, Java, and JavaScript/TypeScript SDKs.
This is a convenience which creates an instance of the
GetDeviceRequest.Builder
avoiding the need to create one manually viaGetDeviceRequest.builder()
- Parameters:
getDeviceRequest
- AConsumer
that will call methods onGetDeviceRequest.Builder
to create a request.- Returns:
- Result of the GetDevice operation returned by the service.
- See Also:
-
getJob
default GetJobResponse getJob(GetJobRequest getJobRequest) throws ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServiceException, ValidationException, AwsServiceException, SdkClientException, BraketException Retrieves the specified Amazon Braket job.
- Parameters:
getJobRequest
-- Returns:
- Result of the GetJob operation returned by the service.
- See Also:
-
getJob
default GetJobResponse getJob(Consumer<GetJobRequest.Builder> getJobRequest) throws ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServiceException, ValidationException, AwsServiceException, SdkClientException, BraketException Retrieves the specified Amazon Braket job.
This is a convenience which creates an instance of the
GetJobRequest.Builder
avoiding the need to create one manually viaGetJobRequest.builder()
- Parameters:
getJobRequest
- AConsumer
that will call methods onGetJobRequest.Builder
to create a request.- Returns:
- Result of the GetJob operation returned by the service.
- See Also:
-
getQuantumTask
default GetQuantumTaskResponse getQuantumTask(GetQuantumTaskRequest getQuantumTaskRequest) throws ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServiceException, ValidationException, AwsServiceException, SdkClientException, BraketException Retrieves the specified quantum task.
- Parameters:
getQuantumTaskRequest
-- Returns:
- Result of the GetQuantumTask operation returned by the service.
- See Also:
-
getQuantumTask
default GetQuantumTaskResponse getQuantumTask(Consumer<GetQuantumTaskRequest.Builder> getQuantumTaskRequest) throws ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServiceException, ValidationException, AwsServiceException, SdkClientException, BraketException Retrieves the specified quantum task.
This is a convenience which creates an instance of the
GetQuantumTaskRequest.Builder
avoiding the need to create one manually viaGetQuantumTaskRequest.builder()
- Parameters:
getQuantumTaskRequest
- AConsumer
that will call methods onGetQuantumTaskRequest.Builder
to create a request.- Returns:
- Result of the GetQuantumTask operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, InternalServiceException, ValidationException, AwsServiceException, SdkClientException, BraketException Shows the tags associated with this resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, InternalServiceException, ValidationException, AwsServiceException, SdkClientException, BraketException Shows the tags associated with this resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
searchDevices
default SearchDevicesResponse searchDevices(SearchDevicesRequest searchDevicesRequest) throws AccessDeniedException, ThrottlingException, InternalServiceException, ValidationException, AwsServiceException, SdkClientException, BraketException Searches for devices using the specified filters.
- Parameters:
searchDevicesRequest
-- Returns:
- Result of the SearchDevices operation returned by the service.
- See Also:
-
searchDevices
default SearchDevicesResponse searchDevices(Consumer<SearchDevicesRequest.Builder> searchDevicesRequest) throws AccessDeniedException, ThrottlingException, InternalServiceException, ValidationException, AwsServiceException, SdkClientException, BraketException Searches for devices using the specified filters.
This is a convenience which creates an instance of the
SearchDevicesRequest.Builder
avoiding the need to create one manually viaSearchDevicesRequest.builder()
- Parameters:
searchDevicesRequest
- AConsumer
that will call methods onSearchDevicesRequest.Builder
to create a request.- Returns:
- Result of the SearchDevices operation returned by the service.
- See Also:
-
searchDevicesPaginator
default SearchDevicesIterable searchDevicesPaginator(SearchDevicesRequest searchDevicesRequest) throws AccessDeniedException, ThrottlingException, InternalServiceException, ValidationException, AwsServiceException, SdkClientException, BraketException This is a variant of
searchDevices(software.amazon.awssdk.services.braket.model.SearchDevicesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.braket.paginators.SearchDevicesIterable responses = client.searchDevicesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.braket.paginators.SearchDevicesIterable responses = client.searchDevicesPaginator(request); for (software.amazon.awssdk.services.braket.model.SearchDevicesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.braket.paginators.SearchDevicesIterable responses = client.searchDevicesPaginator(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
searchDevices(software.amazon.awssdk.services.braket.model.SearchDevicesRequest)
operation.- Parameters:
searchDevicesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchDevicesPaginator
default SearchDevicesIterable searchDevicesPaginator(Consumer<SearchDevicesRequest.Builder> searchDevicesRequest) throws AccessDeniedException, ThrottlingException, InternalServiceException, ValidationException, AwsServiceException, SdkClientException, BraketException This is a variant of
searchDevices(software.amazon.awssdk.services.braket.model.SearchDevicesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.braket.paginators.SearchDevicesIterable responses = client.searchDevicesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.braket.paginators.SearchDevicesIterable responses = client.searchDevicesPaginator(request); for (software.amazon.awssdk.services.braket.model.SearchDevicesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.braket.paginators.SearchDevicesIterable responses = client.searchDevicesPaginator(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
searchDevices(software.amazon.awssdk.services.braket.model.SearchDevicesRequest)
operation.
This is a convenience which creates an instance of the
SearchDevicesRequest.Builder
avoiding the need to create one manually viaSearchDevicesRequest.builder()
- Parameters:
searchDevicesRequest
- AConsumer
that will call methods onSearchDevicesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchJobs
default SearchJobsResponse searchJobs(SearchJobsRequest searchJobsRequest) throws AccessDeniedException, ThrottlingException, InternalServiceException, ValidationException, AwsServiceException, SdkClientException, BraketException Searches for Amazon Braket jobs that match the specified filter values.
- Parameters:
searchJobsRequest
-- Returns:
- Result of the SearchJobs operation returned by the service.
- See Also:
-
searchJobs
default SearchJobsResponse searchJobs(Consumer<SearchJobsRequest.Builder> searchJobsRequest) throws AccessDeniedException, ThrottlingException, InternalServiceException, ValidationException, AwsServiceException, SdkClientException, BraketException Searches for Amazon Braket jobs that match the specified filter values.
This is a convenience which creates an instance of the
SearchJobsRequest.Builder
avoiding the need to create one manually viaSearchJobsRequest.builder()
- Parameters:
searchJobsRequest
- AConsumer
that will call methods onSearchJobsRequest.Builder
to create a request.- Returns:
- Result of the SearchJobs operation returned by the service.
- See Also:
-
searchJobsPaginator
default SearchJobsIterable searchJobsPaginator(SearchJobsRequest searchJobsRequest) throws AccessDeniedException, ThrottlingException, InternalServiceException, ValidationException, AwsServiceException, SdkClientException, BraketException This is a variant of
searchJobs(software.amazon.awssdk.services.braket.model.SearchJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.braket.paginators.SearchJobsIterable responses = client.searchJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.braket.paginators.SearchJobsIterable responses = client.searchJobsPaginator(request); for (software.amazon.awssdk.services.braket.model.SearchJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.braket.paginators.SearchJobsIterable responses = client.searchJobsPaginator(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
searchJobs(software.amazon.awssdk.services.braket.model.SearchJobsRequest)
operation.- Parameters:
searchJobsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchJobsPaginator
default SearchJobsIterable searchJobsPaginator(Consumer<SearchJobsRequest.Builder> searchJobsRequest) throws AccessDeniedException, ThrottlingException, InternalServiceException, ValidationException, AwsServiceException, SdkClientException, BraketException This is a variant of
searchJobs(software.amazon.awssdk.services.braket.model.SearchJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.braket.paginators.SearchJobsIterable responses = client.searchJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.braket.paginators.SearchJobsIterable responses = client.searchJobsPaginator(request); for (software.amazon.awssdk.services.braket.model.SearchJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.braket.paginators.SearchJobsIterable responses = client.searchJobsPaginator(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
searchJobs(software.amazon.awssdk.services.braket.model.SearchJobsRequest)
operation.
This is a convenience which creates an instance of the
SearchJobsRequest.Builder
avoiding the need to create one manually viaSearchJobsRequest.builder()
- Parameters:
searchJobsRequest
- AConsumer
that will call methods onSearchJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchQuantumTasks
default SearchQuantumTasksResponse searchQuantumTasks(SearchQuantumTasksRequest searchQuantumTasksRequest) throws AccessDeniedException, ThrottlingException, InternalServiceException, ValidationException, AwsServiceException, SdkClientException, BraketException Searches for tasks that match the specified filter values.
- Parameters:
searchQuantumTasksRequest
-- Returns:
- Result of the SearchQuantumTasks operation returned by the service.
- See Also:
-
searchQuantumTasks
default SearchQuantumTasksResponse searchQuantumTasks(Consumer<SearchQuantumTasksRequest.Builder> searchQuantumTasksRequest) throws AccessDeniedException, ThrottlingException, InternalServiceException, ValidationException, AwsServiceException, SdkClientException, BraketException Searches for tasks that match the specified filter values.
This is a convenience which creates an instance of the
SearchQuantumTasksRequest.Builder
avoiding the need to create one manually viaSearchQuantumTasksRequest.builder()
- Parameters:
searchQuantumTasksRequest
- AConsumer
that will call methods onSearchQuantumTasksRequest.Builder
to create a request.- Returns:
- Result of the SearchQuantumTasks operation returned by the service.
- See Also:
-
searchQuantumTasksPaginator
default SearchQuantumTasksIterable searchQuantumTasksPaginator(SearchQuantumTasksRequest searchQuantumTasksRequest) throws AccessDeniedException, ThrottlingException, InternalServiceException, ValidationException, AwsServiceException, SdkClientException, BraketException This is a variant of
searchQuantumTasks(software.amazon.awssdk.services.braket.model.SearchQuantumTasksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.braket.paginators.SearchQuantumTasksIterable responses = client.searchQuantumTasksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.braket.paginators.SearchQuantumTasksIterable responses = client .searchQuantumTasksPaginator(request); for (software.amazon.awssdk.services.braket.model.SearchQuantumTasksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.braket.paginators.SearchQuantumTasksIterable responses = client.searchQuantumTasksPaginator(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
searchQuantumTasks(software.amazon.awssdk.services.braket.model.SearchQuantumTasksRequest)
operation.- Parameters:
searchQuantumTasksRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchQuantumTasksPaginator
default SearchQuantumTasksIterable searchQuantumTasksPaginator(Consumer<SearchQuantumTasksRequest.Builder> searchQuantumTasksRequest) throws AccessDeniedException, ThrottlingException, InternalServiceException, ValidationException, AwsServiceException, SdkClientException, BraketException This is a variant of
searchQuantumTasks(software.amazon.awssdk.services.braket.model.SearchQuantumTasksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.braket.paginators.SearchQuantumTasksIterable responses = client.searchQuantumTasksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.braket.paginators.SearchQuantumTasksIterable responses = client .searchQuantumTasksPaginator(request); for (software.amazon.awssdk.services.braket.model.SearchQuantumTasksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.braket.paginators.SearchQuantumTasksIterable responses = client.searchQuantumTasksPaginator(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
searchQuantumTasks(software.amazon.awssdk.services.braket.model.SearchQuantumTasksRequest)
operation.
This is a convenience which creates an instance of the
SearchQuantumTasksRequest.Builder
avoiding the need to create one manually viaSearchQuantumTasksRequest.builder()
- Parameters:
searchQuantumTasksRequest
- AConsumer
that will call methods onSearchQuantumTasksRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException, InternalServiceException, ValidationException, AwsServiceException, SdkClientException, BraketException Add a tag to the specified resource.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ResourceNotFoundException, InternalServiceException, ValidationException, AwsServiceException, SdkClientException, BraketException Add a tag to the specified resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, InternalServiceException, ValidationException, AwsServiceException, SdkClientException, BraketException Remove tags from a resource.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, InternalServiceException, ValidationException, AwsServiceException, SdkClientException, BraketException Remove tags from a resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
create
Create aBraketClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aBraketClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-