
software.amazon.awssdk.services.cleanrooms.model.AggregateColumn Maven / Gradle / Ivy
Show all versions of cleanrooms Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.cleanrooms.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Column in configured table that can be used in aggregate function in query.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class AggregateColumn implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField> COLUMN_NAMES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("columnNames")
.getter(getter(AggregateColumn::columnNames))
.setter(setter(Builder::columnNames))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("columnNames").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField FUNCTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("function").getter(getter(AggregateColumn::functionAsString)).setter(setter(Builder::function))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("function").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(COLUMN_NAMES_FIELD,
FUNCTION_FIELD));
private static final long serialVersionUID = 1L;
private final List columnNames;
private final String function;
private AggregateColumn(BuilderImpl builder) {
this.columnNames = builder.columnNames;
this.function = builder.function;
}
/**
* For responses, this returns true if the service returned a value for the ColumnNames property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code 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.
*/
public final boolean hasColumnNames() {
return columnNames != null && !(columnNames instanceof SdkAutoConstructList);
}
/**
*
* Column names in configured table of aggregate columns.
*
*
* 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 {@link #hasColumnNames} method.
*
*
* @return Column names in configured table of aggregate columns.
*/
public final List columnNames() {
return columnNames;
}
/**
*
* Aggregation function that can be applied to aggregate column in query.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #function} will
* return {@link AggregateFunctionName#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #functionAsString}.
*
*
* @return Aggregation function that can be applied to aggregate column in query.
* @see AggregateFunctionName
*/
public final AggregateFunctionName function() {
return AggregateFunctionName.fromValue(function);
}
/**
*
* Aggregation function that can be applied to aggregate column in query.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #function} will
* return {@link AggregateFunctionName#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #functionAsString}.
*
*
* @return Aggregation function that can be applied to aggregate column in query.
* @see AggregateFunctionName
*/
public final String functionAsString() {
return function;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(hasColumnNames() ? columnNames() : null);
hashCode = 31 * hashCode + Objects.hashCode(functionAsString());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof AggregateColumn)) {
return false;
}
AggregateColumn other = (AggregateColumn) obj;
return hasColumnNames() == other.hasColumnNames() && Objects.equals(columnNames(), other.columnNames())
&& Objects.equals(functionAsString(), other.functionAsString());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("AggregateColumn").add("ColumnNames", hasColumnNames() ? columnNames() : null)
.add("Function", functionAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "columnNames":
return Optional.ofNullable(clazz.cast(columnNames()));
case "function":
return Optional.ofNullable(clazz.cast(functionAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function