Package software.amazon.awssdk.services.cleanrooms.model

Class SchemaStatusDetail

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

Information about the schema status.

A status of READY means that based on the schema analysis rule, queries of the given analysis rule type are properly configured to run queries on this schema.

See Also:

  • Method Details

    • status

      public final SchemaStatus status()

      The status of the schema.

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

      Returns:
      The status of the schema.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the schema.

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

      Returns:
      The status of the schema.
      See Also:

    • hasReasons

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

    • reasons

      public final List<SchemaStatusReason> reasons()

      The reasons why the schema status is set to its current state.

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

      Returns:
      The reasons why the schema status is set to its current state.

    • analysisRuleType

      public final AnalysisRuleType analysisRuleType()

      The analysis rule type for which the schema status has been evaluated.

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

      Returns:
      The analysis rule type for which the schema status has been evaluated.
      See Also:

    • analysisRuleTypeAsString

      public final String analysisRuleTypeAsString()

      The analysis rule type for which the schema status has been evaluated.

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

      Returns:
      The analysis rule type for which the schema status has been evaluated.
      See Also:

    • configurations

      public final List<SchemaConfiguration> configurations()

      The configuration details of the schema analysis rule for the given type.

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

      Returns:
      The configuration details of the schema analysis rule for the given type.

    • hasConfigurations

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

    • configurationsAsStrings

      public final List<String> configurationsAsStrings()

      The configuration details of the schema analysis rule for the given type.

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

      Returns:
      The configuration details of the schema analysis rule for the given type.

    • toBuilder

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

    • builder

      public static SchemaStatusDetail.Builder builder()

    • serializableBuilderClass

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