Class IntermediateTable

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

Contains the details of an intermediate table in Clean Rooms. An intermediate table stores a query definition and its materialized results within a collaboration.

See Also:

  • Method Details

    • id

      public final String id()

      The unique identifier of the intermediate table.

      Returns:
      The unique identifier of the intermediate table.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the intermediate table.

      Returns:
      The Amazon Resource Name (ARN) of the intermediate table.

    • name

      public final String name()

      The name of the intermediate table.

      Returns:
      The name of the intermediate table.

    • description

      public final String description()

      The description of the intermediate table.

      Returns:
      The description of the intermediate table.

    • membershipArn

      public final String membershipArn()

      The Amazon Resource Name (ARN) of the membership that contains the intermediate table.

      Returns:
      The Amazon Resource Name (ARN) of the membership that contains the intermediate table.

    • membershipId

      public final String membershipId()

      The unique identifier of the membership that contains the intermediate table.

      Returns:
      The unique identifier of the membership that contains the intermediate table.

    • collaborationArn

      public final String collaborationArn()

      The Amazon Resource Name (ARN) of the collaboration that contains the intermediate table.

      Returns:
      The Amazon Resource Name (ARN) of the collaboration that contains the intermediate table.

    • collaborationId

      public final String collaborationId()

      The unique identifier of the collaboration that contains the intermediate table.

      Returns:
      The unique identifier of the collaboration that contains the intermediate table.

    • hasChildResources

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

    • childResources

      public final List<ChildResource> childResources()

      The child resources that depend on this intermediate 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 hasChildResources() method.

      Returns:
      The child resources that depend on this intermediate table.

    • createTime

      public final Instant createTime()

      The time the intermediate table was created.

      Returns:
      The time the intermediate table was created.

    • updateTime

      public final Instant updateTime()

      The time the intermediate table was last updated.

      Returns:
      The time the intermediate table was last updated.

    • status

      public final IntermediateTableStatus status()

      The current status of the intermediate table.

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

      Returns:
      The current status of the intermediate table.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the intermediate table.

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

      Returns:
      The current status of the intermediate table.
      See Also:

    • statusReason

      public final String statusReason()

      The reason for the current status of the intermediate table.

      Returns:
      The reason for the current status of the intermediate table.

    • kmsKeyArn

      public final String kmsKeyArn()

      The Amazon Resource Name (ARN) of the KMS key used to encrypt the intermediate table data.

      Returns:
      The Amazon Resource Name (ARN) of the KMS key used to encrypt the intermediate table data.

    • populationAnalysisConfiguration

      public final PopulationAnalysisConfiguration populationAnalysisConfiguration()

      The analysis configuration that defines the query used to populate the intermediate table.

      Returns:
      The analysis configuration that defines the query used to populate the intermediate table.

    • retentionInDays

      public final Integer retentionInDays()

      The number of days that populated data is retained before expiring.

      Returns:
      The number of days that populated data is retained before expiring.

    • hasTableDependencies

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

    • tableDependencies

      public final List<IntermediateTableDependency> tableDependencies()

      The list of base tables that this intermediate table depends on.

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

      Returns:
      The list of base tables that this intermediate table depends on.

    • intermediateTableVersion

      public final IntermediateTableActiveVersion intermediateTableVersion()

      The details of the currently active version of the intermediate table.

      Returns:
      The details of the currently active version of the intermediate table.

    • analysisRuleTypes

      public final List<IntermediateTableAnalysisRuleType> analysisRuleTypes()

      The types of analysis rules associated with the intermediate 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 the intermediate 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 the intermediate 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 the intermediate table.

    • schema

      public final IntermediateTableSchema schema()

      The schema of the intermediate table, containing column definitions. Available after the table has been successfully populated.

      Returns:
      The schema of the intermediate table, containing column definitions. Available after the table has been successfully populated.

    • toBuilder

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

    • builder

      public static IntermediateTable.Builder builder()

    • serializableBuilderClass

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