Package software.amazon.awssdk.services.eks.model

Class EksAnywhereSubscription

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

An EKS Anywhere subscription authorizing the customer to support for licensed clusters and access to EKS Anywhere Curated Packages.

See Also:

  • Method Details

    • id

      public final String id()

      UUID identifying a subscription.

      Returns:
      UUID identifying a subscription.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) for the subscription.

      Returns:
      The Amazon Resource Name (ARN) for the subscription.

    • createdAt

      public final Instant createdAt()

      The Unix timestamp in seconds for when the subscription was created.

      Returns:
      The Unix timestamp in seconds for when the subscription was created.

    • effectiveDate

      public final Instant effectiveDate()

      The Unix timestamp in seconds for when the subscription is effective.

      Returns:
      The Unix timestamp in seconds for when the subscription is effective.

    • expirationDate

      public final Instant expirationDate()

      The Unix timestamp in seconds for when the subscription will expire or auto renew, depending on the auto renew configuration of the subscription object.

      Returns:
      The Unix timestamp in seconds for when the subscription will expire or auto renew, depending on the auto renew configuration of the subscription object.

    • licenseQuantity

      public final Integer licenseQuantity()

      The number of licenses included in a subscription. Valid values are between 1 and 100.

      Returns:
      The number of licenses included in a subscription. Valid values are between 1 and 100.

    • licenseType

      public final EksAnywhereSubscriptionLicenseType licenseType()

      The type of licenses included in the subscription. Valid value is CLUSTER. With the CLUSTER license type, each license covers support for a single EKS Anywhere cluster.

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

      Returns:
      The type of licenses included in the subscription. Valid value is CLUSTER. With the CLUSTER license type, each license covers support for a single EKS Anywhere cluster.
      See Also:

    • licenseTypeAsString

      public final String licenseTypeAsString()

      The type of licenses included in the subscription. Valid value is CLUSTER. With the CLUSTER license type, each license covers support for a single EKS Anywhere cluster.

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

      Returns:
      The type of licenses included in the subscription. Valid value is CLUSTER. With the CLUSTER license type, each license covers support for a single EKS Anywhere cluster.
      See Also:

    • term

      public final EksAnywhereSubscriptionTerm term()

      An EksAnywhereSubscriptionTerm object.

      Returns:
      An EksAnywhereSubscriptionTerm object.

    • status

      public final String status()

      The status of a subscription.

      Returns:
      The status of a subscription.

    • autoRenew

      public final Boolean autoRenew()

      A boolean indicating whether or not a subscription will auto renew when it expires.

      Returns:
      A boolean indicating whether or not a subscription will auto renew when it expires.

    • hasLicenseArns

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

    • licenseArns

      public final List<String> licenseArns()

      Amazon Web Services License Manager ARN associated with the subscription.

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

      Returns:
      Amazon Web Services License Manager ARN associated with the subscription.

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      The metadata for a subscription to assist with categorization and organization. Each tag consists of a key and an optional value. Subscription tags do not propagate to any other resources associated with the subscription.

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

      Returns:
      The metadata for a subscription to assist with categorization and organization. Each tag consists of a key and an optional value. Subscription tags do not propagate to any other resources associated with the subscription.

    • toBuilder

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

    • builder

      public static EksAnywhereSubscription.Builder builder()

    • serializableBuilderClass

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