Class Schema

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

A schema is a relation within a collaboration.

See Also:

  • Method Details

    • hasColumns

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

    • columns

      public final List<Column> columns()

      The columns for the relation that this schema represents.

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

      Returns:
      The columns for the relation that this schema represents.

    • hasPartitionKeys

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

    • partitionKeys

      public final List<Column> partitionKeys()

      The partition keys for the dataset underlying this schema.

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

      Returns:
      The partition keys for the dataset underlying this schema.

    • analysisRuleTypes

      public final List<AnalysisRuleType> analysisRuleTypes()

      The analysis rule types that are associated with the schema. Currently, only one entry is present.

      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 analysis rule types that are associated with the schema. Currently, only one entry is present.

    • 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 analysis rule types that are associated with the schema. Currently, only one entry is present.

      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 analysis rule types that are associated with the schema. Currently, only one entry is present.

    • analysisMethod

      public final AnalysisMethod analysisMethod()

      The analysis method for the schema.

      DIRECT_QUERY allows SQL queries to be run directly on this table.

      DIRECT_JOB allows PySpark jobs to be run directly on this table.

      MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this table.

      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 schema.

      DIRECT_QUERY allows SQL queries to be run directly on this table.

      DIRECT_JOB allows PySpark jobs to be run directly on this table.

      MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this table.

      See Also:

    • analysisMethodAsString

      public final String analysisMethodAsString()

      The analysis method for the schema.

      DIRECT_QUERY allows SQL queries to be run directly on this table.

      DIRECT_JOB allows PySpark jobs to be run directly on this table.

      MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this table.

      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 schema.

      DIRECT_QUERY allows SQL queries to be run directly on this table.

      DIRECT_JOB allows PySpark jobs to be run directly on this table.

      MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this table.

      See Also:

    • selectedAnalysisMethods

      public final List<SelectedAnalysisMethod> selectedAnalysisMethods()

      The selected analysis methods for the schema.

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

      Returns:
      The selected analysis methods for the schema.

    • hasSelectedAnalysisMethods

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

    • selectedAnalysisMethodsAsStrings

      public final List<String> selectedAnalysisMethodsAsStrings()

      The selected analysis methods for the schema.

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

      Returns:
      The selected analysis methods for the schema.

    • 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.

    • name

      public final String name()

      A name for the schema. The schema relation is referred to by this name when queried by a protected query.

      Returns:
      A name for the schema. The schema relation is referred to by this name when queried by a protected query.

    • 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 Amazon Resource Name (ARN) for the collaboration that the schema belongs to.

      Returns:
      The unique Amazon Resource Name (ARN) for the collaboration that the schema belongs to.

    • description

      public final String description()

      A description for the schema.

      Returns:
      A description for the schema.

    • createTime

      public final Instant createTime()

      The time at which the schema was created.

      Returns:
      The time at which the schema was created.

    • updateTime

      public final Instant updateTime()

      The most recent time at which the schema was updated.

      Returns:
      The most recent time at which the schema was updated.

    • type

      public final SchemaType type()

      The type of schema.

      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.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of schema.

      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.
      See Also:

    • hasSchemaStatusDetails

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

    • schemaStatusDetails

      public final List<SchemaStatusDetail> schemaStatusDetails()

      Details about the status of the schema. Currently, only one entry is present.

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

      Returns:
      Details about the status of the schema. Currently, only one entry is present.

    • resourceArn

      public final String resourceArn()

      The Amazon Resource Name (ARN) of the schema resource.

      Returns:
      The Amazon Resource Name (ARN) of the schema resource.

    • schemaTypeProperties

      public final SchemaTypeProperties schemaTypeProperties()

      The schema type properties.

      Returns:
      The schema type properties.

    • toBuilder

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

    • builder

      public static Schema.Builder builder()

    • serializableBuilderClass

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