Interface BackupSearchClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface BackupSearchClient
extends AwsClient

Service client for accessing AWS Backup Search. This can be created using the static builder() method.

Backup Search

Backup Search is the recovery point and item level search for Backup.

For additional information, see:

• Backup API Reference

• Backup Developer Guide

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static BackupSearchClientBuilder	builder()	Create a builder that can be used to configure and create a BackupSearchClient.
static BackupSearchClient	create()	Create a BackupSearchClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default GetSearchJobResponse	getSearchJob(Consumer<GetSearchJobRequest.Builder> getSearchJobRequest)	This operation retrieves metadata of a search job, including its progress.
default GetSearchJobResponse	getSearchJob(GetSearchJobRequest getSearchJobRequest)	This operation retrieves metadata of a search job, including its progress.
default GetSearchResultExportJobResponse	getSearchResultExportJob(Consumer<GetSearchResultExportJobRequest.Builder> getSearchResultExportJobRequest)	This operation retrieves the metadata of an export job.
default GetSearchResultExportJobResponse	getSearchResultExportJob(GetSearchResultExportJobRequest getSearchResultExportJobRequest)	This operation retrieves the metadata of an export job.
default ListSearchJobBackupsResponse	listSearchJobBackups(Consumer<ListSearchJobBackupsRequest.Builder> listSearchJobBackupsRequest)	This operation returns a list of all backups (recovery points) in a paginated format that were included in the search job.
default ListSearchJobBackupsResponse	listSearchJobBackups(ListSearchJobBackupsRequest listSearchJobBackupsRequest)	This operation returns a list of all backups (recovery points) in a paginated format that were included in the search job.
default ListSearchJobBackupsIterable	listSearchJobBackupsPaginator(Consumer<ListSearchJobBackupsRequest.Builder> listSearchJobBackupsRequest)	This is a variant of listSearchJobBackups(software.amazon.awssdk.services.backupsearch.model.ListSearchJobBackupsRequest) operation.
default ListSearchJobBackupsIterable	listSearchJobBackupsPaginator(ListSearchJobBackupsRequest listSearchJobBackupsRequest)	This is a variant of listSearchJobBackups(software.amazon.awssdk.services.backupsearch.model.ListSearchJobBackupsRequest) operation.
default ListSearchJobResultsResponse	listSearchJobResults(Consumer<ListSearchJobResultsRequest.Builder> listSearchJobResultsRequest)	This operation returns a list of a specified search job.
default ListSearchJobResultsResponse	listSearchJobResults(ListSearchJobResultsRequest listSearchJobResultsRequest)	This operation returns a list of a specified search job.
default ListSearchJobResultsIterable	listSearchJobResultsPaginator(Consumer<ListSearchJobResultsRequest.Builder> listSearchJobResultsRequest)	This is a variant of listSearchJobResults(software.amazon.awssdk.services.backupsearch.model.ListSearchJobResultsRequest) operation.
default ListSearchJobResultsIterable	listSearchJobResultsPaginator(ListSearchJobResultsRequest listSearchJobResultsRequest)	This is a variant of listSearchJobResults(software.amazon.awssdk.services.backupsearch.model.ListSearchJobResultsRequest) operation.
default ListSearchJobsResponse	listSearchJobs(Consumer<ListSearchJobsRequest.Builder> listSearchJobsRequest)	This operation returns a list of search jobs belonging to an account.
default ListSearchJobsResponse	listSearchJobs(ListSearchJobsRequest listSearchJobsRequest)	This operation returns a list of search jobs belonging to an account.
default ListSearchJobsIterable	listSearchJobsPaginator(Consumer<ListSearchJobsRequest.Builder> listSearchJobsRequest)	This is a variant of listSearchJobs(software.amazon.awssdk.services.backupsearch.model.ListSearchJobsRequest) operation.
default ListSearchJobsIterable	listSearchJobsPaginator(ListSearchJobsRequest listSearchJobsRequest)	This is a variant of listSearchJobs(software.amazon.awssdk.services.backupsearch.model.ListSearchJobsRequest) operation.
default ListSearchResultExportJobsResponse	listSearchResultExportJobs(Consumer<ListSearchResultExportJobsRequest.Builder> listSearchResultExportJobsRequest)	This operation exports search results of a search job to a specified destination S3 bucket.
default ListSearchResultExportJobsResponse	listSearchResultExportJobs(ListSearchResultExportJobsRequest listSearchResultExportJobsRequest)	This operation exports search results of a search job to a specified destination S3 bucket.
default ListSearchResultExportJobsIterable	listSearchResultExportJobsPaginator(Consumer<ListSearchResultExportJobsRequest.Builder> listSearchResultExportJobsRequest)	This is a variant of listSearchResultExportJobs(software.amazon.awssdk.services.backupsearch.model.ListSearchResultExportJobsRequest) operation.
default ListSearchResultExportJobsIterable	listSearchResultExportJobsPaginator(ListSearchResultExportJobsRequest listSearchResultExportJobsRequest)	This is a variant of listSearchResultExportJobs(software.amazon.awssdk.services.backupsearch.model.ListSearchResultExportJobsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	This operation returns the tags for a resource type.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	This operation returns the tags for a resource type.
default BackupSearchServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartSearchJobResponse	startSearchJob(Consumer<StartSearchJobRequest.Builder> startSearchJobRequest)	This operation creates a search job which returns recovery points filtered by SearchScope and items filtered by ItemFilters.
default StartSearchJobResponse	startSearchJob(StartSearchJobRequest startSearchJobRequest)	This operation creates a search job which returns recovery points filtered by SearchScope and items filtered by ItemFilters.
default StartSearchResultExportJobResponse	startSearchResultExportJob(Consumer<StartSearchResultExportJobRequest.Builder> startSearchResultExportJobRequest)	This operations starts a job to export the results of search job to a designated S3 bucket.
default StartSearchResultExportJobResponse	startSearchResultExportJob(StartSearchResultExportJobRequest startSearchResultExportJobRequest)	This operations starts a job to export the results of search job to a designated S3 bucket.
default StopSearchJobResponse	stopSearchJob(Consumer<StopSearchJobRequest.Builder> stopSearchJobRequest)	This operations ends a search job.
default StopSearchJobResponse	stopSearchJob(StopSearchJobRequest stopSearchJobRequest)	This operations ends a search job.
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	This operation puts tags on the resource you indicate.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	This operation puts tags on the resource you indicate.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	This operation removes tags from the specified resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	This operation removes tags from the specified 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

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 the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

getSearchJob

default GetSearchJobResponse getSearchJob(GetSearchJobRequest getSearchJobRequest)
                                   throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
BackupSearchException

This operation retrieves metadata of a search job, including its progress.

Parameters:

getSearchJobRequest -

Returns:

Result of the GetSearchJob operation returned by the service.

See Also:

• AWS API Documentation

getSearchJob

default GetSearchJobResponse getSearchJob(Consumer<GetSearchJobRequest.Builder> getSearchJobRequest)
                                   throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
BackupSearchException

This operation retrieves metadata of a search job, including its progress.

This is a convenience which creates an instance of the GetSearchJobRequest.Builder avoiding the need to create one manually via GetSearchJobRequest.builder()

Parameters:

getSearchJobRequest - A Consumer that will call methods on GetSearchJobRequest.Builder to create a request.

Returns:

Result of the GetSearchJob operation returned by the service.

See Also:

• AWS API Documentation

getSearchResultExportJob

default GetSearchResultExportJobResponse getSearchResultExportJob(GetSearchResultExportJobRequest getSearchResultExportJobRequest)
                                                           throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
BackupSearchException

This operation retrieves the metadata of an export job.

An export job is an operation that transmits the results of a search job to a specified S3 bucket in a .csv file.

An export job allows you to retain results of a search beyond the search job's scheduled retention of 7 days.

Parameters:

getSearchResultExportJobRequest -

Returns:

Result of the GetSearchResultExportJob operation returned by the service.

See Also:

• AWS API Documentation

getSearchResultExportJob

default GetSearchResultExportJobResponse getSearchResultExportJob(Consumer<GetSearchResultExportJobRequest.Builder> getSearchResultExportJobRequest)
                                                           throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
BackupSearchException

This operation retrieves the metadata of an export job.

An export job is an operation that transmits the results of a search job to a specified S3 bucket in a .csv file.

An export job allows you to retain results of a search beyond the search job's scheduled retention of 7 days.

This is a convenience which creates an instance of the GetSearchResultExportJobRequest.Builder avoiding the need to create one manually via GetSearchResultExportJobRequest.builder()

Parameters:

getSearchResultExportJobRequest - A Consumer that will call methods on GetSearchResultExportJobRequest.Builder to create a request.

Returns:

Result of the GetSearchResultExportJob operation returned by the service.

See Also:

• AWS API Documentation

listSearchJobBackups

default ListSearchJobBackupsResponse listSearchJobBackups(ListSearchJobBackupsRequest listSearchJobBackupsRequest)
                                                   throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
BackupSearchException

This operation returns a list of all backups (recovery points) in a paginated format that were included in the search job.

If a search does not display an expected backup in the results, you can call this operation to display each backup included in the search. Any backups that were not included because they have a FAILED status from a permissions issue will be displayed, along with a status message.

Only recovery points with a backup index that has a status of ACTIVE will be included in search results. If the index has any other status, its status will be displayed along with a status message.

Parameters:

listSearchJobBackupsRequest -

Returns:

Result of the ListSearchJobBackups operation returned by the service.

See Also:

• AWS API Documentation

listSearchJobBackups

default ListSearchJobBackupsResponse listSearchJobBackups(Consumer<ListSearchJobBackupsRequest.Builder> listSearchJobBackupsRequest)
                                                   throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
BackupSearchException

This operation returns a list of all backups (recovery points) in a paginated format that were included in the search job.

If a search does not display an expected backup in the results, you can call this operation to display each backup included in the search. Any backups that were not included because they have a FAILED status from a permissions issue will be displayed, along with a status message.

Only recovery points with a backup index that has a status of ACTIVE will be included in search results. If the index has any other status, its status will be displayed along with a status message.

This is a convenience which creates an instance of the ListSearchJobBackupsRequest.Builder avoiding the need to create one manually via ListSearchJobBackupsRequest.builder()

Parameters:

listSearchJobBackupsRequest - A Consumer that will call methods on ListSearchJobBackupsRequest.Builder to create a request.

Returns:

Result of the ListSearchJobBackups operation returned by the service.

See Also:

• AWS API Documentation

listSearchJobBackupsPaginator

default ListSearchJobBackupsIterable listSearchJobBackupsPaginator(ListSearchJobBackupsRequest listSearchJobBackupsRequest)
                                                            throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
BackupSearchException

This is a variant of listSearchJobBackups(software.amazon.awssdk.services.backupsearch.model.ListSearchJobBackupsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.backupsearch.paginators.ListSearchJobBackupsIterable responses = client.listSearchJobBackupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.backupsearch.paginators.ListSearchJobBackupsIterable responses = client
             .listSearchJobBackupsPaginator(request);
     for (software.amazon.awssdk.services.backupsearch.model.ListSearchJobBackupsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.backupsearch.paginators.ListSearchJobBackupsIterable responses = client.listSearchJobBackupsPaginator(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 listSearchJobBackups(software.amazon.awssdk.services.backupsearch.model.ListSearchJobBackupsRequest) operation.

Parameters:

listSearchJobBackupsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSearchJobBackupsPaginator

default ListSearchJobBackupsIterable listSearchJobBackupsPaginator(Consumer<ListSearchJobBackupsRequest.Builder> listSearchJobBackupsRequest)
                                                            throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
BackupSearchException

This is a variant of listSearchJobBackups(software.amazon.awssdk.services.backupsearch.model.ListSearchJobBackupsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.backupsearch.paginators.ListSearchJobBackupsIterable responses = client.listSearchJobBackupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.backupsearch.paginators.ListSearchJobBackupsIterable responses = client
             .listSearchJobBackupsPaginator(request);
     for (software.amazon.awssdk.services.backupsearch.model.ListSearchJobBackupsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.backupsearch.paginators.ListSearchJobBackupsIterable responses = client.listSearchJobBackupsPaginator(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 listSearchJobBackups(software.amazon.awssdk.services.backupsearch.model.ListSearchJobBackupsRequest) operation.

This is a convenience which creates an instance of the ListSearchJobBackupsRequest.Builder avoiding the need to create one manually via ListSearchJobBackupsRequest.builder()

Parameters:

listSearchJobBackupsRequest - A Consumer that will call methods on ListSearchJobBackupsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSearchJobResults

default ListSearchJobResultsResponse listSearchJobResults(ListSearchJobResultsRequest listSearchJobResultsRequest)
                                                   throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
BackupSearchException

This operation returns a list of a specified search job.

Parameters:

listSearchJobResultsRequest -

Returns:

Result of the ListSearchJobResults operation returned by the service.

See Also:

• AWS API Documentation

listSearchJobResults

default ListSearchJobResultsResponse listSearchJobResults(Consumer<ListSearchJobResultsRequest.Builder> listSearchJobResultsRequest)
                                                   throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
BackupSearchException

This operation returns a list of a specified search job.

This is a convenience which creates an instance of the ListSearchJobResultsRequest.Builder avoiding the need to create one manually via ListSearchJobResultsRequest.builder()

Parameters:

listSearchJobResultsRequest - A Consumer that will call methods on ListSearchJobResultsRequest.Builder to create a request.

Returns:

Result of the ListSearchJobResults operation returned by the service.

See Also:

• AWS API Documentation

listSearchJobResultsPaginator

default ListSearchJobResultsIterable listSearchJobResultsPaginator(ListSearchJobResultsRequest listSearchJobResultsRequest)
                                                            throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
BackupSearchException

This is a variant of listSearchJobResults(software.amazon.awssdk.services.backupsearch.model.ListSearchJobResultsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.backupsearch.paginators.ListSearchJobResultsIterable responses = client.listSearchJobResultsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.backupsearch.paginators.ListSearchJobResultsIterable responses = client
             .listSearchJobResultsPaginator(request);
     for (software.amazon.awssdk.services.backupsearch.model.ListSearchJobResultsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.backupsearch.paginators.ListSearchJobResultsIterable responses = client.listSearchJobResultsPaginator(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 listSearchJobResults(software.amazon.awssdk.services.backupsearch.model.ListSearchJobResultsRequest) operation.

Parameters:

listSearchJobResultsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSearchJobResultsPaginator

default ListSearchJobResultsIterable listSearchJobResultsPaginator(Consumer<ListSearchJobResultsRequest.Builder> listSearchJobResultsRequest)
                                                            throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
BackupSearchException

This is a variant of listSearchJobResults(software.amazon.awssdk.services.backupsearch.model.ListSearchJobResultsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.backupsearch.paginators.ListSearchJobResultsIterable responses = client.listSearchJobResultsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.backupsearch.paginators.ListSearchJobResultsIterable responses = client
             .listSearchJobResultsPaginator(request);
     for (software.amazon.awssdk.services.backupsearch.model.ListSearchJobResultsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.backupsearch.paginators.ListSearchJobResultsIterable responses = client.listSearchJobResultsPaginator(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 listSearchJobResults(software.amazon.awssdk.services.backupsearch.model.ListSearchJobResultsRequest) operation.

This is a convenience which creates an instance of the ListSearchJobResultsRequest.Builder avoiding the need to create one manually via ListSearchJobResultsRequest.builder()

Parameters:

listSearchJobResultsRequest - A Consumer that will call methods on ListSearchJobResultsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSearchJobs

default ListSearchJobsResponse listSearchJobs(ListSearchJobsRequest listSearchJobsRequest)
                                       throws ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
BackupSearchException

This operation returns a list of search jobs belonging to an account.

Parameters:

listSearchJobsRequest -

Returns:

Result of the ListSearchJobs operation returned by the service.

See Also:

• AWS API Documentation

listSearchJobs

default ListSearchJobsResponse listSearchJobs(Consumer<ListSearchJobsRequest.Builder> listSearchJobsRequest)
                                       throws ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
BackupSearchException

This operation returns a list of search jobs belonging to an account.

This is a convenience which creates an instance of the ListSearchJobsRequest.Builder avoiding the need to create one manually via ListSearchJobsRequest.builder()

Parameters:

listSearchJobsRequest - A Consumer that will call methods on ListSearchJobsRequest.Builder to create a request.

Returns:

Result of the ListSearchJobs operation returned by the service.

See Also:

• AWS API Documentation

listSearchJobsPaginator

default ListSearchJobsIterable listSearchJobsPaginator(ListSearchJobsRequest listSearchJobsRequest)
                                                throws ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
BackupSearchException

This is a variant of listSearchJobs(software.amazon.awssdk.services.backupsearch.model.ListSearchJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.backupsearch.paginators.ListSearchJobsIterable responses = client.listSearchJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.backupsearch.paginators.ListSearchJobsIterable responses = client
             .listSearchJobsPaginator(request);
     for (software.amazon.awssdk.services.backupsearch.model.ListSearchJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.backupsearch.paginators.ListSearchJobsIterable responses = client.listSearchJobsPaginator(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 listSearchJobs(software.amazon.awssdk.services.backupsearch.model.ListSearchJobsRequest) operation.

Parameters:

listSearchJobsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSearchJobsPaginator

default ListSearchJobsIterable listSearchJobsPaginator(Consumer<ListSearchJobsRequest.Builder> listSearchJobsRequest)
                                                throws ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
BackupSearchException

This is a variant of listSearchJobs(software.amazon.awssdk.services.backupsearch.model.ListSearchJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.backupsearch.paginators.ListSearchJobsIterable responses = client.listSearchJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.backupsearch.paginators.ListSearchJobsIterable responses = client
             .listSearchJobsPaginator(request);
     for (software.amazon.awssdk.services.backupsearch.model.ListSearchJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.backupsearch.paginators.ListSearchJobsIterable responses = client.listSearchJobsPaginator(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 listSearchJobs(software.amazon.awssdk.services.backupsearch.model.ListSearchJobsRequest) operation.

This is a convenience which creates an instance of the ListSearchJobsRequest.Builder avoiding the need to create one manually via ListSearchJobsRequest.builder()

Parameters:

listSearchJobsRequest - A Consumer that will call methods on ListSearchJobsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSearchResultExportJobs

default ListSearchResultExportJobsResponse listSearchResultExportJobs(ListSearchResultExportJobsRequest listSearchResultExportJobsRequest)
                                                               throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BackupSearchException

This operation exports search results of a search job to a specified destination S3 bucket.

Parameters:

listSearchResultExportJobsRequest -

Returns:

Result of the ListSearchResultExportJobs operation returned by the service.

See Also:

• AWS API Documentation

listSearchResultExportJobs

default ListSearchResultExportJobsResponse listSearchResultExportJobs(Consumer<ListSearchResultExportJobsRequest.Builder> listSearchResultExportJobsRequest)
                                                               throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BackupSearchException

This operation exports search results of a search job to a specified destination S3 bucket.

This is a convenience which creates an instance of the ListSearchResultExportJobsRequest.Builder avoiding the need to create one manually via ListSearchResultExportJobsRequest.builder()

Parameters:

listSearchResultExportJobsRequest - A Consumer that will call methods on ListSearchResultExportJobsRequest.Builder to create a request.

Returns:

Result of the ListSearchResultExportJobs operation returned by the service.

See Also:

• AWS API Documentation

listSearchResultExportJobsPaginator

default ListSearchResultExportJobsIterable listSearchResultExportJobsPaginator(ListSearchResultExportJobsRequest listSearchResultExportJobsRequest)
                                                                        throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BackupSearchException

This is a variant of listSearchResultExportJobs(software.amazon.awssdk.services.backupsearch.model.ListSearchResultExportJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.backupsearch.paginators.ListSearchResultExportJobsIterable responses = client.listSearchResultExportJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.backupsearch.paginators.ListSearchResultExportJobsIterable responses = client
             .listSearchResultExportJobsPaginator(request);
     for (software.amazon.awssdk.services.backupsearch.model.ListSearchResultExportJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.backupsearch.paginators.ListSearchResultExportJobsIterable responses = client.listSearchResultExportJobsPaginator(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 listSearchResultExportJobs(software.amazon.awssdk.services.backupsearch.model.ListSearchResultExportJobsRequest) operation.

Parameters:

listSearchResultExportJobsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSearchResultExportJobsPaginator

default ListSearchResultExportJobsIterable listSearchResultExportJobsPaginator(Consumer<ListSearchResultExportJobsRequest.Builder> listSearchResultExportJobsRequest)
                                                                        throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BackupSearchException

This is a variant of listSearchResultExportJobs(software.amazon.awssdk.services.backupsearch.model.ListSearchResultExportJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.backupsearch.paginators.ListSearchResultExportJobsIterable responses = client.listSearchResultExportJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.backupsearch.paginators.ListSearchResultExportJobsIterable responses = client
             .listSearchResultExportJobsPaginator(request);
     for (software.amazon.awssdk.services.backupsearch.model.ListSearchResultExportJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.backupsearch.paginators.ListSearchResultExportJobsIterable responses = client.listSearchResultExportJobsPaginator(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 listSearchResultExportJobs(software.amazon.awssdk.services.backupsearch.model.ListSearchResultExportJobsRequest) operation.

This is a convenience which creates an instance of the ListSearchResultExportJobsRequest.Builder avoiding the need to create one manually via ListSearchResultExportJobsRequest.builder()

Parameters:

listSearchResultExportJobsRequest - A Consumer that will call methods on ListSearchResultExportJobsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
BackupSearchException

This operation returns the tags for a resource type.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
BackupSearchException

This operation returns the tags for a resource type.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

startSearchJob

default StartSearchJobResponse startSearchJob(StartSearchJobRequest startSearchJobRequest)
                                       throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
ServiceQuotaExceededException,
ConflictException,
AwsServiceException,
SdkClientException,
BackupSearchException

This operation creates a search job which returns recovery points filtered by SearchScope and items filtered by ItemFilters.

You can optionally include ClientToken, EncryptionKeyArn, Name, and/or Tags.

Parameters:

startSearchJobRequest -

Returns:

Result of the StartSearchJob operation returned by the service.

See Also:

• AWS API Documentation

startSearchJob

default StartSearchJobResponse startSearchJob(Consumer<StartSearchJobRequest.Builder> startSearchJobRequest)
                                       throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
ServiceQuotaExceededException,
ConflictException,
AwsServiceException,
SdkClientException,
BackupSearchException

This operation creates a search job which returns recovery points filtered by SearchScope and items filtered by ItemFilters.

You can optionally include ClientToken, EncryptionKeyArn, Name, and/or Tags.

This is a convenience which creates an instance of the StartSearchJobRequest.Builder avoiding the need to create one manually via StartSearchJobRequest.builder()

Parameters:

startSearchJobRequest - A Consumer that will call methods on StartSearchJobRequest.Builder to create a request.

Returns:

Result of the StartSearchJob operation returned by the service.

See Also:

• AWS API Documentation

startSearchResultExportJob

default StartSearchResultExportJobResponse startSearchResultExportJob(StartSearchResultExportJobRequest startSearchResultExportJobRequest)
                                                               throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
ServiceQuotaExceededException,
ConflictException,
AwsServiceException,
SdkClientException,
BackupSearchException

This operations starts a job to export the results of search job to a designated S3 bucket.

Parameters:

startSearchResultExportJobRequest -

Returns:

Result of the StartSearchResultExportJob operation returned by the service.

See Also:

• AWS API Documentation

startSearchResultExportJob

default StartSearchResultExportJobResponse startSearchResultExportJob(Consumer<StartSearchResultExportJobRequest.Builder> startSearchResultExportJobRequest)
                                                               throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
ServiceQuotaExceededException,
ConflictException,
AwsServiceException,
SdkClientException,
BackupSearchException

This operations starts a job to export the results of search job to a designated S3 bucket.

This is a convenience which creates an instance of the StartSearchResultExportJobRequest.Builder avoiding the need to create one manually via StartSearchResultExportJobRequest.builder()

Parameters:

startSearchResultExportJobRequest - A Consumer that will call methods on StartSearchResultExportJobRequest.Builder to create a request.

Returns:

Result of the StartSearchResultExportJob operation returned by the service.

See Also:

• AWS API Documentation

stopSearchJob

default StopSearchJobResponse stopSearchJob(StopSearchJobRequest stopSearchJobRequest)
                                     throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
BackupSearchException

This operations ends a search job.

Only a search job with a status of RUNNING can be stopped.

Parameters:

stopSearchJobRequest -

Returns:

Result of the StopSearchJob operation returned by the service.

See Also:

• AWS API Documentation

stopSearchJob

default StopSearchJobResponse stopSearchJob(Consumer<StopSearchJobRequest.Builder> stopSearchJobRequest)
                                     throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
BackupSearchException

This operations ends a search job.

Only a search job with a status of RUNNING can be stopped.

This is a convenience which creates an instance of the StopSearchJobRequest.Builder avoiding the need to create one manually via StopSearchJobRequest.builder()

Parameters:

stopSearchJobRequest - A Consumer that will call methods on StopSearchJobRequest.Builder to create a request.

Returns:

Result of the StopSearchJob operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
BackupSearchException

This operation puts tags on the resource you indicate.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
BackupSearchException

This operation puts tags on the resource you indicate.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
BackupSearchException

This operation removes tags from the specified resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
BackupSearchException

This operation removes tags from the specified resource.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

create

static BackupSearchClient create()

Create a BackupSearchClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static BackupSearchClientBuilder builder()

Create a builder that can be used to configure and create a BackupSearchClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default BackupSearchServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration