Package software.amazon.awssdk.services.cleanrooms.model

Class AnalysisRuleAggregation

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

A type of analysis rule that enables query structure and specified queries that produce aggregate statistics.

See Also:

  • Method Details

    • hasAggregateColumns

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

    • aggregateColumns

      public final List<AggregateColumn> aggregateColumns()

      The columns that query runners are allowed to use in aggregation queries.

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

      Returns:
      The columns that query runners are allowed to use in aggregation queries.

    • 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 in configured table that can be used in join statements and/or as aggregate columns. They can never be outputted directly.

      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 in configured table that can be used in join statements and/or as aggregate columns. They can never be outputted directly.

    • joinRequired

      public final JoinRequiredOption joinRequired()

      Control that requires member who runs query to do a join with their configured table and/or other configured table in query.

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

      Returns:
      Control that requires member who runs query to do a join with their configured table and/or other configured table in query.
      See Also:

    • joinRequiredAsString

      public final String joinRequiredAsString()

      Control that requires member who runs query to do a join with their configured table and/or other configured table in query.

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

      Returns:
      Control that requires member who runs query to do a join with their configured table and/or other configured table in query.
      See Also:

    • allowedJoinOperators

      public final List<JoinOperator> allowedJoinOperators()

      Which logical operators (if any) 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:
      Which logical operators (if any) 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()

      Which logical operators (if any) 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:
      Which logical operators (if any) are to be used in an INNER JOIN match condition. Default is AND.

    • hasDimensionColumns

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

    • dimensionColumns

      public final List<String> dimensionColumns()

      The columns that query runners are allowed to select, group by, or filter by.

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

      Returns:
      The columns that query runners are allowed to select, group by, or filter by.

    • scalarFunctions

      public final List<ScalarFunctions> scalarFunctions()

      Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.

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

      Returns:
      Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.

    • hasScalarFunctions

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

    • scalarFunctionsAsStrings

      public final List<String> scalarFunctionsAsStrings()

      Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.

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

      Returns:
      Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.

    • hasOutputConstraints

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

    • outputConstraints

      public final List<AggregationConstraint> outputConstraints()

      Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.

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

      Returns:
      Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.

    • toBuilder

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

    • builder

      public static AnalysisRuleAggregation.Builder builder()

    • serializableBuilderClass

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