Class AnalysisRuleList

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

A type of analysis rule that enables row-level analysis.

See Also:

  • Method Details

    • hasJoinColumns

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

    • joinColumns

      public final List<String> joinColumns()

      Columns that can be used to join a configured table with the table of the member who can query and other members' configured tables.

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

      Returns:
      Columns that can be used to join a configured table with the table of the member who can query and other members' configured tables.

    • allowedJoinOperators

      public final List<JoinOperator> allowedJoinOperators()

      The logical operators (if any) that are to be used in an INNER JOIN match condition. Default is AND.

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

      Returns:
      The logical operators (if any) that are to be used in an INNER JOIN match condition. Default is AND.

    • hasAllowedJoinOperators

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

    • allowedJoinOperatorsAsStrings

      public final List<String> allowedJoinOperatorsAsStrings()

      The logical operators (if any) that are to be used in an INNER JOIN match condition. Default is AND.

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

      Returns:
      The logical operators (if any) that are to be used in an INNER JOIN match condition. Default is AND.

    • hasListColumns

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

    • listColumns

      public final List<String> listColumns()

      Columns that can be listed in the output.

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

      Returns:
      Columns that can be listed in the output.

    • additionalAnalyses

      public final AdditionalAnalyses additionalAnalyses()

      An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.

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

      Returns:
      An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.
      See Also:

    • additionalAnalysesAsString

      public final String additionalAnalysesAsString()

      An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.

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

      Returns:
      An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.
      See Also:

    • toBuilder

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

    • builder

      public static AnalysisRuleList.Builder builder()

    • serializableBuilderClass

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