software.amazon.awssdk.services.marketplaceagreement.model.FixedUpfrontPricingTerm Maven / Gradle / Ivy
Show all versions of marketplaceagreement 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.marketplaceagreement.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;
/**
*
* Defines a prepaid pricing model where the customers are charged a fixed upfront amount.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class FixedUpfrontPricingTerm implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField CURRENCY_CODE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("currencyCode").getter(getter(FixedUpfrontPricingTerm::currencyCode))
.setter(setter(Builder::currencyCode))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("currencyCode").build()).build();
private static final SdkField DURATION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("duration").getter(getter(FixedUpfrontPricingTerm::duration)).setter(setter(Builder::duration))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("duration").build()).build();
private static final SdkField> GRANTS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("grants")
.getter(getter(FixedUpfrontPricingTerm::grants))
.setter(setter(Builder::grants))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("grants").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(GrantItem::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField PRICE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("price")
.getter(getter(FixedUpfrontPricingTerm::price)).setter(setter(Builder::price))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("price").build()).build();
private static final SdkField TYPE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("type")
.getter(getter(FixedUpfrontPricingTerm::type)).setter(setter(Builder::type))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("type").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CURRENCY_CODE_FIELD,
DURATION_FIELD, GRANTS_FIELD, PRICE_FIELD, TYPE_FIELD));
private static final long serialVersionUID = 1L;
private final String currencyCode;
private final String duration;
private final List grants;
private final String price;
private final String type;
private FixedUpfrontPricingTerm(BuilderImpl builder) {
this.currencyCode = builder.currencyCode;
this.duration = builder.duration;
this.grants = builder.grants;
this.price = builder.price;
this.type = builder.type;
}
/**
*
* Defines the currency for the prices mentioned in this term.
*
*
* @return Defines the currency for the prices mentioned in this term.
*/
public final String currencyCode() {
return currencyCode;
}
/**
*
* Contract duration for the terms.
*
*
* @return Contract duration for the terms.
*/
public final String duration() {
return duration;
}
/**
* For responses, this returns true if the service returned a value for the Grants 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 hasGrants() {
return grants != null && !(grants instanceof SdkAutoConstructList);
}
/**
*
* Entitlements granted to the acceptor of fixed upfront as part of agreement execution.
*
*
* 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 #hasGrants} method.
*
*
* @return Entitlements granted to the acceptor of fixed upfront as part of agreement execution.
*/
public final List grants() {
return grants;
}
/**
*
* Fixed amount to be charged to the customer when this term is accepted.
*
*
* @return Fixed amount to be charged to the customer when this term is accepted.
*/
public final String price() {
return price;
}
/**
*
* Category of the term being updated.
*
*
* @return Category of the term being updated.
*/
public final String type() {
return type;
}
@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(currencyCode());
hashCode = 31 * hashCode + Objects.hashCode(duration());
hashCode = 31 * hashCode + Objects.hashCode(hasGrants() ? grants() : null);
hashCode = 31 * hashCode + Objects.hashCode(price());
hashCode = 31 * hashCode + Objects.hashCode(type());
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 FixedUpfrontPricingTerm)) {
return false;
}
FixedUpfrontPricingTerm other = (FixedUpfrontPricingTerm) obj;
return Objects.equals(currencyCode(), other.currencyCode()) && Objects.equals(duration(), other.duration())
&& hasGrants() == other.hasGrants() && Objects.equals(grants(), other.grants())
&& Objects.equals(price(), other.price()) && Objects.equals(type(), other.type());
}
/**
* 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("FixedUpfrontPricingTerm").add("CurrencyCode", currencyCode()).add("Duration", duration())
.add("Grants", hasGrants() ? grants() : null).add("Price", price()).add("Type", type()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "currencyCode":
return Optional.ofNullable(clazz.cast(currencyCode()));
case "duration":
return Optional.ofNullable(clazz.cast(duration()));
case "grants":
return Optional.ofNullable(clazz.cast(grants()));
case "price":
return Optional.ofNullable(clazz.cast(price()));
case "type":
return Optional.ofNullable(clazz.cast(type()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((FixedUpfrontPricingTerm) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Defines the currency for the prices mentioned in this term.
*
*
* @param currencyCode
* Defines the currency for the prices mentioned in this term.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder currencyCode(String currencyCode);
/**
*
* Contract duration for the terms.
*
*
* @param duration
* Contract duration for the terms.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder duration(String duration);
/**
*
* Entitlements granted to the acceptor of fixed upfront as part of agreement execution.
*
*
* @param grants
* Entitlements granted to the acceptor of fixed upfront as part of agreement execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder grants(Collection grants);
/**
*
* Entitlements granted to the acceptor of fixed upfront as part of agreement execution.
*
*
* @param grants
* Entitlements granted to the acceptor of fixed upfront as part of agreement execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder grants(GrantItem... grants);
/**
*
* Entitlements granted to the acceptor of fixed upfront as part of agreement execution.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.marketplaceagreement.model.GrantItem.Builder} avoiding the need to
* create one manually via
* {@link software.amazon.awssdk.services.marketplaceagreement.model.GrantItem#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.marketplaceagreement.model.GrantItem.Builder#build()} is called
* immediately and its result is passed to {@link #grants(List)}.
*
* @param grants
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.marketplaceagreement.model.GrantItem.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #grants(java.util.Collection)
*/
Builder grants(Consumer... grants);
/**
*
* Fixed amount to be charged to the customer when this term is accepted.
*
*
* @param price
* Fixed amount to be charged to the customer when this term is accepted.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder price(String price);
/**
*
* Category of the term being updated.
*
*
* @param type
* Category of the term being updated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder type(String type);
}
static final class BuilderImpl implements Builder {
private String currencyCode;
private String duration;
private List grants = DefaultSdkAutoConstructList.getInstance();
private String price;
private String type;
private BuilderImpl() {
}
private BuilderImpl(FixedUpfrontPricingTerm model) {
currencyCode(model.currencyCode);
duration(model.duration);
grants(model.grants);
price(model.price);
type(model.type);
}
public final String getCurrencyCode() {
return currencyCode;
}
public final void setCurrencyCode(String currencyCode) {
this.currencyCode = currencyCode;
}
@Override
public final Builder currencyCode(String currencyCode) {
this.currencyCode = currencyCode;
return this;
}
public final String getDuration() {
return duration;
}
public final void setDuration(String duration) {
this.duration = duration;
}
@Override
public final Builder duration(String duration) {
this.duration = duration;
return this;
}
public final List getGrants() {
List result = GrantListCopier.copyToBuilder(this.grants);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setGrants(Collection grants) {
this.grants = GrantListCopier.copyFromBuilder(grants);
}
@Override
public final Builder grants(Collection grants) {
this.grants = GrantListCopier.copy(grants);
return this;
}
@Override
@SafeVarargs
public final Builder grants(GrantItem... grants) {
grants(Arrays.asList(grants));
return this;
}
@Override
@SafeVarargs
public final Builder grants(Consumer... grants) {
grants(Stream.of(grants).map(c -> GrantItem.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final String getPrice() {
return price;
}
public final void setPrice(String price) {
this.price = price;
}
@Override
public final Builder price(String price) {
this.price = price;
return this;
}
public final String getType() {
return type;
}
public final void setType(String type) {
this.type = type;
}
@Override
public final Builder type(String type) {
this.type = type;
return this;
}
@Override
public FixedUpfrontPricingTerm build() {
return new FixedUpfrontPricingTerm(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}