Class DocumentAttributeConfiguration

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

Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.

For more information, see Understanding document attributes.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the document attribute.

      Returns:
      The name of the document attribute.

    • type

      public final AttributeType type()

      The type of document attribute.

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

      Returns:
      The type of document attribute.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of document attribute.

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

      Returns:
      The type of document attribute.
      See Also:

    • search

      public final Status search()

      Information about whether the document attribute can be used by an end user to search for information on their web experience.

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

      Returns:
      Information about whether the document attribute can be used by an end user to search for information on their web experience.
      See Also:

    • searchAsString

      public final String searchAsString()

      Information about whether the document attribute can be used by an end user to search for information on their web experience.

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

      Returns:
      Information about whether the document attribute can be used by an end user to search for information on their web experience.
      See Also:

    • toBuilder

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

    • builder

      public static DocumentAttributeConfiguration.Builder builder()

    • serializableBuilderClass

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