UsageRecord (AWS Java SDK for AWS Marketplace Metering Service 1.12.1 API)

java.lang.Object
- com.amazonaws.services.marketplacemetering.model.UsageRecord

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UsageRecord
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A UsageRecord indicates a quantity of usage for a given product, customer, dimension and time.

Multiple requests with the same UsageRecords as input will be deduplicated to prevent double charges.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

UsageRecord()

Constructors
Constructor and Description
`UsageRecord()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UsageRecord`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCustomerIdentifier()` The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in your application.
`String`	`getDimension()` During the process of registering a product on AWS Marketplace, up to eight dimensions are specified.
`Integer`	`getQuantity()` The quantity of usage consumed by the customer for the given dimension and time.
`Date`	`getTimestamp()` Timestamp, in UTC, for which the usage is being reported.
`List<UsageAllocation>`	`getUsageAllocations()` The set of UsageAllocations to submit.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setCustomerIdentifier(String customerIdentifier)` The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in your application.
`void`	`setDimension(String dimension)` During the process of registering a product on AWS Marketplace, up to eight dimensions are specified.
`void`	`setQuantity(Integer quantity)` The quantity of usage consumed by the customer for the given dimension and time.
`void`	`setTimestamp(Date timestamp)` Timestamp, in UTC, for which the usage is being reported.
`void`	`setUsageAllocations(Collection<UsageAllocation> usageAllocations)` The set of UsageAllocations to submit.
`String`	`toString()` Returns a string representation of this object.
`UsageRecord`	`withCustomerIdentifier(String customerIdentifier)` The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in your application.
`UsageRecord`	`withDimension(String dimension)` During the process of registering a product on AWS Marketplace, up to eight dimensions are specified.
`UsageRecord`	`withQuantity(Integer quantity)` The quantity of usage consumed by the customer for the given dimension and time.
`UsageRecord`	`withTimestamp(Date timestamp)` Timestamp, in UTC, for which the usage is being reported.
`UsageRecord`	`withUsageAllocations(Collection<UsageAllocation> usageAllocations)` The set of UsageAllocations to submit.
`UsageRecord`	`withUsageAllocations(UsageAllocation... usageAllocations)` The set of UsageAllocations to submit.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UsageRecord
```
public UsageRecord()
```
- Method Detail
  - setTimestamp
```
public void setTimestamp(Date timestamp)
```
    Timestamp, in UTC, for which the usage is being reported.
    
    Your application can meter usage for up to one hour in the past. Make sure the timestamp value is not before the start of the software usage.
    
    Parameters:
    
    timestamp - Timestamp, in UTC, for which the usage is being reported.
    
    Your application can meter usage for up to one hour in the past. Make sure the timestamp value is not before the start of the software usage.
  - getTimestamp
```
public Date getTimestamp()
```
    Timestamp, in UTC, for which the usage is being reported.
    
    Your application can meter usage for up to one hour in the past. Make sure the timestamp value is not before the start of the software usage.
    
    Returns:
    
    Timestamp, in UTC, for which the usage is being reported.
    
    Your application can meter usage for up to one hour in the past. Make sure the timestamp value is not before the start of the software usage.
  - withTimestamp
```
public UsageRecord withTimestamp(Date timestamp)
```
    Timestamp, in UTC, for which the usage is being reported.
    
    Your application can meter usage for up to one hour in the past. Make sure the timestamp value is not before the start of the software usage.
    
    Parameters:
    
    timestamp - Timestamp, in UTC, for which the usage is being reported.
    
    Your application can meter usage for up to one hour in the past. Make sure the timestamp value is not before the start of the software usage.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCustomerIdentifier
```
public void setCustomerIdentifier(String customerIdentifier)
```
    The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in your application.
    
    Parameters:
    
    customerIdentifier - The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in your application.
  - getCustomerIdentifier
```
public String getCustomerIdentifier()
```
    The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in your application.
    
    Returns:
    
    The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in your application.
  - withCustomerIdentifier
