Class AgreementEntitlement

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

Represents an entitlement associated with an agreement, including the provisioning status, resource, and type.

See Also:

  • Method Details

    • resource

      public final Resource resource()

      The resource that the entitlement is provisioned to, such as a product.

      Returns:
      The resource that the entitlement is provisioned to, such as a product.

    • type

      public final String type()

      The type of entitlement.

      Returns:
      The type of entitlement.

    • registrationToken

      public final String registrationToken()

      A short-lived token required by acceptors to register their account with the product provider. The token is only valid for 30 minutes after creation and is only applicable for purchase agreements.

      Returns:
      A short-lived token required by acceptors to register their account with the product provider. The token is only valid for 30 minutes after creation and is only applicable for purchase agreements.

    • status

      public final AgreementEntitlementStatus status()

      The current state of an entitlement.

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

      Returns:
      The current state of an entitlement.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current state of an entitlement.

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

      Returns:
      The current state of an entitlement.
      See Also:

    • statusReasonCode

      public final AgreementEntitlementStatusReasonCode statusReasonCode()

      Provides more information about the status of an entitlement.

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

      Returns:
      Provides more information about the status of an entitlement.
      See Also:

    • statusReasonCodeAsString

      public final String statusReasonCodeAsString()

      Provides more information about the status of an entitlement.

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

      Returns:
      Provides more information about the status of an entitlement.
      See Also:

    • licenseArn

      public final String licenseArn()

      The Amazon Resource Name (ARN) of the AWS License Manager license associated with the entitlement.

      Returns:
      The Amazon Resource Name (ARN) of the AWS License Manager license associated with the entitlement.

    • toBuilder

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

    • builder

      public static AgreementEntitlement.Builder builder()

    • serializableBuilderClass

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