Class ConfiguredTable

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

A table that has been configured for use in a collaboration.

See Also:

  • Method Details

    • id

      public final String id()

      The unique ID for the configured table.

      Returns:
      The unique ID for the configured table.

    • arn

      public final String arn()

      The unique ARN for the configured table.

      Returns:
      The unique ARN for the configured table.

    • name

      public final String name()

      A name for the configured table.

      Returns:
      A name for the configured table.

    • description

      public final String description()

      A description for the configured table.

      Returns:
      A description for the configured table.

    • tableReference

      public final TableReference tableReference()

      The table that this configured table represents.

      Returns:
      The table that this configured table represents.

    • createTime

      public final Instant createTime()

      The time the configured table was created.

      Returns:
      The time the configured table was created.

    • updateTime

      public final Instant updateTime()

      The time the configured table was last updated

      Returns:
      The time the configured table was last updated

    • analysisRuleTypes

      public final List<ConfiguredTableAnalysisRuleType> analysisRuleTypes()

      The types of analysis rules associated with this configured table. Currently, only one analysis rule may be associated with a configured table.

      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 associated with this configured table. Currently, only one analysis rule may be associated with a configured table.

    • 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 associated with this configured table. Currently, only one analysis rule may be associated with a configured table.

      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 associated with this configured table. Currently, only one analysis rule may be associated with a configured table.

    • analysisMethod

      public final AnalysisMethod analysisMethod()

      The analysis method for the configured table.

      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 configured table.

      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 configured table.

      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 configured table.

      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:

    • hasAllowedColumns

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

    • allowedColumns

      public final List<String> allowedColumns()

      The columns within the underlying Glue table that can be utilized within collaborations.

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

      Returns:
      The columns within the underlying Glue table that can be utilized within collaborations.

    • selectedAnalysisMethods

      public final List<SelectedAnalysisMethod> selectedAnalysisMethods()

      The selected analysis methods for the configured table.

      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 configured table.

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

      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 configured table.

    • toBuilder

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

    • builder

      public static ConfiguredTable.Builder builder()

    • serializableBuilderClass

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