Interface CreateBenefitApplicationRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateBenefitApplicationRequest.Builder,CreateBenefitApplicationRequest>, PartnerCentralBenefitsRequest.Builder, SdkBuilder<CreateBenefitApplicationRequest.Builder,CreateBenefitApplicationRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateBenefitApplicationRequest
@Mutable @NotThreadSafe public static interface CreateBenefitApplicationRequest.Builder extends PartnerCentralBenefitsRequest.Builder, SdkPojo, CopyableBuilder<CreateBenefitApplicationRequest.Builder,CreateBenefitApplicationRequest>

  • Method Details

    • catalog

      CreateBenefitApplicationRequest.Builder catalog(String catalog)

      The catalog identifier that specifies which benefit catalog to create the application in.

      Parameters:
      catalog - The catalog identifier that specifies which benefit catalog to create the application in.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      CreateBenefitApplicationRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier to ensure idempotent processing of the creation request.

      Parameters:
      clientToken - A unique, case-sensitive identifier to ensure idempotent processing of the creation request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      CreateBenefitApplicationRequest.Builder name(String name)

      A human-readable name for the benefit application.

      Parameters:
      name - A human-readable name for the benefit application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateBenefitApplicationRequest.Builder description(String description)

      A detailed description of the benefit application and its intended use.

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

    • benefitIdentifier

      CreateBenefitApplicationRequest.Builder benefitIdentifier(String benefitIdentifier)

      The unique identifier of the benefit being requested in this application.

      Parameters:
      benefitIdentifier - The unique identifier of the benefit being requested in this application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fulfillmentTypesWithStrings

      CreateBenefitApplicationRequest.Builder fulfillmentTypesWithStrings(Collection<String> fulfillmentTypes)

      The types of fulfillment requested for this benefit application (e.g., credits, access, disbursement).

      Parameters:
      fulfillmentTypes - The types of fulfillment requested for this benefit application (e.g., credits, access, disbursement).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fulfillmentTypesWithStrings

      CreateBenefitApplicationRequest.Builder fulfillmentTypesWithStrings(String... fulfillmentTypes)

      The types of fulfillment requested for this benefit application (e.g., credits, access, disbursement).

      Parameters:
      fulfillmentTypes - The types of fulfillment requested for this benefit application (e.g., credits, access, disbursement).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fulfillmentTypes

      CreateBenefitApplicationRequest.Builder fulfillmentTypes(Collection<FulfillmentType> fulfillmentTypes)

      The types of fulfillment requested for this benefit application (e.g., credits, access, disbursement).

      Parameters:
      fulfillmentTypes - The types of fulfillment requested for this benefit application (e.g., credits, access, disbursement).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fulfillmentTypes

      CreateBenefitApplicationRequest.Builder fulfillmentTypes(FulfillmentType... fulfillmentTypes)

      The types of fulfillment requested for this benefit application (e.g., credits, access, disbursement).

      Parameters:
      fulfillmentTypes - The types of fulfillment requested for this benefit application (e.g., credits, access, disbursement).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • benefitApplicationDetails

      CreateBenefitApplicationRequest.Builder benefitApplicationDetails(Document benefitApplicationDetails)

      Detailed information and requirements specific to the benefit being requested.

      Parameters:
      benefitApplicationDetails - Detailed information and requirements specific to the benefit being requested.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateBenefitApplicationRequest.Builder tags(Collection<Tag> tags)

      Key-value pairs to categorize and organize the benefit application.

      Parameters:
      tags - Key-value pairs to categorize and organize the benefit application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateBenefitApplicationRequest.Builder tags(Tag... tags)

      Key-value pairs to categorize and organize the benefit application.

      Parameters:
      tags - Key-value pairs to categorize and organize the benefit application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateBenefitApplicationRequest.Builder tags(Consumer<Tag.Builder>... tags)

      Key-value pairs to categorize and organize the benefit application.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

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

    • associatedResources

      CreateBenefitApplicationRequest.Builder associatedResources(Collection<String> associatedResources)

      AWS resources that are associated with this benefit application.

      Parameters:
      associatedResources - AWS resources that are associated with this benefit application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • associatedResources

      CreateBenefitApplicationRequest.Builder associatedResources(String... associatedResources)

      AWS resources that are associated with this benefit application.

      Parameters:
      associatedResources - AWS resources that are associated with this benefit application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • partnerContacts

      CreateBenefitApplicationRequest.Builder partnerContacts(Collection<Contact> partnerContacts)

      Contact information for partner representatives responsible for this benefit application.

      Parameters:
      partnerContacts - Contact information for partner representatives responsible for this benefit application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • partnerContacts

      CreateBenefitApplicationRequest.Builder partnerContacts(Contact... partnerContacts)

      Contact information for partner representatives responsible for this benefit application.

      Parameters:
      partnerContacts - Contact information for partner representatives responsible for this benefit application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • partnerContacts

      CreateBenefitApplicationRequest.Builder partnerContacts(Consumer<Contact.Builder>... partnerContacts)

      Contact information for partner representatives responsible for this benefit application.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to partnerContacts(List<Contact>).

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

    • fileDetails

      CreateBenefitApplicationRequest.Builder fileDetails(Collection<FileInput> fileDetails)

      Supporting documents and files attached to the benefit application.

      Parameters:
      fileDetails - Supporting documents and files attached to the benefit application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fileDetails

      CreateBenefitApplicationRequest.Builder fileDetails(FileInput... fileDetails)

      Supporting documents and files attached to the benefit application.

      Parameters:
      fileDetails - Supporting documents and files attached to the benefit application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fileDetails

      CreateBenefitApplicationRequest.Builder fileDetails(Consumer<FileInput.Builder>... fileDetails)

      Supporting documents and files attached to the benefit application.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to fileDetails(List<FileInput>).

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

    • overrideConfiguration

      CreateBenefitApplicationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateBenefitApplicationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.