software.amazon.awssdk.services.connect.model.HistoricalMetricResult Maven / Gradle / Ivy
Show all versions of connect 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.connect.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;
/**
*
* Contains information about the historical metrics retrieved.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class HistoricalMetricResult implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField DIMENSIONS_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("Dimensions").getter(getter(HistoricalMetricResult::dimensions)).setter(setter(Builder::dimensions))
.constructor(Dimensions::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Dimensions").build()).build();
private static final SdkField> COLLECTIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Collections")
.getter(getter(HistoricalMetricResult::collections))
.setter(setter(Builder::collections))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Collections").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(HistoricalMetricData::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DIMENSIONS_FIELD,
COLLECTIONS_FIELD));
private static final long serialVersionUID = 1L;
private final Dimensions dimensions;
private final List collections;
private HistoricalMetricResult(BuilderImpl builder) {
this.dimensions = builder.dimensions;
this.collections = builder.collections;
}
/**
*
* The dimension for the metrics.
*
*
* @return The dimension for the metrics.
*/
public final Dimensions dimensions() {
return dimensions;
}
/**
* For responses, this returns true if the service returned a value for the Collections 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 hasCollections() {
return collections != null && !(collections instanceof SdkAutoConstructList);
}
/**
*
* The set 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 {@link #hasCollections} method.
*
*
* @return The set of metrics.
*/
public final List collections() {
return collections;
}
@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(dimensions());
hashCode = 31 * hashCode + Objects.hashCode(hasCollections() ? collections() : 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 HistoricalMetricResult)) {
return false;
}
HistoricalMetricResult other = (HistoricalMetricResult) obj;
return Objects.equals(dimensions(), other.dimensions()) && hasCollections() == other.hasCollections()
&& Objects.equals(collections(), other.collections());
}
/**
* 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("HistoricalMetricResult").add("Dimensions", dimensions())
.add("Collections", hasCollections() ? collections() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Dimensions":
return Optional.ofNullable(clazz.cast(dimensions()));
case "Collections":
return Optional.ofNullable(clazz.cast(collections()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((HistoricalMetricResult) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The dimension for the metrics.
*
*
* @param dimensions
* The dimension for the metrics.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dimensions(Dimensions dimensions);
/**
*
* The dimension for the metrics.
*
* This is a convenience method that creates an instance of the {@link Dimensions.Builder} avoiding the need to
* create one manually via {@link Dimensions#builder()}.
*
*
* When the {@link Consumer} completes, {@link Dimensions.Builder#build()} is called immediately and its result
* is passed to {@link #dimensions(Dimensions)}.
*
* @param dimensions
* a consumer that will call methods on {@link Dimensions.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #dimensions(Dimensions)
*/
default Builder dimensions(Consumer dimensions) {
return dimensions(Dimensions.builder().applyMutation(dimensions).build());
}
/**
*
* The set of metrics.
*
*
* @param collections
* The set of metrics.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder collections(Collection collections);
/**
*
* The set of metrics.
*
*
* @param collections
* The set of metrics.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder collections(HistoricalMetricData... collections);
/**
*
* The set of metrics.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.connect.model.HistoricalMetricData.Builder} avoiding the need to
* create one manually via {@link software.amazon.awssdk.services.connect.model.HistoricalMetricData#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.connect.model.HistoricalMetricData.Builder#build()} is called
* immediately and its result is passed to {@link #collections(List)}.
*
* @param collections
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.connect.model.HistoricalMetricData.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #collections(java.util.Collection)
*/
Builder collections(Consumer... collections);
}
static final class BuilderImpl implements Builder {
private Dimensions dimensions;
private List collections = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(HistoricalMetricResult model) {
dimensions(model.dimensions);
collections(model.collections);
}
public final Dimensions.Builder getDimensions() {
return dimensions != null ? dimensions.toBuilder() : null;
}
public final void setDimensions(Dimensions.BuilderImpl dimensions) {
this.dimensions = dimensions != null ? dimensions.build() : null;
}
@Override
public final Builder dimensions(Dimensions dimensions) {
this.dimensions = dimensions;
return this;
}
public final List getCollections() {
List result = HistoricalMetricDataCollectionsCopier.copyToBuilder(this.collections);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setCollections(Collection collections) {
this.collections = HistoricalMetricDataCollectionsCopier.copyFromBuilder(collections);
}
@Override
public final Builder collections(Collection collections) {
this.collections = HistoricalMetricDataCollectionsCopier.copy(collections);
return this;
}
@Override
@SafeVarargs
public final Builder collections(HistoricalMetricData... collections) {
collections(Arrays.asList(collections));
return this;
}
@Override
@SafeVarargs
public final Builder collections(Consumer... collections) {
collections(Stream.of(collections).map(c -> HistoricalMetricData.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public HistoricalMetricResult build() {
return new HistoricalMetricResult(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}