LeaseSerializer (Amazon Kinesis Client Library for Java 1.15.0 API)

java.lang.Object
- com.amazonaws.services.kinesis.leases.impl.LeaseSerializer

All Implemented Interfaces:

ILeaseSerializer<Lease>
```
public class LeaseSerializer
extends Object
implements ILeaseSerializer<Lease>
```
An implementation of ILeaseSerializer for basic Lease objects. Can also instantiate subclasses of Lease so that LeaseSerializer can be decorated by other classes if you need to add fields to leases.

Field Summary

Fields
Modifier and Type Field and Description

Class<? extends Lease> clazz

String LEASE_COUNTER_KEY

String LEASE_KEY_KEY

String LEASE_OWNER_KEY

Fields
Modifier and Type	Field and Description
`Class<? extends Lease>`	`clazz`
`String`	`LEASE_COUNTER_KEY`
`String`	`LEASE_KEY_KEY`
`String`	`LEASE_OWNER_KEY`

Constructor Summary

Constructors
Constructor and Description

LeaseSerializer()

LeaseSerializer(Class<? extends Lease> clazz)

Constructors
Constructor and Description
`LeaseSerializer()`
`LeaseSerializer(Class<? extends Lease> clazz)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Lease`	`fromDynamoRecord(Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValue> dynamoRecord)` Construct a Lease object out of a DynamoDB record.
`Collection<com.amazonaws.services.dynamodbv2.model.AttributeDefinition>`	`getAttributeDefinitions()`
`Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate>`	`getDynamoEvictLeaseUpdate(Lease lease)`
`Map<String,com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue>`	`getDynamoExistentExpectation(String leaseKey)`
`Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValue>`	`getDynamoHashKey(Lease lease)`
`Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValue>`	`getDynamoHashKey(String leaseKey)` Special getDynamoHashKey implementation used by ILeaseManager.getLease().
`Map<String,com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue>`	`getDynamoLeaseCheckpointExpectation(Lease lease)`
`Map<String,com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue>`	`getDynamoLeaseCounterExpectation(Lease lease)`
`Map<String,com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue>`	`getDynamoLeaseCounterExpectation(Long leaseCounter)`
`Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate>`	`getDynamoLeaseCounterUpdate(Lease lease)`
`Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate>`	`getDynamoLeaseCounterUpdate(Long leaseCounter)`
`Map<String,com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue>`	`getDynamoLeaseOwnerExpectation(Lease lease)`
`Map<String,com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue>`	`getDynamoNonexistantExpectation()`
`Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate>`	`getDynamoTakeLeaseUpdate(Lease lease, String owner)`
`Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate>`	`getDynamoUpdateLeaseUpdate(Lease lease)`
`Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate>`	`getDynamoUpdateLeaseUpdate(Lease lease, UpdateField updateField)`
`Collection<com.amazonaws.services.dynamodbv2.model.KeySchemaElement>`	`getKeySchema()`
`Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValue>`	`toDynamoRecord(Lease lease)` Construct a DynamoDB record out of a Lease object

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LEASE_KEY_KEY
```
public final String LEASE_KEY_KEY
```
    See Also:
    
    Constant Field Values
  - LEASE_OWNER_KEY
```
public final String LEASE_OWNER_KEY
```
    See Also:
    
    Constant Field Values
  - LEASE_COUNTER_KEY
```
public final String LEASE_COUNTER_KEY
```
    See Also:
    
    Constant Field Values
  - clazz
```
public final Class<? extends Lease> clazz
```
- Constructor Detail
  - LeaseSerializer
```
public LeaseSerializer()
```
  - LeaseSerializer
```
public LeaseSerializer(Class<? extends Lease> clazz)
```
- Method Detail
  - toDynamoRecord
```
public Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValue> toDynamoRecord(Lease lease)
```
    Description copied from interface: ILeaseSerializer
    
    Construct a DynamoDB record out of a Lease object
    
    Specified by:
    
    toDynamoRecord in interface ILeaseSerializer<Lease>
    
    Parameters:
    
    lease - lease object to serialize
    
    Returns:
    
    an attribute value map representing the lease object
  - fromDynamoRecord
```
public Lease fromDynamoRecord(Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValue> dynamoRecord)
```
    Description copied from interface: ILeaseSerializer
    
    Construct a Lease object out of a DynamoDB record.
    
    Specified by:
    
    fromDynamoRecord in interface ILeaseSerializer<Lease>
    
    Parameters:
    
    dynamoRecord - attribute value map from DynamoDB
    
    Returns:
    
    a deserialized lease object representing the attribute value map
  - getDynamoHashKey
```
public Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValue> getDynamoHashKey(String leaseKey)
```
    Description copied from interface: ILeaseSerializer
    
    Special getDynamoHashKey implementation used by ILeaseManager.getLease().
    
    Specified by:
    
    getDynamoHashKey in interface ILeaseSerializer<Lease>
    
    Returns:
    
    the attribute value map representing a Lease's hash key given a string.
  - getDynamoHashKey
```
public Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValue> getDynamoHashKey(Lease lease)
```
    Specified by:
    
    getDynamoHashKey in interface ILeaseSerializer<Lease>
    
    Returns:
    
    the attribute value map representing a Lease's hash key given a Lease object.
  - getDynamoLeaseCounterExpectation
