Class DefinitionDocument

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

A document that defines an entity.

See Also:

  • Method Details

    • language

      public final DefinitionLanguage language()

      The language used to define the entity. GRAPHQL is the only valid value.

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

      Returns:
      The language used to define the entity. GRAPHQL is the only valid value.
      See Also:

    • languageAsString

      public final String languageAsString()

      The language used to define the entity. GRAPHQL is the only valid value.

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

      Returns:
      The language used to define the entity. GRAPHQL is the only valid value.
      See Also:

    • text

      public final String text()

      The GraphQL text that defines the entity.

      Returns:
      The GraphQL text that defines the entity.

    • toBuilder

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

    • builder

      public static DefinitionDocument.Builder builder()

    • serializableBuilderClass

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