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(value="software.amazon.awssdk:codegen")
public final class AnalysisRuleAggregation
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AnalysisRuleAggregation.Builder,AnalysisRuleAggregation>

Enables query structure and specified queries that product aggregate statistics.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AnalysisRuleAggregation.Builder

Method Summary

Modifier and Type	Method and Description
List<AggregateColumn>	aggregateColumns() The columns that query runners are allowed to use in aggregation queries.
static AnalysisRuleAggregation.Builder	builder()
List<String>	dimensionColumns() The columns that query runners are allowed to select, group by, or filter by.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAggregateColumns() For responses, this returns true if the service returned a value for the AggregateColumns property.
boolean	hasDimensionColumns() For responses, this returns true if the service returned a value for the DimensionColumns property.
int	hashCode()
boolean	hasJoinColumns() For responses, this returns true if the service returned a value for the JoinColumns property.
boolean	hasOutputConstraints() For responses, this returns true if the service returned a value for the OutputConstraints property.
boolean	hasScalarFunctions() For responses, this returns true if the service returned a value for the ScalarFunctions property.
List<String>	joinColumns() Columns in configured table that can be used in join statements and/or as aggregate columns.
JoinRequiredOption	joinRequired() Control that requires member who runs query to do a join with their configured table and/or other configured table in query
String	joinRequiredAsString() Control that requires member who runs query to do a join with their configured table and/or other configured table in query
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.
List<ScalarFunctions>	scalarFunctions() Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.
List<String>	scalarFunctionsAsStrings() Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.
List<SdkField<?>>	sdkFields()
static Class<? extends AnalysisRuleAggregation.Builder>	serializableBuilderClass()
AnalysisRuleAggregation.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

JoinRequiredOption

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:

JoinRequiredOption

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()

Specified by:

toBuilder in interface ToCopyableBuilder<AnalysisRuleAggregation.Builder,AnalysisRuleAggregation>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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