software.amazon.awssdk.services.pinpoint.model.BaseKpiResult Maven / Gradle / Ivy
Show all versions of pinpoint 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.pinpoint.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.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 BaseKpiResult implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField> ROWS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Rows")
.getter(getter(BaseKpiResult::rows))
.setter(setter(Builder::rows))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Rows").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ResultRow::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ROWS_FIELD));
private static final long serialVersionUID = 1L;
private final List rows;
private BaseKpiResult(BuilderImpl builder) {
this.rows = builder.rows;
}
/**
* For responses, this returns true if the service returned a value for the Rows 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 hasRows() {
return rows != null && !(rows instanceof SdkAutoConstructList);
}
/**
*
* An array of objects that provides the results of a query that retrieved the data 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 #hasRows} method.
*
*
* @return An array of objects that provides the results of a query that retrieved the data for a standard metric
* that applies to an application, campaign, or journey.
*/
public final List rows() {
return rows;
}
@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(hasRows() ? rows() : 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 BaseKpiResult)) {
return false;
}
BaseKpiResult other = (BaseKpiResult) obj;
return hasRows() == other.hasRows() && Objects.equals(rows(), other.rows());
}
/**
* 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("BaseKpiResult").add("Rows", hasRows() ? rows() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Rows":
return Optional.ofNullable(clazz.cast(rows()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((BaseKpiResult) 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 provides the results of a query that retrieved the data for a standard metric that
* applies to an application, campaign, or journey.
*
*
* @param rows
* An array of objects that provides the results of a query that retrieved the data 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 rows(Collection rows);
/**
*
* An array of objects that provides the results of a query that retrieved the data for a standard metric that
* applies to an application, campaign, or journey.
*
*
* @param rows
* An array of objects that provides the results of a query that retrieved the data 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 rows(ResultRow... rows);
/**
*
* An array of objects that provides the results of a query that retrieved the data for a standard metric that
* applies to an application, campaign, or journey.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.pinpoint.model.ResultRow.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.pinpoint.model.ResultRow#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.pinpoint.model.ResultRow.Builder#build()} is called immediately and
* its result is passed to {@link #rows(List)}.
*
* @param rows
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.pinpoint.model.ResultRow.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #rows(java.util.Collection)
*/
Builder rows(Consumer... rows);
}
static final class BuilderImpl implements Builder {
private List rows = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(BaseKpiResult model) {
rows(model.rows);
}
public final List getRows() {
List result = ListOfResultRowCopier.copyToBuilder(this.rows);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setRows(Collection rows) {
this.rows = ListOfResultRowCopier.copyFromBuilder(rows);
}
@Override
public final Builder rows(Collection rows) {
this.rows = ListOfResultRowCopier.copy(rows);
return this;
}
@Override
@SafeVarargs
public final Builder rows(ResultRow... rows) {
rows(Arrays.asList(rows));
return this;
}
@Override
@SafeVarargs
public final Builder rows(Consumer... rows) {
rows(Stream.of(rows).map(c -> ResultRow.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public BaseKpiResult build() {
return new BaseKpiResult(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}