software.amazon.awssdk.services.marketplacemetering.model

Class UsageRecord

java.lang.Object

software.amazon.awssdk.services.marketplacemetering.model.UsageRecord

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<UsageRecord.Builder,UsageRecord>

@Generated(value="software.amazon.awssdk:codegen")
public final class UsageRecord
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<UsageRecord.Builder,UsageRecord>

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 de-duplicated to prevent double charges.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UsageRecord.Builder

Method Summary

Modifier and Type	Method and Description
static UsageRecord.Builder	builder()
String	customerIdentifier() The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in your application.
String	dimension() During the process of registering a product on AWS Marketplace, dimensions are specified.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasUsageAllocations() For responses, this returns true if the service returned a value for the UsageAllocations property.
Integer	quantity() The quantity of usage consumed by the customer for the given dimension and time.
List<SdkField<?>>	sdkFields()
static Class<? extends UsageRecord.Builder>	serializableBuilderClass()
Instant	timestamp() Timestamp, in UTC, for which the usage is being reported.
UsageRecord.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<UsageAllocation>	usageAllocations() The set of UsageAllocations to submit.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

timestamp

public final Instant 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:

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.

customerIdentifier

public final String customerIdentifier()

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.

dimension

public final String dimension()

During the process of registering a product on AWS Marketplace, dimensions are specified. These represent different units of value in your application.

Returns:

During the process of registering a product on AWS Marketplace, dimensions are specified. These represent different units of value in your application.

quantity

public final Integer quantity()

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.

hasUsageAllocations

public final boolean hasUsageAllocations()

For responses, this returns true if the service returned a value for the UsageAllocations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

usageAllocations

public final List<UsageAllocation> usageAllocations()

The set of UsageAllocations to submit. The sum of all UsageAllocation quantities must equal the Quantity of the UsageRecord.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUsageAllocations() method.

Returns:

The set of UsageAllocations to submit. The sum of all UsageAllocation quantities must equal the Quantity of the UsageRecord.

toBuilder

public UsageRecord.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UsageRecord.Builder,UsageRecord>

builder

public static UsageRecord.Builder builder()

serializableBuilderClass

public static Class<? extends UsageRecord.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo