Class SubscriptionGrantSummary

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

The details of the subscription grant.

See Also:

  • Method Details

    • hasAssets

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

    • assets

      public final List<SubscribedAsset> assets()

      The assets included in the subscription grant.

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

      Returns:
      The assets included in the subscription grant.

    • createdAt

      public final Instant createdAt()

      The timestamp of when a subscription grant was created.

      Returns:
      The timestamp of when a subscription grant was created.

    • createdBy

      public final String createdBy()

      The datazone user who created the subscription grant.

      Returns:
      The datazone user who created the subscription grant.

    • domainId

      public final String domainId()

      The identifier of the Amazon DataZone domain in which a subscription grant exists.

      Returns:
      The identifier of the Amazon DataZone domain in which a subscription grant exists.

    • grantedEntity

      public final GrantedEntity grantedEntity()

      The entity to which the subscription is granted.

      Returns:
      The entity to which the subscription is granted.

    • id

      public final String id()

      The identifier of the subscription grant.

      Returns:
      The identifier of the subscription grant.

    • status

      public final SubscriptionGrantOverallStatus status()

      The status of the subscription grant.

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

      Returns:
      The status of the subscription grant.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the subscription grant.

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

      Returns:
      The status of the subscription grant.
      See Also:

    • subscriptionId

      @Deprecated public final String subscriptionId()
      Deprecated.
      Multiple subscriptions can exist for a single grant

      The ID of the subscription.

      Returns:
      The ID of the subscription.

    • subscriptionTargetId

      public final String subscriptionTargetId()

      The identifier of the target of the subscription grant.

      Returns:
      The identifier of the target of the subscription grant.

    • updatedAt

      public final Instant updatedAt()

      The timestamp of when the subscription grant was updated.

      Returns:
      The timestamp of when the subscription grant was updated.

    • updatedBy

      public final String updatedBy()

      The Amazon DataZone user who updated the subscription grant.

      Returns:
      The Amazon DataZone user who updated the subscription grant.

    • toBuilder

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

    • builder

      public static SubscriptionGrantSummary.Builder builder()

    • serializableBuilderClass

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