software.amazon.awssdk.services.pinpoint.model.ResultRow Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pinpoint Show documentation
Show all versions of pinpoint Show documentation
The AWS Java SDK for Amazon Pinpoint module holds the client classes that are used for communicating
with Amazon Pinpoint Service
/*
* 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.pinpoint.model;
import java.beans.Transient;
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.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
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;
/**
*
* Provides the results of a query that retrieved the data for a standard metric that applies to an application,
* campaign, or journey.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ResultRow implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField> GROUPED_BYS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("GroupedBys")
.getter(getter(ResultRow::groupedBys))
.setter(setter(Builder::groupedBys))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GroupedBys").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ResultRowValue::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> VALUES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Values")
.getter(getter(ResultRow::values))
.setter(setter(Builder::values))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Values").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ResultRowValue::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(GROUPED_BYS_FIELD,
VALUES_FIELD));
private static final long serialVersionUID = 1L;
private final List groupedBys;
private final List values;
private ResultRow(BuilderImpl builder) {
this.groupedBys = builder.groupedBys;
this.values = builder.values;
}
/**
* For responses, this returns true if the service returned a value for the GroupedBys 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 hasGroupedBys() {
return groupedBys != null && !(groupedBys instanceof SdkAutoConstructList);
}
/**
*
* An array of objects that defines the field and field values that were used to group data in a result set that
* contains multiple results. This value is null if the data in a result set isn’t grouped.
*
*
* 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 #hasGroupedBys} method.
*
*
* @return An array of objects that defines the field and field values that were used to group data in a result set
* that contains multiple results. This value is null if the data in a result set isn’t grouped.
*/
public final List groupedBys() {
return groupedBys;
}
/**
* For responses, this returns true if the service returned a value for the Values 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 hasValues() {
return values != null && !(values instanceof SdkAutoConstructList);
}
/**
*
* An array of objects that provides pre-aggregated values for a standard metric that applies to an application,
* campaign, or journey.
*
*
* 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 #hasValues} method.
*
*
* @return An array of objects that provides pre-aggregated values for a standard metric that applies to an
* application, campaign, or journey.
*/
public final List values() {
return values;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(hasGroupedBys() ? groupedBys() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasValues() ? values() : null);
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 ResultRow)) {
return false;
}
ResultRow other = (ResultRow) obj;
return hasGroupedBys() == other.hasGroupedBys() && Objects.equals(groupedBys(), other.groupedBys())
&& hasValues() == other.hasValues() && Objects.equals(values(), other.values());
}
/**
* 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("ResultRow").add("GroupedBys", hasGroupedBys() ? groupedBys() : null)
.add("Values", hasValues() ? values() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "GroupedBys":
return Optional.ofNullable(clazz.cast(groupedBys()));
case "Values":
return Optional.ofNullable(clazz.cast(values()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ResultRow) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* An array of objects that defines the field and field values that were used to group data in a result set that
* contains multiple results. This value is null if the data in a result set isn’t grouped.
*
*
* @param groupedBys
* An array of objects that defines the field and field values that were used to group data in a result
* set that contains multiple results. This value is null if the data in a result set isn’t grouped.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder groupedBys(Collection groupedBys);
/**
*
* An array of objects that defines the field and field values that were used to group data in a result set that
* contains multiple results. This value is null if the data in a result set isn’t grouped.
*
*
* @param groupedBys
* An array of objects that defines the field and field values that were used to group data in a result
* set that contains multiple results. This value is null if the data in a result set isn’t grouped.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder groupedBys(ResultRowValue... groupedBys);
/**
*
* An array of objects that defines the field and field values that were used to group data in a result set that
* contains multiple results. This value is null if the data in a result set isn’t grouped.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need
* to create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and
* its result is passed to {@link #groupedBys(List)}.
*
* @param groupedBys
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #groupedBys(List)
*/
Builder groupedBys(Consumer... groupedBys);
/**
*
* An array of objects that provides pre-aggregated values for a standard metric that applies to an application,
* campaign, or journey.
*
*
* @param values
* An array of objects that provides pre-aggregated values for a standard metric that applies to an
* application, campaign, or journey.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder values(Collection values);
/**
*
* An array of objects that provides pre-aggregated values for a standard metric that applies to an application,
* campaign, or journey.
*
*
* @param values
* An array of objects that provides pre-aggregated values for a standard metric that applies to an
* application, campaign, or journey.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder values(ResultRowValue... values);
/**
*
* An array of objects that provides pre-aggregated values for a standard metric that applies to an application,
* campaign, or journey.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need
* to create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and
* its result is passed to {@link #values(List)}.
*
* @param values
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #values(List)
*/
Builder values(Consumer... values);
}
static final class BuilderImpl implements Builder {
private List groupedBys = DefaultSdkAutoConstructList.getInstance();
private List values = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ResultRow model) {
groupedBys(model.groupedBys);
values(model.values);
}
public final List getGroupedBys() {
List result = ListOfResultRowValueCopier.copyToBuilder(this.groupedBys);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setGroupedBys(Collection groupedBys) {
this.groupedBys = ListOfResultRowValueCopier.copyFromBuilder(groupedBys);
}
@Override
@Transient
public final Builder groupedBys(Collection groupedBys) {
this.groupedBys = ListOfResultRowValueCopier.copy(groupedBys);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder groupedBys(ResultRowValue... groupedBys) {
groupedBys(Arrays.asList(groupedBys));
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder groupedBys(Consumer... groupedBys) {
groupedBys(Stream.of(groupedBys).map(c -> ResultRowValue.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final List getValues() {
List result = ListOfResultRowValueCopier.copyToBuilder(this.values);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setValues(Collection values) {
this.values = ListOfResultRowValueCopier.copyFromBuilder(values);
}
@Override
@Transient
public final Builder values(Collection values) {
this.values = ListOfResultRowValueCopier.copy(values);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder values(ResultRowValue... values) {
values(Arrays.asList(values));
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder values(Consumer... values) {
values(Stream.of(values).map(c -> ResultRowValue.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public ResultRow build() {
return new ResultRow(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy