Class GetGlossaryTermResponse

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

  • Method Details

    • createdAt

      public final Instant createdAt()

      The timestamp of when the business glossary term was created.

      Returns:
      The timestamp of when the business glossary term was created.

    • createdBy

      public final String createdBy()

      The Amazon DataZone user who created the business glossary.

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

    • domainId

      public final String domainId()

      The ID of the Amazon DataZone domain in which this business glossary term exists.

      Returns:
      The ID of the Amazon DataZone domain in which this business glossary term exists.

    • glossaryId

      public final String glossaryId()

      The ID of the business glossary to which this term belongs.

      Returns:
      The ID of the business glossary to which this term belongs.

    • id

      public final String id()

      The ID of the business glossary term.

      Returns:
      The ID of the business glossary term.

    • longDescription

      public final String longDescription()

      The long description of the business glossary term.

      Returns:
      The long description of the business glossary term.

    • name

      public final String name()

      The name of the business glossary term.

      Returns:
      The name of the business glossary term.

    • shortDescription

      public final String shortDescription()

      The short decription of the business glossary term.

      Returns:
      The short decription of the business glossary term.

    • status

      public final GlossaryTermStatus status()

      The status of the business glossary term.

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

      Returns:
      The status of the business glossary term.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the business glossary term.

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

      Returns:
      The status of the business glossary term.
      See Also:

    • termRelations

      public final TermRelations termRelations()

      The relations of the business glossary term.

      Returns:
      The relations of the business glossary term.

    • updatedAt

      public final Instant updatedAt()

      The timestamp of when the business glossary term was updated.

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

    • updatedBy

      public final String updatedBy()

      The Amazon DataZone user who updated the business glossary term.

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

    • usageRestrictions

      public final List<GlossaryUsageRestriction> usageRestrictions()

      The usage restriction of a term within a restricted glossary.

      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 restriction of a term within a restricted glossary.

    • 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 restriction of a term within a restricted glossary.

      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 restriction of a term within a restricted glossary.

    • toBuilder

      public GetGlossaryTermResponse.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<GetGlossaryTermResponse.Builder,GetGlossaryTermResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetGlossaryTermResponse.Builder builder()

    • serializableBuilderClass

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