Class CreateBenefitApplicationRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.partnercentralbenefits.model.PartnerCentralBenefitsRequest
software.amazon.awssdk.services.partnercentralbenefits.model.CreateBenefitApplicationRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateBenefitApplicationRequest.Builder,CreateBenefitApplicationRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateBenefitApplicationRequest extends PartnerCentralBenefitsRequest implements ToCopyableBuilder<CreateBenefitApplicationRequest.Builder,CreateBenefitApplicationRequest>

  • Method Details

    • catalog

      public final String catalog()

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

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

    • clientToken

      public final String clientToken()

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

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

    • name

      public final String name()

      A human-readable name for the benefit application.

      Returns:
      A human-readable name for the benefit application.

    • description

      public final String description()

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

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

    • benefitIdentifier

      public final String benefitIdentifier()

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

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

    • fulfillmentTypes

      public final List<FulfillmentType> fulfillmentTypes()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFulfillmentTypes() method.

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

    • hasFulfillmentTypes

      public final boolean hasFulfillmentTypes()
      For responses, this returns true if the service returned a value for the FulfillmentTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • fulfillmentTypesAsStrings

      public final List<String> fulfillmentTypesAsStrings()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFulfillmentTypes() method.

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

    • benefitApplicationDetails

      public final Document benefitApplicationDetails()

      Detailed information and requirements specific to the benefit being requested.

      Returns:
      Detailed information and requirements specific to the benefit being requested.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

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

    • hasAssociatedResources

      public final boolean hasAssociatedResources()
      For responses, this returns true if the service returned a value for the AssociatedResources property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • associatedResources

      public final List<String> associatedResources()

      AWS resources that are associated with this benefit application.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAssociatedResources() method.

      Returns:
      AWS resources that are associated with this benefit application.

    • hasPartnerContacts

      public final boolean hasPartnerContacts()
      For responses, this returns true if the service returned a value for the PartnerContacts property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • partnerContacts

      public final List<Contact> partnerContacts()

      Contact information for partner representatives responsible for this benefit application.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPartnerContacts() method.

      Returns:
      Contact information for partner representatives responsible for this benefit application.

    • hasFileDetails

      public final boolean hasFileDetails()
      For responses, this returns true if the service returned a value for the FileDetails property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • fileDetails

      public final List<FileInput> fileDetails()

      Supporting documents and files attached to the benefit application.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFileDetails() method.

      Returns:
      Supporting documents and files attached to the benefit application.

    • toBuilder

      public CreateBenefitApplicationRequest.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<CreateBenefitApplicationRequest.Builder,CreateBenefitApplicationRequest>
      Specified by:
      toBuilder in class PartnerCentralBenefitsRequest
      Returns:
      a builder for type T

    • builder

      public static CreateBenefitApplicationRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateBenefitApplicationRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.