Interface SimpleDbV2Client

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

Service client for accessing Amazon SimpleDB v2. This can be created using the static builder() method.

Amazon SimpleDB is a web service providing the core database functions of data indexing and querying in the cloud. By offloading the time and effort associated with building and operating a web-scale database, SimpleDB provides developers the freedom to focus on application development.

  A traditional, clustered relational database requires a sizable upfront capital outlay, is complex to design, and often requires extensive and repetitive database administration. Amazon SimpleDB is dramatically simpler, requiring no schema, automatically indexing your data and providing a simple API for storage and access. This approach eliminates the administrative burden of data modeling, index maintenance, and performance tuning. Developers gain access to this functionality within Amazon's proven computing environment, are able to scale instantly, and pay only for what they use. 
 

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 SimpleDbV2ClientBuilder	builder()	Create a builder that can be used to configure and create a SimpleDbV2Client.
static SimpleDbV2Client	create()	Create a SimpleDbV2Client with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default GetExportResponse	getExport(Consumer<GetExportRequest.Builder> getExportRequest)	Returns information for an existing domain export.
default GetExportResponse	getExport(GetExportRequest getExportRequest)	Returns information for an existing domain export.
default ListExportsResponse	listExports(Consumer<ListExportsRequest.Builder> listExportsRequest)	Lists all exports that were created.
default ListExportsResponse	listExports(ListExportsRequest listExportsRequest)	Lists all exports that were created.
default ListExportsIterable	listExportsPaginator(Consumer<ListExportsRequest.Builder> listExportsRequest)	This is a variant of listExports(software.amazon.awssdk.services.simpledbv2.model.ListExportsRequest) operation.
default ListExportsIterable	listExportsPaginator(ListExportsRequest listExportsRequest)	This is a variant of listExports(software.amazon.awssdk.services.simpledbv2.model.ListExportsRequest) operation.
default SimpleDbV2ServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartDomainExportResponse	startDomainExport(Consumer<StartDomainExportRequest.Builder> startDomainExportRequest)	Initiates the export of a SimpleDB domain to an S3 bucket.
default StartDomainExportResponse	startDomainExport(StartDomainExportRequest startDomainExportRequest)	Initiates the export of a SimpleDB domain to an S3 bucket.
default SimpleDbV2Waiter	waiter()	Create an instance of SimpleDbV2Waiter using this client.

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

getExport

default GetExportResponse getExport(GetExportRequest getExportRequest)
                             throws NoSuchExportException,
InvalidParameterValueException,
AwsServiceException,
SdkClientException,
SimpleDbV2Exception

Returns information for an existing domain export.

Parameters:

getExportRequest -

Returns:

Result of the GetExport operation returned by the service.

getExport

default GetExportResponse getExport(Consumer<GetExportRequest.Builder> getExportRequest)
                             throws NoSuchExportException,
InvalidParameterValueException,
AwsServiceException,
SdkClientException,
SimpleDbV2Exception

Returns information for an existing domain export.

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

Parameters:

getExportRequest - A Consumer that will call methods on GetExportRequest.Builder to create a request.

Returns:

Result of the GetExport operation returned by the service.

listExports

default ListExportsResponse listExports(ListExportsRequest listExportsRequest)
                                 throws InvalidNextTokenException,
InvalidParameterValueException,
NoSuchDomainException,
AwsServiceException,
SdkClientException,
SimpleDbV2Exception

Lists all exports that were created. The results are paginated and can be filtered by domain name.

Parameters:

listExportsRequest -

Returns:

Result of the ListExports operation returned by the service.

listExports

default ListExportsResponse listExports(Consumer<ListExportsRequest.Builder> listExportsRequest)
                                 throws InvalidNextTokenException,
InvalidParameterValueException,
NoSuchDomainException,
AwsServiceException,
SdkClientException,
SimpleDbV2Exception

Lists all exports that were created. The results are paginated and can be filtered by domain name.

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

Parameters:

listExportsRequest - A Consumer that will call methods on ListExportsRequest.Builder to create a request.

Returns:

Result of the ListExports operation returned by the service.

listExportsPaginator

default ListExportsIterable listExportsPaginator(ListExportsRequest listExportsRequest)
                                          throws InvalidNextTokenException,
InvalidParameterValueException,
NoSuchDomainException,
AwsServiceException,
SdkClientException,
SimpleDbV2Exception

This is a variant of listExports(software.amazon.awssdk.services.simpledbv2.model.ListExportsRequest) 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.simpledbv2.paginators.ListExportsIterable responses = client.listExportsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.simpledbv2.paginators.ListExportsIterable responses = client.listExportsPaginator(request);
     for (software.amazon.awssdk.services.simpledbv2.model.ListExportsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.simpledbv2.paginators.ListExportsIterable responses = client.listExportsPaginator(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 listExports(software.amazon.awssdk.services.simpledbv2.model.ListExportsRequest) operation.

Parameters:

listExportsRequest -

Returns:

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

listExportsPaginator

default ListExportsIterable listExportsPaginator(Consumer<ListExportsRequest.Builder> listExportsRequest)
                                          throws InvalidNextTokenException,
InvalidParameterValueException,
NoSuchDomainException,
AwsServiceException,
SdkClientException,
SimpleDbV2Exception

This is a variant of listExports(software.amazon.awssdk.services.simpledbv2.model.ListExportsRequest) 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.simpledbv2.paginators.ListExportsIterable responses = client.listExportsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.simpledbv2.paginators.ListExportsIterable responses = client.listExportsPaginator(request);
     for (software.amazon.awssdk.services.simpledbv2.model.ListExportsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.simpledbv2.paginators.ListExportsIterable responses = client.listExportsPaginator(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 listExports(software.amazon.awssdk.services.simpledbv2.model.ListExportsRequest) operation.

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

Parameters:

listExportsRequest - A Consumer that will call methods on ListExportsRequest.Builder to create a request.

Returns:

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

startDomainExport

default StartDomainExportResponse startDomainExport(StartDomainExportRequest startDomainExportRequest)
                                             throws InvalidParameterCombinationException,
InvalidParameterValueException,
ConflictException,
NumberExportsLimitExceededException,
NoSuchDomainException,
AwsServiceException,
SdkClientException,
SimpleDbV2Exception

Initiates the export of a SimpleDB domain to an S3 bucket.

Parameters:

startDomainExportRequest -

Returns:

Result of the StartDomainExport operation returned by the service.

startDomainExport

default StartDomainExportResponse startDomainExport(Consumer<StartDomainExportRequest.Builder> startDomainExportRequest)
                                             throws InvalidParameterCombinationException,
InvalidParameterValueException,
ConflictException,
NumberExportsLimitExceededException,
NoSuchDomainException,
AwsServiceException,
SdkClientException,
SimpleDbV2Exception

Initiates the export of a SimpleDB domain to an S3 bucket.

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

Parameters:

startDomainExportRequest - A Consumer that will call methods on StartDomainExportRequest.Builder to create a request.

Returns:

Result of the StartDomainExport operation returned by the service.

waiter

default SimpleDbV2Waiter waiter()

Create an instance of SimpleDbV2Waiter using this client.

Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.

Returns:

an instance of SimpleDbV2Waiter

create

static SimpleDbV2Client create()

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

builder

static SimpleDbV2ClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default SimpleDbV2ServiceClientConfiguration 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