Class ListBenefitAllocationsRequest

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.ListBenefitAllocationsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListBenefitAllocationsRequest.Builder,ListBenefitAllocationsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListBenefitAllocationsRequest extends PartnerCentralBenefitsRequest implements ToCopyableBuilder<ListBenefitAllocationsRequest.Builder,ListBenefitAllocationsRequest>

  • Method Details

    • catalog

      public final String catalog()

      The catalog identifier to filter benefit allocations by catalog.

      Returns:
      The catalog identifier to filter benefit allocations by catalog.

    • fulfillmentTypes

      public final List<FulfillmentType> fulfillmentTypes()

      Filter benefit allocations by specific fulfillment types.

      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:
      Filter benefit allocations by specific fulfillment types.

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

      Filter benefit allocations by specific fulfillment types.

      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:
      Filter benefit allocations by specific fulfillment types.

    • hasBenefitIdentifiers

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

    • benefitIdentifiers

      public final List<String> benefitIdentifiers()

      Filter benefit allocations by specific benefit identifiers.

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

      Returns:
      Filter benefit allocations by specific benefit identifiers.

    • hasBenefitApplicationIdentifiers

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

    • benefitApplicationIdentifiers

      public final List<String> benefitApplicationIdentifiers()

      Filter benefit allocations by specific benefit application identifiers.

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

      Returns:
      Filter benefit allocations by specific benefit application identifiers.

    • status

      public final List<BenefitAllocationStatus> status()

      Filter benefit allocations by their current status.

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

      Returns:
      Filter benefit allocations by their current status.

    • hasStatus

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

    • statusAsStrings

      public final List<String> statusAsStrings()

      Filter benefit allocations by their current status.

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

      Returns:
      Filter benefit allocations by their current status.

    • maxResults

      public final Integer maxResults()

      The maximum number of benefit allocations to return in a single response.

      Returns:
      The maximum number of benefit allocations to return in a single response.

    • nextToken

      public final String nextToken()

      A pagination token to retrieve the next set of results from a previous request.

      Returns:
      A pagination token to retrieve the next set of results from a previous request.

    • toBuilder

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

    • builder

      public static ListBenefitAllocationsRequest.Builder builder()

    • serializableBuilderClass

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