Entitlement (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.marketplaceentitlement.model.Entitlement

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Entitlement
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Entitlement()

Constructors
Constructor and Description
`Entitlement()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Entitlement`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCustomerIdentifier()` The customer identifier is a handle to each unique customer in an application.
`String`	`getDimension()` The dimension for which the given entitlement applies.
`Date`	`getExpirationDate()` The expiration date represents the minimum date through which this entitlement is expected to remain valid.
`String`	`getProductCode()` The product code for which the given entitlement applies.
`EntitlementValue`	`getValue()` The EntitlementValue represents the amount of capacity that the customer is entitled to for the product.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCustomerIdentifier(String customerIdentifier)` The customer identifier is a handle to each unique customer in an application.
`void`	`setDimension(String dimension)` The dimension for which the given entitlement applies.
`void`	`setExpirationDate(Date expirationDate)` The expiration date represents the minimum date through which this entitlement is expected to remain valid.
`void`	`setProductCode(String productCode)` The product code for which the given entitlement applies.
`void`	`setValue(EntitlementValue value)` The EntitlementValue represents the amount of capacity that the customer is entitled to for the product.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Entitlement`	`withCustomerIdentifier(String customerIdentifier)` The customer identifier is a handle to each unique customer in an application.
`Entitlement`	`withDimension(String dimension)` The dimension for which the given entitlement applies.
`Entitlement`	`withExpirationDate(Date expirationDate)` The expiration date represents the minimum date through which this entitlement is expected to remain valid.
`Entitlement`	`withProductCode(String productCode)` The product code for which the given entitlement applies.
`Entitlement`	`withValue(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
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Entitlement
```
public Entitlement()
```
- Method Detail
  - setProductCode
```
public void setProductCode(String productCode)
```
    The product code for which the given entitlement applies. Product codes are provided by AWS Marketplace when the product listing is created.
    
    Parameters:
    
    productCode - The product code for which the given entitlement applies. Product codes are provided by AWS Marketplace when the product listing is created.
  - getProductCode
```
public String getProductCode()
```
    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.
  - withProductCode
```
public Entitlement withProductCode(String productCode)
```
    The product code for which the given entitlement applies. Product codes are provided by AWS Marketplace when the product listing is created.
    
    Parameters:
    
    productCode - The product code for which the given entitlement applies. Product codes are provided by AWS Marketplace when the product listing is created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDimension
```
public void setDimension(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.
    
    Parameters:
    
    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.
  - getDimension
```
public String getDimension()
```
    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.
  - withDimension
```
public Entitlement withDimension(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCustomerIdentifier
```
public void setCustomerIdentifier(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.
    
    Parameters:
    
    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.
  - getCustomerIdentifier
```
public String getCustomerIdentifier()
```
    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.
  - withCustomerIdentifier
```
public Entitlement withCustomerIdentifier(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setValue
```
public void setValue(EntitlementValue value)
```
    The EntitlementValue represents the amount of capacity that the customer is entitled to for the product.
    
    Parameters:
    
    value - The EntitlementValue represents the amount of capacity that the customer is entitled to for the product.
  - getValue
```
public EntitlementValue getValue()
```
    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.
  - withValue
```
public Entitlement withValue(EntitlementValue value)
```
    The EntitlementValue represents the amount of capacity that the customer is entitled to for the product.
    
    Parameters:
    
    value - The EntitlementValue represents the amount of capacity that the customer is entitled to for the product.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExpirationDate
```
public void setExpirationDate(Date 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.
    
    Parameters:
    
    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.
  - getExpirationDate
```
public Date getExpirationDate()
```
    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.
  - withExpirationDate
```
public Entitlement withExpirationDate(Date 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.
    
    Parameters:
    
    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:
    
    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; useful for testing and debugging.
    
    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 Entitlement clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Entitlement

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Entitlement

Method Detail

setProductCode

getProductCode

withProductCode

setDimension

getDimension

withDimension

setCustomerIdentifier

getCustomerIdentifier

withCustomerIdentifier

setValue

getValue

withValue

setExpirationDate

getExpirationDate

withExpirationDate

toString

equals

hashCode

clone

marshall