Class CreateGlossaryRequest

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

  • Method Details

    • clientToken

      public final String clientToken()

      A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

      Returns:
      A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

    • description

      public final String description()

      The description of this business glossary.

      Returns:
      The description of this business glossary.

    • domainIdentifier

      public final String domainIdentifier()

      The ID of the Amazon DataZone domain in which this business glossary is created.

      Returns:
      The ID of the Amazon DataZone domain in which this business glossary is created.

    • name

      public final String name()

      The name of this business glossary.

      Returns:
      The name of this business glossary.

    • owningProjectIdentifier

      public final String owningProjectIdentifier()

      The ID of the project that currently owns business glossary.

      Returns:
      The ID of the project that currently owns business glossary.

    • status

      public final GlossaryStatus status()

      The status of this business glossary.

      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 status of this business glossary.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of this business glossary.

      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 status of this business glossary.
      See Also:

    • usageRestrictions

      public final List<GlossaryUsageRestriction> usageRestrictions()

      The usage restriction of the 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 the 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 the 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 the restricted glossary.

    • toBuilder

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

    • builder

      public static CreateGlossaryRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateGlossaryRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.