Class BenefitApplicationSummary

java.lang.Object
software.amazon.awssdk.services.partnercentralbenefits.model.BenefitApplicationSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<BenefitApplicationSummary.Builder,BenefitApplicationSummary>
@Generated("software.amazon.awssdk:codegen") public final class BenefitApplicationSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<BenefitApplicationSummary.Builder,BenefitApplicationSummary>

A summary view of a benefit application containing key information for list operations.

See Also:

  • Method Details

    • catalog

      public final String catalog()

      The catalog identifier that the benefit application belongs to.

      Returns:
      The catalog identifier that the benefit application belongs to.

    • name

      public final String name()

      The human-readable name of the benefit application.

      Returns:
      The human-readable name of the benefit application.

    • id

      public final String id()

      The unique identifier of the benefit application.

      Returns:
      The unique identifier of the benefit application.

    • arn

      public final String arn()

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

      Returns:
      The Amazon Resource Name (ARN) of the benefit application.

    • benefitId

      public final String benefitId()

      The identifier of the benefit being requested in this application.

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

    • hasPrograms

      public final boolean hasPrograms()
      For responses, this returns true if the service returned a value for the Programs 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.

    • programs

      public final List<String> programs()

      The AWS partner programs 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 hasPrograms() method.

      Returns:
      The AWS partner programs associated with this benefit application.

    • fulfillmentTypes

      public final List<FulfillmentType> fulfillmentTypes()

      The fulfillment types requested 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 hasFulfillmentTypes() method.

      Returns:
      The fulfillment types requested for this benefit application.

    • 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 fulfillment types requested 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 hasFulfillmentTypes() method.

      Returns:
      The fulfillment types requested for this benefit application.

    • status

      public final BenefitApplicationStatus status()

      The current processing status of the benefit application.

      If the service returns an enum value that is not available in the current SDK version, status will return BenefitApplicationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current processing status of the benefit application.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current processing status of the benefit application.

      If the service returns an enum value that is not available in the current SDK version, status will return BenefitApplicationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current processing status of the benefit application.
      See Also:

    • stage

      public final String stage()

      The current stage in the benefit application processing workflow..

      Returns:
      The current stage in the benefit application processing workflow..

    • createdAt

      public final Instant createdAt()

      The timestamp when the benefit application was created.

      Returns:
      The timestamp when the benefit application was created.

    • updatedAt

      public final Instant updatedAt()

      The timestamp when the benefit application was last updated.

      Returns:
      The timestamp when the benefit application was last updated.

    • hasBenefitApplicationDetails

      public final boolean hasBenefitApplicationDetails()
      For responses, this returns true if the service returned a value for the BenefitApplicationDetails 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.

    • benefitApplicationDetails

      public final Map<String,String> benefitApplicationDetails()

      Additional attributes and metadata associated with 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 hasBenefitApplicationDetails() method.

      Returns:
      Additional attributes and metadata associated with 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.

    • toBuilder

      public BenefitApplicationSummary.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<BenefitApplicationSummary.Builder,BenefitApplicationSummary>
      Returns:
      a builder for type T

    • builder

      public static BenefitApplicationSummary.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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