```
public Map<String,com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue> getDynamoLeaseCounterExpectation(Lease lease)
```
    Specified by:
    
    getDynamoLeaseCounterExpectation in interface ILeaseSerializer<Lease>
    
    Returns:
    
    the attribute value map asserting that a lease counter is what we expect.
  - getDynamoLeaseCounterExpectation
```
public Map<String,com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue> getDynamoLeaseCounterExpectation(Long leaseCounter)
```
  - getDynamoLeaseOwnerExpectation
```
public Map<String,com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue> getDynamoLeaseOwnerExpectation(Lease lease)
```
    Specified by:
    
    getDynamoLeaseOwnerExpectation in interface ILeaseSerializer<Lease>
    
    Returns:
    
    the attribute value map asserting that the lease owner is what we expect.
  - getDynamoLeaseCheckpointExpectation
```
public Map<String,com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue> getDynamoLeaseCheckpointExpectation(Lease lease)
```
    Specified by:
    
    getDynamoLeaseCheckpointExpectation in interface ILeaseSerializer<Lease>
    
    Returns:
    
    the attribute value map asserting that the checkpoint state is as expected.
  - getDynamoNonexistantExpectation
```
public Map<String,com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue> getDynamoNonexistantExpectation()
```
    Specified by:
    
    getDynamoNonexistantExpectation in interface ILeaseSerializer<Lease>
    
    Returns:
    
    the attribute value map asserting that a lease does not exist.
  - getDynamoExistentExpectation
```
public Map<String,com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue> getDynamoExistentExpectation(String leaseKey)
```
    Specified by:
    
    getDynamoExistentExpectation in interface ILeaseSerializer<Lease>
    
    Returns:
    
    the attribute value map asserting that a lease does exist.
  - getDynamoLeaseCounterUpdate
```
public Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate> getDynamoLeaseCounterUpdate(Lease lease)
```
    Specified by:
    
    getDynamoLeaseCounterUpdate in interface ILeaseSerializer<Lease>
    
    Returns:
    
    the attribute value map that increments a lease counter
  - getDynamoLeaseCounterUpdate
```
public Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate> getDynamoLeaseCounterUpdate(Long leaseCounter)
```
  - getDynamoTakeLeaseUpdate
```
public Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate> getDynamoTakeLeaseUpdate(Lease lease,
                                                                                                         String owner)
```
    Specified by:
    
    getDynamoTakeLeaseUpdate in interface ILeaseSerializer<Lease>
    
    Returns:
    
    the attribute value map that takes a lease for a new owner
  - getDynamoEvictLeaseUpdate
```
public Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate> getDynamoEvictLeaseUpdate(Lease lease)
```
    Specified by:
    
    getDynamoEvictLeaseUpdate in interface ILeaseSerializer<Lease>
    
    Returns:
    
    the attribute value map that voids a lease
  - getDynamoUpdateLeaseUpdate
```
public Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate> getDynamoUpdateLeaseUpdate(Lease lease)
```
    Specified by:
    
    getDynamoUpdateLeaseUpdate in interface ILeaseSerializer<Lease>
    
    Returns:
    
    the attribute value map that updates application-specific data for a lease and increments the lease counter
  - getDynamoUpdateLeaseUpdate
```
public Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate> getDynamoUpdateLeaseUpdate(Lease lease,
                                                                                                           UpdateField updateField)
```
    Specified by:
    
    getDynamoUpdateLeaseUpdate in interface ILeaseSerializer<Lease>
    
    Returns:
    
    the attribute value map that updates application-specific data for a lease
  - getKeySchema
```
public Collection<com.amazonaws.services.dynamodbv2.model.KeySchemaElement> getKeySchema()
```
    Specified by:
    
    getKeySchema in interface ILeaseSerializer<Lease>
    
    Returns:
    
    the key schema for creating a DynamoDB table to store leases
  - getAttributeDefinitions
```
public Collection<com.amazonaws.services.dynamodbv2.model.AttributeDefinition> getAttributeDefinitions()
```
    Specified by:
    
    getAttributeDefinitions in interface ILeaseSerializer<Lease>
    
    Returns:
    
    attribute definitions for creating a DynamoDB table to store leases

Class LeaseSerializer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LEASE_KEY_KEY

LEASE_OWNER_KEY

LEASE_COUNTER_KEY

clazz

Constructor Detail

LeaseSerializer

LeaseSerializer

Method Detail

toDynamoRecord

fromDynamoRecord

getDynamoHashKey

getDynamoHashKey

getDynamoLeaseCounterExpectation

getDynamoLeaseCounterExpectation

getDynamoLeaseOwnerExpectation

getDynamoLeaseCheckpointExpectation

getDynamoNonexistantExpectation

getDynamoExistentExpectation

getDynamoLeaseCounterUpdate

getDynamoLeaseCounterUpdate

getDynamoTakeLeaseUpdate

getDynamoEvictLeaseUpdate

getDynamoUpdateLeaseUpdate

getDynamoUpdateLeaseUpdate

getKeySchema

getAttributeDefinitions