software.amazon.awssdk.services.costexplorer.model.GetCostAndUsageResponse Maven / Gradle / Ivy
Show all versions of costexplorer 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.costexplorer.model;
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 GetCostAndUsageResponse extends CostExplorerResponse implements
ToCopyableBuilder {
private static final SdkField NEXT_PAGE_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextPageToken").getter(getter(GetCostAndUsageResponse::nextPageToken))
.setter(setter(Builder::nextPageToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextPageToken").build()).build();
private static final SdkField> GROUP_DEFINITIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("GroupDefinitions")
.getter(getter(GetCostAndUsageResponse::groupDefinitions))
.setter(setter(Builder::groupDefinitions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GroupDefinitions").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(GroupDefinition::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> RESULTS_BY_TIME_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ResultsByTime")
.getter(getter(GetCostAndUsageResponse::resultsByTime))
.setter(setter(Builder::resultsByTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ResultsByTime").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ResultByTime::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> DIMENSION_VALUE_ATTRIBUTES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("DimensionValueAttributes")
.getter(getter(GetCostAndUsageResponse::dimensionValueAttributes))
.setter(setter(Builder::dimensionValueAttributes))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DimensionValueAttributes").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(DimensionValuesWithAttributes::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NEXT_PAGE_TOKEN_FIELD,
GROUP_DEFINITIONS_FIELD, RESULTS_BY_TIME_FIELD, DIMENSION_VALUE_ATTRIBUTES_FIELD));
private final String nextPageToken;
private final List groupDefinitions;
private final List resultsByTime;
private final List dimensionValueAttributes;
private GetCostAndUsageResponse(BuilderImpl builder) {
super(builder);
this.nextPageToken = builder.nextPageToken;
this.groupDefinitions = builder.groupDefinitions;
this.resultsByTime = builder.resultsByTime;
this.dimensionValueAttributes = builder.dimensionValueAttributes;
}
/**
*
* The token for the next set of retrievable results. Amazon Web Services provides the token when the response from
* a previous call has more results than the maximum page size.
*
*
* @return The token for the next set of retrievable results. Amazon Web Services provides the token when the
* response from a previous call has more results than the maximum page size.
*/
public final String nextPageToken() {
return nextPageToken;
}
/**
* For responses, this returns true if the service returned a value for the GroupDefinitions 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 hasGroupDefinitions() {
return groupDefinitions != null && !(groupDefinitions instanceof SdkAutoConstructList);
}
/**
*
* The groups that are specified by the Filter or GroupBy parameters in the request.
*
*
* 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 #hasGroupDefinitions} method.
*
*
* @return The groups that are specified by the Filter or GroupBy parameters in the
* request.
*/
public final List groupDefinitions() {
return groupDefinitions;
}
/**
* For responses, this returns true if the service returned a value for the ResultsByTime 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 hasResultsByTime() {
return resultsByTime != null && !(resultsByTime instanceof SdkAutoConstructList);
}
/**
*
* The time period that's covered by the results in the response.
*
*
* 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 #hasResultsByTime} method.
*
*
* @return The time period that's covered by the results in the response.
*/
public final List resultsByTime() {
return resultsByTime;
}
/**
* For responses, this returns true if the service returned a value for the DimensionValueAttributes 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 hasDimensionValueAttributes() {
return dimensionValueAttributes != null && !(dimensionValueAttributes instanceof SdkAutoConstructList);
}
/**
*
* The attributes that apply to a specific dimension value. For example, if the value is a linked account, the
* attribute is that account name.
*
*
* 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 #hasDimensionValueAttributes} method.
*
*
* @return The attributes that apply to a specific dimension value. For example, if the value is a linked account,
* the attribute is that account name.
*/
public final List dimensionValueAttributes() {
return dimensionValueAttributes;
}
@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(nextPageToken());
hashCode = 31 * hashCode + Objects.hashCode(hasGroupDefinitions() ? groupDefinitions() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasResultsByTime() ? resultsByTime() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasDimensionValueAttributes() ? dimensionValueAttributes() : 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 GetCostAndUsageResponse)) {
return false;
}
GetCostAndUsageResponse other = (GetCostAndUsageResponse) obj;
return Objects.equals(nextPageToken(), other.nextPageToken()) && hasGroupDefinitions() == other.hasGroupDefinitions()
&& Objects.equals(groupDefinitions(), other.groupDefinitions()) && hasResultsByTime() == other.hasResultsByTime()
&& Objects.equals(resultsByTime(), other.resultsByTime())
&& hasDimensionValueAttributes() == other.hasDimensionValueAttributes()
&& Objects.equals(dimensionValueAttributes(), other.dimensionValueAttributes());
}
/**
* 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("GetCostAndUsageResponse").add("NextPageToken", nextPageToken())
.add("GroupDefinitions", hasGroupDefinitions() ? groupDefinitions() : null)
.add("ResultsByTime", hasResultsByTime() ? resultsByTime() : null)
.add("DimensionValueAttributes", hasDimensionValueAttributes() ? dimensionValueAttributes() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "NextPageToken":
return Optional.ofNullable(clazz.cast(nextPageToken()));
case "GroupDefinitions":
return Optional.ofNullable(clazz.cast(groupDefinitions()));
case "ResultsByTime":
return Optional.ofNullable(clazz.cast(resultsByTime()));
case "DimensionValueAttributes":
return Optional.ofNullable(clazz.cast(dimensionValueAttributes()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetCostAndUsageResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends CostExplorerResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* The token for the next set of retrievable results. Amazon Web Services provides the token when the response
* from a previous call has more results than the maximum page size.
*
*
* @param nextPageToken
* The token for the next set of retrievable results. Amazon Web Services provides the token when the
* response from a previous call has more results than the maximum page size.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextPageToken(String nextPageToken);
/**
*
* The groups that are specified by the Filter or GroupBy parameters in the request.
*
*
* @param groupDefinitions
* The groups that are specified by the Filter or GroupBy parameters in the
* request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder groupDefinitions(Collection groupDefinitions);
/**
*
* The groups that are specified by the Filter or GroupBy parameters in the request.
*
*
* @param groupDefinitions
* The groups that are specified by the Filter or GroupBy parameters in the
* request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder groupDefinitions(GroupDefinition... groupDefinitions);
/**
*
* The groups that are specified by the Filter or GroupBy parameters in the request.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.costexplorer.model.GroupDefinition.Builder} avoiding the need to
* create one manually via {@link software.amazon.awssdk.services.costexplorer.model.GroupDefinition#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.costexplorer.model.GroupDefinition.Builder#build()} is called
* immediately and its result is passed to {@link #groupDefinitions(List)}.
*
* @param groupDefinitions
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.costexplorer.model.GroupDefinition.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #groupDefinitions(java.util.Collection)
*/
Builder groupDefinitions(Consumer... groupDefinitions);
/**
*
* The time period that's covered by the results in the response.
*
*
* @param resultsByTime
* The time period that's covered by the results in the response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder resultsByTime(Collection resultsByTime);
/**
*
* The time period that's covered by the results in the response.
*
*
* @param resultsByTime
* The time period that's covered by the results in the response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder resultsByTime(ResultByTime... resultsByTime);
/**
*
* The time period that's covered by the results in the response.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.costexplorer.model.ResultByTime.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.costexplorer.model.ResultByTime#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.costexplorer.model.ResultByTime.Builder#build()} is called immediately
* and its result is passed to {@link #resultsByTime(List)}.
*
* @param resultsByTime
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.costexplorer.model.ResultByTime.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #resultsByTime(java.util.Collection)
*/
Builder resultsByTime(Consumer... resultsByTime);
/**
*
* The attributes that apply to a specific dimension value. For example, if the value is a linked account, the
* attribute is that account name.
*
*
* @param dimensionValueAttributes
* The attributes that apply to a specific dimension value. For example, if the value is a linked
* account, the attribute is that account name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dimensionValueAttributes(Collection dimensionValueAttributes);
/**
*
* The attributes that apply to a specific dimension value. For example, if the value is a linked account, the
* attribute is that account name.
*
*
* @param dimensionValueAttributes
* The attributes that apply to a specific dimension value. For example, if the value is a linked
* account, the attribute is that account name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dimensionValueAttributes(DimensionValuesWithAttributes... dimensionValueAttributes);
/**
*
* The attributes that apply to a specific dimension value. For example, if the value is a linked account, the
* attribute is that account name.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.costexplorer.model.DimensionValuesWithAttributes.Builder} avoiding the
* need to create one manually via
* {@link software.amazon.awssdk.services.costexplorer.model.DimensionValuesWithAttributes#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.costexplorer.model.DimensionValuesWithAttributes.Builder#build()} is
* called immediately and its result is passed to {@link
* #dimensionValueAttributes(List)}.
*
* @param dimensionValueAttributes
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.costexplorer.model.DimensionValuesWithAttributes.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #dimensionValueAttributes(java.util.Collection)
*/
Builder dimensionValueAttributes(Consumer... dimensionValueAttributes);
}
static final class BuilderImpl extends CostExplorerResponse.BuilderImpl implements Builder {
private String nextPageToken;
private List groupDefinitions = DefaultSdkAutoConstructList.getInstance();
private List resultsByTime = DefaultSdkAutoConstructList.getInstance();
private List dimensionValueAttributes = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(GetCostAndUsageResponse model) {
super(model);
nextPageToken(model.nextPageToken);
groupDefinitions(model.groupDefinitions);
resultsByTime(model.resultsByTime);
dimensionValueAttributes(model.dimensionValueAttributes);
}
public final String getNextPageToken() {
return nextPageToken;
}
public final void setNextPageToken(String nextPageToken) {
this.nextPageToken = nextPageToken;
}
@Override
public final Builder nextPageToken(String nextPageToken) {
this.nextPageToken = nextPageToken;
return this;
}
public final List getGroupDefinitions() {
List result = GroupDefinitionsCopier.copyToBuilder(this.groupDefinitions);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setGroupDefinitions(Collection groupDefinitions) {
this.groupDefinitions = GroupDefinitionsCopier.copyFromBuilder(groupDefinitions);
}
@Override
public final Builder groupDefinitions(Collection groupDefinitions) {
this.groupDefinitions = GroupDefinitionsCopier.copy(groupDefinitions);
return this;
}
@Override
@SafeVarargs
public final Builder groupDefinitions(GroupDefinition... groupDefinitions) {
groupDefinitions(Arrays.asList(groupDefinitions));
return this;
}
@Override
@SafeVarargs
public final Builder groupDefinitions(Consumer... groupDefinitions) {
groupDefinitions(Stream.of(groupDefinitions).map(c -> GroupDefinition.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final List getResultsByTime() {
List result = ResultsByTimeCopier.copyToBuilder(this.resultsByTime);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setResultsByTime(Collection resultsByTime) {
this.resultsByTime = ResultsByTimeCopier.copyFromBuilder(resultsByTime);
}
@Override
public final Builder resultsByTime(Collection resultsByTime) {
this.resultsByTime = ResultsByTimeCopier.copy(resultsByTime);
return this;
}
@Override
@SafeVarargs
public final Builder resultsByTime(ResultByTime... resultsByTime) {
resultsByTime(Arrays.asList(resultsByTime));
return this;
}
@Override
@SafeVarargs
public final Builder resultsByTime(Consumer... resultsByTime) {
resultsByTime(Stream.of(resultsByTime).map(c -> ResultByTime.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final List getDimensionValueAttributes() {
List result = DimensionValuesWithAttributesListCopier
.copyToBuilder(this.dimensionValueAttributes);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setDimensionValueAttributes(
Collection dimensionValueAttributes) {
this.dimensionValueAttributes = DimensionValuesWithAttributesListCopier.copyFromBuilder(dimensionValueAttributes);
}
@Override
public final Builder dimensionValueAttributes(Collection dimensionValueAttributes) {
this.dimensionValueAttributes = DimensionValuesWithAttributesListCopier.copy(dimensionValueAttributes);
return this;
}
@Override
@SafeVarargs
public final Builder dimensionValueAttributes(DimensionValuesWithAttributes... dimensionValueAttributes) {
dimensionValueAttributes(Arrays.asList(dimensionValueAttributes));
return this;
}
@Override
@SafeVarargs
public final Builder dimensionValueAttributes(Consumer... dimensionValueAttributes) {
dimensionValueAttributes(Stream.of(dimensionValueAttributes)
.map(c -> DimensionValuesWithAttributes.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public GetCostAndUsageResponse build() {
return new GetCostAndUsageResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}