Class BenefitAllocationSummary

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

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

See Also:

  • Method Details

    • id

      public final String id()

      The unique identifier of the benefit allocation.

      Returns:
      The unique identifier of the benefit allocation.

    • catalog

      public final String catalog()

      The catalog identifier that the benefit allocation belongs to.

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

    • arn

      public final String arn()

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

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

    • status

      public final BenefitAllocationStatus status()

      The current status of the benefit allocation.

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

      Returns:
      The current status of the benefit allocation.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the benefit allocation.

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

      Returns:
      The current status of the benefit allocation.
      See Also:

    • statusReason

      public final String statusReason()

      Additional information explaining the current status of the benefit allocation.

      Returns:
      Additional information explaining the current status of the benefit allocation.

    • name

      public final String name()

      The human-readable name of the benefit allocation.

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

    • benefitId

      public final String benefitId()

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

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

    • benefitApplicationId

      public final String benefitApplicationId()

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

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

    • fulfillmentTypes

      public final List<FulfillmentType> fulfillmentTypes()

      The fulfillment types used for this benefit allocation.

      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 used for this benefit allocation.

    • 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 used for this benefit allocation.

      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 used for this benefit allocation.

    • createdAt

      public final Instant createdAt()

      The timestamp when the benefit allocation was created.

      Returns:
      The timestamp when the benefit allocation was created.

    • expiresAt

      public final Instant expiresAt()

      The timestamp when the benefit allocation expires.

      Returns:
      The timestamp when the benefit allocation expires.

    • hasApplicableBenefitIds

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

    • applicableBenefitIds

      public final List<String> applicableBenefitIds()

      The identifiers of the benefits applicable for this allocation.

      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 hasApplicableBenefitIds() method.

      Returns:
      The identifiers of the benefits applicable for this allocation.

    • toBuilder

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

    • builder

      public static BenefitAllocationSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends BenefitAllocationSummary.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.