Package software.amazon.awssdk.services.marketplaceentitlement.model

Class Entitlement

java.lang.Object

software.amazon.awssdk.services.marketplaceentitlement.model.Entitlement

All Implemented Interfaces:

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

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

An entitlement represents capacity in a product owned by the customer. For example, a customer might own some number of users or seats in an SaaS application or some amount of data capacity in a multi-tenant database.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Entitlement.Builder

Method Summary

Modifier and Type	Method	Description
static Entitlement.Builder	builder()
String	customerIdentifier()	The customer identifier is a handle to each unique customer in an application.
String	dimension()	The dimension for which the given entitlement applies.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Instant	expirationDate()	The expiration date represents the minimum date through which this entitlement is expected to remain valid.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	productCode()	The product code for which the given entitlement applies.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Entitlement.Builder>	serializableBuilderClass()
Entitlement.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
EntitlementValue	value()	The EntitlementValue represents the amount of capacity that the customer is entitled to for the product.

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

productCode

public final String productCode()

The product code for which the given entitlement applies. Product codes are provided by AWS Marketplace when the product listing is created.

Returns:

The product code for which the given entitlement applies. Product codes are provided by AWS Marketplace when the product listing is created.

dimension

public final String dimension()

The dimension for which the given entitlement applies. Dimensions represent categories of capacity in a product and are specified when the product is listed in AWS Marketplace.

Returns:

The dimension for which the given entitlement applies. Dimensions represent categories of capacity in a product and are specified when the product is listed in AWS Marketplace.

customerIdentifier

public final String customerIdentifier()

The customer identifier is a handle to each unique customer in an application. Customer identifiers are obtained through the ResolveCustomer operation in AWS Marketplace Metering Service.

Returns:

The customer identifier is a handle to each unique customer in an application. Customer identifiers are obtained through the ResolveCustomer operation in AWS Marketplace Metering Service.

value

public final EntitlementValue value()

The EntitlementValue represents the amount of capacity that the customer is entitled to for the product.

Returns:

The EntitlementValue represents the amount of capacity that the customer is entitled to for the product.

expirationDate

public final Instant expirationDate()

The expiration date represents the minimum date through which this entitlement is expected to remain valid. For contractual products listed on AWS Marketplace, the expiration date is the date at which the customer will renew or cancel their contract. Customers who are opting to renew their contract will still have entitlements with an expiration date.

Returns:

The expiration date represents the minimum date through which this entitlement is expected to remain valid. For contractual products listed on AWS Marketplace, the expiration date is the date at which the customer will renew or cancel their contract. Customers who are opting to renew their contract will still have entitlements with an expiration date.

toBuilder

public Entitlement.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Entitlement.Builder,Entitlement>

builder

public static Entitlement.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo