Class GlossaryItem

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

The details of a business glossary.

See Also:

  • Method Details

    • additionalAttributes

      public final GlossaryItemAdditionalAttributes additionalAttributes()

      The additional attributes of an Amazon DataZone glossary.

      Returns:
      The additional attributes of an Amazon DataZone glossary.

    • createdAt

      public final Instant createdAt()

      The timestamp of when the glossary was created.

      Returns:
      The timestamp of when the glossary was created.

    • createdBy

      public final String createdBy()

      The Amazon DataZone user who created the glossary.

      Returns:
      The Amazon DataZone user who created the glossary.

    • description

      public final String description()

      The business glossary description.

      Returns:
      The business glossary description.

    • domainId

      public final String domainId()

      The identifier of the Amazon DataZone domain in which the business glossary exists.

      Returns:
      The identifier of the Amazon DataZone domain in which the business glossary exists.

    • id

      public final String id()

      The identifier of the glossary.

      Returns:
      The identifier of the glossary.

    • name

      public final String name()

      The name of the glossary.

      Returns:
      The name of the glossary.

    • owningProjectId

      public final String owningProjectId()

      The identifier of the project that owns the business glosary.

      Returns:
      The identifier of the project that owns the business glosary.

    • status

      public final GlossaryStatus status()

      The business glossary status.

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

      Returns:
      The business glossary status.
      See Also:

    • statusAsString

      public final String statusAsString()

      The business glossary status.

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

      Returns:
      The business glossary status.
      See Also:

    • updatedAt

      public final Instant updatedAt()

      The timestamp of when the business glossary was updated.

      Returns:
      The timestamp of when the business glossary was updated.

    • updatedBy

      public final String updatedBy()

      The Amazon DataZone user who updated the business glossary.

      Returns:
      The Amazon DataZone user who updated the business glossary.

    • usageRestrictions

      public final List<GlossaryUsageRestriction> usageRestrictions()

      The usage restrictions associated with a goverened glossary term.

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

      Returns:
      The usage restrictions associated with a goverened glossary term.

    • hasUsageRestrictions

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

    • usageRestrictionsAsStrings

      public final List<String> usageRestrictionsAsStrings()

      The usage restrictions associated with a goverened glossary term.

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

      Returns:
      The usage restrictions associated with a goverened glossary term.

    • toBuilder

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

    • builder

      public static GlossaryItem.Builder builder()

    • serializableBuilderClass

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