software.amazon.awssdk.services.marketplacemetering.model

Class UsageRecordResult

java.lang.Object

software.amazon.awssdk.services.marketplacemetering.model.UsageRecordResult

All Implemented Interfaces:

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

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

A UsageRecordResult indicates the status of a given UsageRecord processed by BatchMeterUsage.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UsageRecordResult.Builder

Method Summary

Modifier and Type	Method and Description
static UsageRecordResult.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	meteringRecordId() The MeteringRecordId is a unique identifier for this metering event.
List<SdkField<?>>	sdkFields()
static Class<? extends UsageRecordResult.Builder>	serializableBuilderClass()
UsageRecordResultStatus	status() The UsageRecordResult Status indicates the status of an individual UsageRecord processed by BatchMeterUsage.
String	statusAsString() The UsageRecordResult Status indicates the status of an individual UsageRecord processed by BatchMeterUsage.
UsageRecordResult.Builder	toBuilder()
String	toString() Returns a string representation of this object.
UsageRecord	usageRecord() The UsageRecord that was part of the BatchMeterUsage request.

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

usageRecord

public final UsageRecord usageRecord()

The UsageRecord that was part of the BatchMeterUsage request.

Returns:

The UsageRecord that was part of the BatchMeterUsage request.

meteringRecordId

public final String meteringRecordId()

The MeteringRecordId is a unique identifier for this metering event.

Returns:

The MeteringRecordId is a unique identifier for this metering event.

status

public final UsageRecordResultStatus status()

The UsageRecordResult Status indicates the status of an individual UsageRecord processed by BatchMeterUsage.

• Success- The UsageRecord was accepted and honored by BatchMeterUsage.

• CustomerNotSubscribed- The CustomerIdentifier specified is not able to use your product. The UsageRecord was not honored. There are three causes for this result:

  • The customer identifier is invalid.

  • The customer identifier provided in the metering record does not have an active agreement or subscription with this product. Future UsageRecords for this customer will fail until the customer subscribes to your product.

  • The customer's AWS account was suspended.

• DuplicateRecord- Indicates that the UsageRecord was invalid and not honored. A previously metered UsageRecord had the same customer, dimension, and time, but a different quantity.

If the service returns an enum value that is not available in the current SDK version, status will return UsageRecordResultStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The UsageRecordResult Status indicates the status of an individual UsageRecord processed by BatchMeterUsage.

• Success- The UsageRecord was accepted and honored by BatchMeterUsage.

• CustomerNotSubscribed- The CustomerIdentifier specified is not able to use your product. The UsageRecord was not honored. There are three causes for this result:

  • The customer identifier is invalid.

  • The customer identifier provided in the metering record does not have an active agreement or subscription with this product. Future UsageRecords for this customer will fail until the customer subscribes to your product.

  • The customer's AWS account was suspended.

• DuplicateRecord- Indicates that the UsageRecord was invalid and not honored. A previously metered UsageRecord had the same customer, dimension, and time, but a different quantity.

See Also:

UsageRecordResultStatus

statusAsString

public final String statusAsString()

The UsageRecordResult Status indicates the status of an individual UsageRecord processed by BatchMeterUsage.

• Success- The UsageRecord was accepted and honored by BatchMeterUsage.

• CustomerNotSubscribed- The CustomerIdentifier specified is not able to use your product. The UsageRecord was not honored. There are three causes for this result:

  • The customer identifier is invalid.

  • The customer identifier provided in the metering record does not have an active agreement or subscription with this product. Future UsageRecords for this customer will fail until the customer subscribes to your product.

  • The customer's AWS account was suspended.

• DuplicateRecord- Indicates that the UsageRecord was invalid and not honored. A previously metered UsageRecord had the same customer, dimension, and time, but a different quantity.

If the service returns an enum value that is not available in the current SDK version, status will return UsageRecordResultStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The UsageRecordResult Status indicates the status of an individual UsageRecord processed by BatchMeterUsage.

• Success- The UsageRecord was accepted and honored by BatchMeterUsage.

• CustomerNotSubscribed- The CustomerIdentifier specified is not able to use your product. The UsageRecord was not honored. There are three causes for this result:

  • The customer identifier is invalid.

  • The customer identifier provided in the metering record does not have an active agreement or subscription with this product. Future UsageRecords for this customer will fail until the customer subscribes to your product.

  • The customer's AWS account was suspended.

• DuplicateRecord- Indicates that the UsageRecord was invalid and not honored. A previously metered UsageRecord had the same customer, dimension, and time, but a different quantity.

See Also:

UsageRecordResultStatus

toBuilder

public UsageRecordResult.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UsageRecordResult.Builder,UsageRecordResult>

builder

public static UsageRecordResult.Builder builder()

serializableBuilderClass

public static Class<? extends UsageRecordResult.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