Interface GetBenefitAllocationResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<GetBenefitAllocationResponse.Builder,GetBenefitAllocationResponse>, PartnerCentralBenefitsResponse.Builder, SdkBuilder<GetBenefitAllocationResponse.Builder,GetBenefitAllocationResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
GetBenefitAllocationResponse
@Mutable @NotThreadSafe public static interface GetBenefitAllocationResponse.Builder extends PartnerCentralBenefitsResponse.Builder, SdkPojo, CopyableBuilder<GetBenefitAllocationResponse.Builder,GetBenefitAllocationResponse>

  • Method Details

    • id

      GetBenefitAllocationResponse.Builder id(String id)

      The unique identifier of the benefit allocation.

      Parameters:
      id - The unique identifier of the benefit allocation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • catalog

      GetBenefitAllocationResponse.Builder catalog(String catalog)

      The catalog identifier that the benefit allocation belongs to.

      Parameters:
      catalog - The catalog identifier that the benefit allocation belongs to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • arn

      GetBenefitAllocationResponse.Builder arn(String arn)

      The Amazon Resource Name (ARN) of the benefit allocation.

      Parameters:
      arn - The Amazon Resource Name (ARN) of the benefit allocation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      GetBenefitAllocationResponse.Builder name(String name)

      The human-readable name of the benefit allocation.

      Parameters:
      name - The human-readable name of the benefit allocation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      GetBenefitAllocationResponse.Builder description(String description)

      A detailed description of the benefit allocation.

      Parameters:
      description - A detailed description of the benefit allocation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      GetBenefitAllocationResponse.Builder status(String status)

      The current status of the benefit allocation (e.g., active, expired, consumed).

      Parameters:
      status - The current status of the benefit allocation (e.g., active, expired, consumed).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      GetBenefitAllocationResponse.Builder status(BenefitAllocationStatus status)

      The current status of the benefit allocation (e.g., active, expired, consumed).

      Parameters:
      status - The current status of the benefit allocation (e.g., active, expired, consumed).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statusReason

      GetBenefitAllocationResponse.Builder statusReason(String statusReason)

      Additional information explaining the current status of the benefit allocation.

      Parameters:
      statusReason - Additional information explaining the current status of the benefit allocation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • benefitApplicationId

      GetBenefitAllocationResponse.Builder benefitApplicationId(String benefitApplicationId)

      The identifier of the benefit application that resulted in this allocation.

      Parameters:
      benefitApplicationId - The identifier of the benefit application that resulted in this allocation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • benefitId

      GetBenefitAllocationResponse.Builder benefitId(String benefitId)

      The identifier of the benefit that this allocation is based on.

      Parameters:
      benefitId - The identifier of the benefit that this allocation is based on.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fulfillmentType

      GetBenefitAllocationResponse.Builder fulfillmentType(String fulfillmentType)

      The fulfillment type used for this benefit allocation.

      Parameters:
      fulfillmentType - The fulfillment type used for this benefit allocation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • fulfillmentType

      GetBenefitAllocationResponse.Builder fulfillmentType(FulfillmentType fulfillmentType)

      The fulfillment type used for this benefit allocation.

      Parameters:
      fulfillmentType - The fulfillment type used for this benefit allocation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • applicableBenefitIds

      GetBenefitAllocationResponse.Builder applicableBenefitIds(Collection<String> applicableBenefitIds)

      A list of benefit identifiers that this allocation can be applied to.

      Parameters:
      applicableBenefitIds - A list of benefit identifiers that this allocation can be applied to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • applicableBenefitIds

      GetBenefitAllocationResponse.Builder applicableBenefitIds(String... applicableBenefitIds)

      A list of benefit identifiers that this allocation can be applied to.

      Parameters:
      applicableBenefitIds - A list of benefit identifiers that this allocation can be applied to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fulfillmentDetail

      GetBenefitAllocationResponse.Builder fulfillmentDetail(FulfillmentDetails fulfillmentDetail)

      Detailed information about how the benefit allocation is fulfilled.

      Parameters:
      fulfillmentDetail - Detailed information about how the benefit allocation is fulfilled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fulfillmentDetail

      default GetBenefitAllocationResponse.Builder fulfillmentDetail(Consumer<FulfillmentDetails.Builder> fulfillmentDetail)

      Detailed information about how the benefit allocation is fulfilled.

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

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

      Parameters:
      fulfillmentDetail - a consumer that will call methods on FulfillmentDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • createdAt

      GetBenefitAllocationResponse.Builder createdAt(Instant createdAt)

      The timestamp when the benefit allocation was created.

      Parameters:
      createdAt - The timestamp when the benefit allocation was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedAt

      GetBenefitAllocationResponse.Builder updatedAt(Instant updatedAt)

      The timestamp when the benefit allocation was last updated.

      Parameters:
      updatedAt - The timestamp when the benefit allocation was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startsAt

      GetBenefitAllocationResponse.Builder startsAt(Instant startsAt)

      The timestamp when the benefit allocation becomes active and usable.

      Parameters:
      startsAt - The timestamp when the benefit allocation becomes active and usable.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • expiresAt

      GetBenefitAllocationResponse.Builder expiresAt(Instant expiresAt)

      The timestamp when the benefit allocation expires and is no longer usable.

      Parameters:
      expiresAt - The timestamp when the benefit allocation expires and is no longer usable.
      Returns:
      Returns a reference to this object so that method calls can be chained together.