Class SchemaSummary

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

The schema summary for the objects listed by the request.

See Also:

  • Method Details

    • name

      public final String name()

      The name for the schema object.

      Returns:
      The name for the schema object.

    • type

      public final SchemaType type()

      The type of schema object. The only valid schema type is currently `TABLE`.

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

      Returns:
      The type of schema object. The only valid schema type is currently `TABLE`.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of schema object. The only valid schema type is currently `TABLE`.

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

      Returns:
      The type of schema object. The only valid schema type is currently `TABLE`.
      See Also:

    • creatorAccountId

      public final String creatorAccountId()

      The unique account ID for the Amazon Web Services account that owns the schema.

      Returns:
      The unique account ID for the Amazon Web Services account that owns the schema.

    • createTime

      public final Instant createTime()

      The time the schema object was created.

      Returns:
      The time the schema object was created.

    • updateTime

      public final Instant updateTime()

      The time the schema object was last updated.

      Returns:
      The time the schema object was last updated.

    • collaborationId

      public final String collaborationId()

      The unique ID for the collaboration that the schema belongs to.

      Returns:
      The unique ID for the collaboration that the schema belongs to.

    • collaborationArn

      public final String collaborationArn()

      The unique ARN for the collaboration that the schema belongs to.

      Returns:
      The unique ARN for the collaboration that the schema belongs to.

    • analysisRuleTypes

      public final List<AnalysisRuleType> analysisRuleTypes()

      The types of analysis rules that are associated with this schema object.

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

      Returns:
      The types of analysis rules that are associated with this schema object.

    • hasAnalysisRuleTypes

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

    • analysisRuleTypesAsStrings

      public final List<String> analysisRuleTypesAsStrings()

      The types of analysis rules that are associated with this schema object.

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

      Returns:
      The types of analysis rules that are associated with this schema object.

    • analysisMethod

      public final AnalysisMethod analysisMethod()

      The analysis method for the associated schema. The only valid value is currently `DIRECT_QUERY`.

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

      Returns:
      The analysis method for the associated schema. The only valid value is currently `DIRECT_QUERY`.
      See Also:

    • analysisMethodAsString

      public final String analysisMethodAsString()

      The analysis method for the associated schema. The only valid value is currently `DIRECT_QUERY`.

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

      Returns:
      The analysis method for the associated schema. The only valid value is currently `DIRECT_QUERY`.
      See Also:

    • toBuilder

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

    • builder

      public static SchemaSummary.Builder builder()

    • serializableBuilderClass

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