software.amazon.awssdk.services.cloudwatch.model.GetMetricDataResponse Maven / Gradle / Ivy
Show all versions of cloudwatch 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.cloudwatch.model;
import java.beans.Transient;
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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class GetMetricDataResponse extends CloudWatchResponse implements
ToCopyableBuilder {
private static final SdkField> METRIC_DATA_RESULTS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("MetricDataResults")
.getter(getter(GetMetricDataResponse::metricDataResults))
.setter(setter(Builder::metricDataResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MetricDataResults").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(MetricDataResult::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(GetMetricDataResponse::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final SdkField> MESSAGES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Messages")
.getter(getter(GetMetricDataResponse::messages))
.setter(setter(Builder::messages))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Messages").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(MessageData::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(METRIC_DATA_RESULTS_FIELD,
NEXT_TOKEN_FIELD, MESSAGES_FIELD));
private final List metricDataResults;
private final String nextToken;
private final List messages;
private GetMetricDataResponse(BuilderImpl builder) {
super(builder);
this.metricDataResults = builder.metricDataResults;
this.nextToken = builder.nextToken;
this.messages = builder.messages;
}
/**
* For responses, this returns true if the service returned a value for the MetricDataResults 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 hasMetricDataResults() {
return metricDataResults != null && !(metricDataResults instanceof SdkAutoConstructList);
}
/**
*
* The metrics that are returned, including the metric name, namespace, and dimensions.
*
*
* 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 #hasMetricDataResults} method.
*
*
* @return The metrics that are returned, including the metric name, namespace, and dimensions.
*/
public final List metricDataResults() {
return metricDataResults;
}
/**
*
* A token that marks the next batch of returned results.
*
*
* @return A token that marks the next batch of returned results.
*/
public final String nextToken() {
return nextToken;
}
/**
* For responses, this returns true if the service returned a value for the Messages 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 hasMessages() {
return messages != null && !(messages instanceof SdkAutoConstructList);
}
/**
*
* Contains a message about this GetMetricData operation, if the operation results in such a message.
* An example of a message that might be returned is Maximum number of allowed metrics exceeded. If
* there is a message, as much of the operation as possible is still executed.
*
*
* A message appears here only if it is related to the global GetMetricData operation. Any message
* about a specific metric returned by the operation appears in the MetricDataResult object returned
* for that metric.
*
*
* 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 #hasMessages} method.
*
*
* @return Contains a message about this GetMetricData operation, if the operation results in such a
* message. An example of a message that might be returned is
* Maximum number of allowed metrics exceeded. If there is a message, as much of the operation
* as possible is still executed.
*
* A message appears here only if it is related to the global GetMetricData operation. Any
* message about a specific metric returned by the operation appears in the MetricDataResult
* object returned for that metric.
*/
public final List messages() {
return messages;
}
@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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(hasMetricDataResults() ? metricDataResults() : null);
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(hasMessages() ? messages() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof GetMetricDataResponse)) {
return false;
}
GetMetricDataResponse other = (GetMetricDataResponse) obj;
return hasMetricDataResults() == other.hasMetricDataResults()
&& Objects.equals(metricDataResults(), other.metricDataResults())
&& Objects.equals(nextToken(), other.nextToken()) && hasMessages() == other.hasMessages()
&& Objects.equals(messages(), other.messages());
}
/**
* 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("GetMetricDataResponse")
.add("MetricDataResults", hasMetricDataResults() ? metricDataResults() : null).add("NextToken", nextToken())
.add("Messages", hasMessages() ? messages() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "MetricDataResults":
return Optional.ofNullable(clazz.cast(metricDataResults()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "Messages":
return Optional.ofNullable(clazz.cast(messages()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetMetricDataResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends CloudWatchResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* The metrics that are returned, including the metric name, namespace, and dimensions.
*
*
* @param metricDataResults
* The metrics that are returned, including the metric name, namespace, and dimensions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder metricDataResults(Collection metricDataResults);
/**
*
* The metrics that are returned, including the metric name, namespace, and dimensions.
*
*
* @param metricDataResults
* The metrics that are returned, including the metric name, namespace, and dimensions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder metricDataResults(MetricDataResult... metricDataResults);
/**
*
* The metrics that are returned, including the metric name, namespace, and dimensions.
*
* 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 #metricDataResults(List)}.
*
* @param metricDataResults
* 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 #metricDataResults(List)
*/
Builder metricDataResults(Consumer... metricDataResults);
/**
*
* A token that marks the next batch of returned results.
*
*
* @param nextToken
* A token that marks the next batch of returned results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* Contains a message about this GetMetricData operation, if the operation results in such a
* message. An example of a message that might be returned is
* Maximum number of allowed metrics exceeded. If there is a message, as much of the operation as
* possible is still executed.
*
*
* A message appears here only if it is related to the global GetMetricData operation. Any message
* about a specific metric returned by the operation appears in the MetricDataResult object
* returned for that metric.
*
*
* @param messages
* Contains a message about this GetMetricData operation, if the operation results in such a
* message. An example of a message that might be returned is
* Maximum number of allowed metrics exceeded. If there is a message, as much of the
* operation as possible is still executed.
*
* A message appears here only if it is related to the global GetMetricData operation. Any
* message about a specific metric returned by the operation appears in the MetricDataResult
* object returned for that metric.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder messages(Collection messages);
/**
*
* Contains a message about this GetMetricData operation, if the operation results in such a
* message. An example of a message that might be returned is
* Maximum number of allowed metrics exceeded. If there is a message, as much of the operation as
* possible is still executed.
*
*
* A message appears here only if it is related to the global GetMetricData operation. Any message
* about a specific metric returned by the operation appears in the MetricDataResult object
* returned for that metric.
*
*
* @param messages
* Contains a message about this GetMetricData operation, if the operation results in such a
* message. An example of a message that might be returned is
* Maximum number of allowed metrics exceeded. If there is a message, as much of the
* operation as possible is still executed.
*
* A message appears here only if it is related to the global GetMetricData operation. Any
* message about a specific metric returned by the operation appears in the MetricDataResult
* object returned for that metric.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder messages(MessageData... messages);
/**
*
* Contains a message about this GetMetricData operation, if the operation results in such a
* message. An example of a message that might be returned is
* Maximum number of allowed metrics exceeded. If there is a message, as much of the operation as
* possible is still executed.
*
*
* A message appears here only if it is related to the global GetMetricData operation. Any message
* about a specific metric returned by the operation appears in the MetricDataResult object
* returned for that metric.
*
* 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 #messages(List)}.
*
* @param messages
* 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 #messages(List)
*/
Builder messages(Consumer... messages);
}
static final class BuilderImpl extends CloudWatchResponse.BuilderImpl implements Builder {
private List metricDataResults = DefaultSdkAutoConstructList.getInstance();
private String nextToken;
private List messages = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(GetMetricDataResponse model) {
super(model);
metricDataResults(model.metricDataResults);
nextToken(model.nextToken);
messages(model.messages);
}
public final List getMetricDataResults() {
List result = MetricDataResultsCopier.copyToBuilder(this.metricDataResults);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setMetricDataResults(Collection metricDataResults) {
this.metricDataResults = MetricDataResultsCopier.copyFromBuilder(metricDataResults);
}
@Override
@Transient
public final Builder metricDataResults(Collection metricDataResults) {
this.metricDataResults = MetricDataResultsCopier.copy(metricDataResults);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder metricDataResults(MetricDataResult... metricDataResults) {
metricDataResults(Arrays.asList(metricDataResults));
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder metricDataResults(Consumer... metricDataResults) {
metricDataResults(Stream.of(metricDataResults).map(c -> MetricDataResult.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
@Transient
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final List getMessages() {
List result = MetricDataResultMessagesCopier.copyToBuilder(this.messages);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setMessages(Collection messages) {
this.messages = MetricDataResultMessagesCopier.copyFromBuilder(messages);
}
@Override
@Transient
public final Builder messages(Collection messages) {
this.messages = MetricDataResultMessagesCopier.copy(messages);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder messages(MessageData... messages) {
messages(Arrays.asList(messages));
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder messages(Consumer... messages) {
messages(Stream.of(messages).map(c -> MessageData.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public GetMetricDataResponse build() {
return new GetMetricDataResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}