```
public UsageRecord withCustomerIdentifier(String customerIdentifier)
```
    The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in your application.
    
    Parameters:
    
    customerIdentifier - The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in your application.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDimension
```
public void setDimension(String dimension)
```
    During the process of registering a product on AWS Marketplace, up to eight dimensions are specified. These represent different units of value in your application.
    
    Parameters:
    
    dimension - During the process of registering a product on AWS Marketplace, up to eight dimensions are specified. These represent different units of value in your application.
  - getDimension
```
public String getDimension()
```
    During the process of registering a product on AWS Marketplace, up to eight dimensions are specified. These represent different units of value in your application.
    
    Returns:
    
    During the process of registering a product on AWS Marketplace, up to eight dimensions are specified. These represent different units of value in your application.
  - withDimension
```
public UsageRecord withDimension(String dimension)
```
    During the process of registering a product on AWS Marketplace, up to eight dimensions are specified. These represent different units of value in your application.
    
    Parameters:
    
    dimension - During the process of registering a product on AWS Marketplace, up to eight dimensions are specified. These represent different units of value in your application.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setQuantity
```
public void setQuantity(Integer quantity)
```
    The quantity of usage consumed by the customer for the given dimension and time. Defaults to 0 if not specified.
    
    Parameters:
    
    quantity - The quantity of usage consumed by the customer for the given dimension and time. Defaults to 0 if not specified.
  - getQuantity
```
public Integer getQuantity()
```
    The quantity of usage consumed by the customer for the given dimension and time. Defaults to 0 if not specified.
    
    Returns:
    
    The quantity of usage consumed by the customer for the given dimension and time. Defaults to 0 if not specified.
  - withQuantity
```
public UsageRecord withQuantity(Integer quantity)
```
    The quantity of usage consumed by the customer for the given dimension and time. Defaults to 0 if not specified.
    
    Parameters:
    
    quantity - The quantity of usage consumed by the customer for the given dimension and time. Defaults to 0 if not specified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getUsageAllocations
```
public List<UsageAllocation> getUsageAllocations()
```
    The set of UsageAllocations to submit. The sum of all UsageAllocation quantities must equal the Quantity of the UsageRecord.
    
    Returns:
    
    The set of UsageAllocations to submit. The sum of all UsageAllocation quantities must equal the Quantity of the UsageRecord.
  - setUsageAllocations
```
public void setUsageAllocations(Collection<UsageAllocation> usageAllocations)
```
    The set of UsageAllocations to submit. The sum of all UsageAllocation quantities must equal the Quantity of the UsageRecord.
    
    Parameters:
    
    usageAllocations - The set of UsageAllocations to submit. The sum of all UsageAllocation quantities must equal the Quantity of the UsageRecord.
  - withUsageAllocations
```
public UsageRecord withUsageAllocations(UsageAllocation... usageAllocations)
```
    The set of UsageAllocations to submit. The sum of all UsageAllocation quantities must equal the Quantity of the UsageRecord.
    
    NOTE: This method appends the values to the existing list (if any). Use setUsageAllocations(java.util.Collection) or withUsageAllocations(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    usageAllocations - The set of UsageAllocations to submit. The sum of all UsageAllocation quantities must equal the Quantity of the UsageRecord.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withUsageAllocations
```
public UsageRecord withUsageAllocations(Collection<UsageAllocation> usageAllocations)
```
    The set of UsageAllocations to submit. The sum of all UsageAllocation quantities must equal the Quantity of the UsageRecord.
    
    Parameters:
    
    usageAllocations - The set of UsageAllocations to submit. The sum of all UsageAllocation quantities must equal the Quantity of the UsageRecord.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public UsageRecord clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class UsageRecord

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UsageRecord

Method Detail

setTimestamp

getTimestamp

withTimestamp

setCustomerIdentifier

getCustomerIdentifier

withCustomerIdentifier

setDimension

getDimension

withDimension

setQuantity

getQuantity

withQuantity

getUsageAllocations

setUsageAllocations

withUsageAllocations

withUsageAllocations

toString

equals

hashCode

clone

marshall