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:

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Entitlement.Builder,Entitlement>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.