Class AbstractAmazonSimpleDB
- All Implemented Interfaces:
AmazonSimpleDB
- Direct Known Subclasses:
AbstractAmazonSimpleDBAsync
AmazonSimpleDB
. Convenient method forms
pass through to the corresponding overload that takes a request object, which
throws an UnsupportedOperationException
.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionPerforms multiple DeleteAttributes operations in a single call, which reduces round trips and latencies.TheBatchPutAttributes
operation creates or replaces attributes within one or more items.createDomain
(CreateDomainRequest request) TheCreateDomain
operation creates a new domain.deleteAttributes
(DeleteAttributesRequest request) Deletes one or more attributes associated with an item.deleteDomain
(DeleteDomainRequest request) TheDeleteDomain
operation deletes a domain.domainMetadata
(DomainMetadataRequest request) Returns information about the domain, including when the domain was created, the number of items and attributes in the domain, and the size of the attribute names and values.getAttributes
(GetAttributesRequest request) Returns all of the attributes associated with the specified item.Simplified method form for invoking the ListDomains operation.listDomains
(ListDomainsRequest request) TheListDomains
operation lists all domains associated with the Access Key ID.putAttributes
(PutAttributesRequest request) The PutAttributes operation creates or replaces attributes in an item.select
(SelectRequest request) TheSelect
operation returns a set of attributes forItemNames
that match the select expression.void
setEndpoint
(String endpoint) Overrides the default endpoint for this client ("sdb.amazonaws.com").void
An alternative toAmazonSimpleDB.setEndpoint(String)
, sets the regional endpoint for this client's service calls.
-
Constructor Details
-
AbstractAmazonSimpleDB
protected AbstractAmazonSimpleDB()
-
-
Method Details
-
setEndpoint
Description copied from interface:AmazonSimpleDB
Overrides the default endpoint for this client ("sdb.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.Callers can pass in just the endpoint (ex: "sdb.amazonaws.com") or a full URL, including the protocol (ex: "sdb.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's
ClientConfiguration
will be used, which by default is HTTPS.For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Specified by:
setEndpoint
in interfaceAmazonSimpleDB
- Parameters:
endpoint
- The endpoint (ex: "sdb.amazonaws.com") or a full URL, including the protocol (ex: "sdb.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
-
setRegion
Description copied from interface:AmazonSimpleDB
An alternative toAmazonSimpleDB.setEndpoint(String)
, sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Specified by:
setRegion
in interfaceAmazonSimpleDB
- Parameters:
region
- The region this client will communicate with. SeeRegion.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.- See Also:
-
batchDeleteAttributes
Description copied from interface:AmazonSimpleDB
Performs multiple DeleteAttributes operations in a single call, which reduces round trips and latencies. This enables Amazon SimpleDB to optimize requests, which generally yields better throughput.
The following limitations are enforced for this operation:
- 1 MB request size
- 25 item limit per BatchDeleteAttributes operation
- Specified by:
batchDeleteAttributes
in interfaceAmazonSimpleDB
- Parameters:
request
-- Returns:
- Result of the BatchDeleteAttributes operation returned by the service.
-
batchPutAttributes
Description copied from interface:AmazonSimpleDB
The
BatchPutAttributes
operation creates or replaces attributes within one or more items. By using this operation, the client can perform multiple PutAttribute operation with a single call. This helps yield savings in round trips and latencies, enabling Amazon SimpleDB to optimize requests and generally produce better throughput.The client may specify the item name with the
Item.X.ItemName
parameter. The client may specify new attributes using a combination of theItem.X.Attribute.Y.Name
andItem.X.Attribute.Y.Value
parameters. The client may specify the first attribute for the first item using the parametersItem.0.Attribute.0.Name
andItem.0.Attribute.0.Value
, and for the second attribute for the first item by the parametersItem.0.Attribute.1.Name
andItem.0.Attribute.1.Value
, and so on.Attributes are uniquely identified within an item by their name/value combination. For example, a single item can have the attributes
{ "first_name", "first_value" }
and{ "first_name", "second_value" }
. However, it cannot have two attribute instances where both theItem.X.Attribute.Y.Name
andItem.X.Attribute.Y.Value
are the same.Optionally, the requester can supply the
Replace
parameter for each individual value. Setting this value totrue
will cause the new attribute values to replace the existing attribute values. For example, if an itemI
has the attributes{ 'a', '1' }, { 'b', '2'}
and{ 'b', '3' }
and the requester does a BatchPutAttributes of{'I', 'b', '4' }
with the Replace parameter set to true, the final attributes of the item will be{ 'a', '1' }
and{ 'b', '4' }
, replacing the previous values of the 'b' attribute with the new value.This operation is vulnerable to exceeding the maximum URL size when making a REST request using the HTTP GET method. This operation does not support conditions using Expected.X.Name
,Expected.X.Value
, orExpected.X.Exists
.You can execute multiple
BatchPutAttributes
operations and other operations in parallel. However, large numbers of concurrentBatchPutAttributes
calls can result in Service Unavailable (503) responses.The following limitations are enforced for this operation:
- 256 attribute name-value pairs per item
- 1 MB request size
- 1 billion attributes per domain
- 10 GB of total user data storage per domain
- 25 item limit per
BatchPutAttributes
operation
- Specified by:
batchPutAttributes
in interfaceAmazonSimpleDB
- Parameters:
request
-- Returns:
- Result of the BatchPutAttributes operation returned by the service.
-
createDomain
Description copied from interface:AmazonSimpleDB
The
CreateDomain
operation creates a new domain. The domain name should be unique among the domains associated with the Access Key ID provided in the request. TheCreateDomain
operation may take 10 or more seconds to complete.The client can create up to 100 domains per account.
If the client requires additional domains, go to http://aws.amazon.com/contact-us/simpledb-limit-request/.
- Specified by:
createDomain
in interfaceAmazonSimpleDB
- Parameters:
request
-- Returns:
- Result of the CreateDomain operation returned by the service.
-
deleteAttributes
Description copied from interface:AmazonSimpleDB
Deletes one or more attributes associated with an item. If all attributes of the item are deleted, the item is deleted.
DeleteAttributes
is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response.Because Amazon SimpleDB makes multiple copies of item data and uses an eventual consistency update model, performing a GetAttributes or Select operation (read) immediately after a
DeleteAttributes
or PutAttributes operation (write) might not return updated item data.- Specified by:
deleteAttributes
in interfaceAmazonSimpleDB
- Parameters:
request
-- Returns:
- Result of the DeleteAttributes operation returned by the service.
-
deleteDomain
Description copied from interface:AmazonSimpleDB
The
DeleteDomain
operation deletes a domain. Any items (and their attributes) in the domain are deleted as well. TheDeleteDomain
operation might take 10 or more seconds to complete.- Specified by:
deleteDomain
in interfaceAmazonSimpleDB
- Parameters:
request
-- Returns:
- Result of the DeleteDomain operation returned by the service.
-
domainMetadata
Description copied from interface:AmazonSimpleDB
Returns information about the domain, including when the domain was created, the number of items and attributes in the domain, and the size of the attribute names and values.
- Specified by:
domainMetadata
in interfaceAmazonSimpleDB
- Parameters:
request
-- Returns:
- Result of the DomainMetadata operation returned by the service.
-
getAttributes
Description copied from interface:AmazonSimpleDB
Returns all of the attributes associated with the specified item. Optionally, the attributes returned can be limited to one or more attributes by specifying an attribute name parameter.
If the item does not exist on the replica that was accessed for this operation, an empty set is returned. The system does not return an error as it cannot guarantee the item does not exist on other replicas.
- Specified by:
getAttributes
in interfaceAmazonSimpleDB
- Parameters:
request
-- Returns:
- Result of the GetAttributes operation returned by the service.
-
listDomains
Description copied from interface:AmazonSimpleDB
The
ListDomains
operation lists all domains associated with the Access Key ID. It returns domain names up to the limit set by MaxNumberOfDomains. A NextToken is returned if there are more thanMaxNumberOfDomains
domains. CallingListDomains
successive times with theNextToken
provided by the operation returns up toMaxNumberOfDomains
more domain names with each successive operation call.- Specified by:
listDomains
in interfaceAmazonSimpleDB
- Parameters:
request
-- Returns:
- Result of the ListDomains operation returned by the service.
-
listDomains
Description copied from interface:AmazonSimpleDB
Simplified method form for invoking the ListDomains operation.- Specified by:
listDomains
in interfaceAmazonSimpleDB
- See Also:
-
putAttributes
Description copied from interface:AmazonSimpleDB
The PutAttributes operation creates or replaces attributes in an item. The client may specify new attributes using a combination of the
Attribute.X.Name
andAttribute.X.Value
parameters. The client specifies the first attribute by the parametersAttribute.0.Name
andAttribute.0.Value
, the second attribute by the parametersAttribute.1.Name
andAttribute.1.Value
, and so on.Attributes are uniquely identified in an item by their name/value combination. For example, a single item can have the attributes
{ "first_name", "first_value" }
and{ "first_name", second_value" }
. However, it cannot have two attribute instances where both theAttribute.X.Name
andAttribute.X.Value
are the same.Optionally, the requestor can supply the
Replace
parameter for each individual attribute. Setting this value totrue
causes the new attribute value to replace the existing attribute value(s). For example, if an item has the attributes{ 'a', '1' }
,{ 'b', '2'}
and{ 'b', '3' }
and the requestor callsPutAttributes
using the attributes{ 'b', '4' }
with theReplace
parameter set to true, the final attributes of the item are changed to{ 'a', '1' }
and{ 'b', '4' }
, which replaces the previous values of the 'b' attribute with the new value.You cannot specify an empty string as an attribute name.
Because Amazon SimpleDB makes multiple copies of client data and uses an eventual consistency update model, an immediate GetAttributes or Select operation (read) immediately after a PutAttributes or DeleteAttributes operation (write) might not return the updated data.
The following limitations are enforced for this operation:
- 256 total attribute name-value pairs per item
- One billion attributes per domain
- 10 GB of total user data storage per domain
- Specified by:
putAttributes
in interfaceAmazonSimpleDB
- Parameters:
request
-- Returns:
- Result of the PutAttributes operation returned by the service.
-
select
Description copied from interface:AmazonSimpleDB
The
Select
operation returns a set of attributes forItemNames
that match the select expression.Select
is similar to the standard SQL SELECT statement.The total size of the response cannot exceed 1 MB in total size. Amazon SimpleDB automatically adjusts the number of items returned per page to enforce this limit. For example, if the client asks to retrieve 2500 items, but each individual item is 10 kB in size, the system returns 100 items and an appropriate
NextToken
so the client can access the next page of results.For information on how to construct select expressions, see Using Select to Create Amazon SimpleDB Queries in the Developer Guide.
- Specified by:
select
in interfaceAmazonSimpleDB
- Parameters:
request
-- Returns:
- Result of the Select operation returned by the service.
-