Class GetBenefitApplicationResponse

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

  • Method Details

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

    • catalog

      public final String catalog()

      The catalog identifier that the benefit application belongs to.

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

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

    • name

      public final String name()

      The human-readable name of the benefit application.

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

    • description

      public final String description()

      A detailed description of the benefit application.

      Returns:
      A detailed description of the 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.

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

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

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

    • statusReason

      public final String statusReason()

      Additional information explaining the current status of the benefit application.

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

    • statusReasonCode

      @Deprecated public final String statusReasonCode()
      Deprecated.
      This field is no longer used

      A standardized code representing the reason for the current status.

      Returns:
      A standardized code representing the reason for the current status.

    • hasStatusReasonCodes

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

    • statusReasonCodes

      public final List<String> statusReasonCodes()

      The list of standardized codes representing the reason for the 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 hasStatusReasonCodes() method.

      Returns:
      The list of standardized codes representing the reason for the current status.

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

    • revision

      public final String revision()

      The current revision number of the benefit application.

      Returns:
      The current revision number of 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<FileDetail> 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 GetBenefitApplicationResponse.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<GetBenefitApplicationResponse.Builder,GetBenefitApplicationResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetBenefitApplicationResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.