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

Interface Entitlement.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Entitlement.Builder,Entitlement>, SdkBuilder<Entitlement.Builder,Entitlement>, SdkPojo

Enclosing class:

Entitlement

public static interface Entitlement.Builder
extends SdkPojo, CopyableBuilder<Entitlement.Builder,Entitlement>

Method Summary

Modifier and Type	Method	Description
Entitlement.Builder	customerIdentifier(String customerIdentifier)	The customer identifier is a handle to each unique customer in an application.
Entitlement.Builder	dimension(String dimension)	The dimension for which the given entitlement applies.
Entitlement.Builder	expirationDate(Instant expirationDate)	The expiration date represents the minimum date through which this entitlement is expected to remain valid.
Entitlement.Builder	productCode(String productCode)	The product code for which the given entitlement applies.
default Entitlement.Builder	value(Consumer<EntitlementValue.Builder> value)	The EntitlementValue represents the amount of capacity that the customer is entitled to for the product.
Entitlement.Builder	value(EntitlementValue value)	The EntitlementValue represents the amount of capacity that the customer is entitled to for the product.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

productCode

Entitlement.Builder productCode(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.

dimension

Entitlement.Builder dimension(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.

customerIdentifier

Entitlement.Builder customerIdentifier(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.

value

Entitlement.Builder value(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.

value

default Entitlement.Builder value(Consumer<EntitlementValue.Builder> value)

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

This is a convenience method that creates an instance of the EntitlementValue.Builder avoiding the need to create one manually via EntitlementValue.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to value(EntitlementValue).

Parameters:

value - a consumer that will call methods on EntitlementValue.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

value(EntitlementValue)

expirationDate

Entitlement.Builder expirationDate(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.

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.