software.amazon.awssdk.services.forecast.model.CreateWhatIfAnalysisRequest Maven / Gradle / Ivy
Show all versions of forecast 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.forecast.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.awscore.AwsRequestOverrideConfiguration;
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 CreateWhatIfAnalysisRequest extends ForecastRequest implements
ToCopyableBuilder {
private static final SdkField WHAT_IF_ANALYSIS_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("WhatIfAnalysisName").getter(getter(CreateWhatIfAnalysisRequest::whatIfAnalysisName))
.setter(setter(Builder::whatIfAnalysisName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("WhatIfAnalysisName").build())
.build();
private static final SdkField FORECAST_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ForecastArn").getter(getter(CreateWhatIfAnalysisRequest::forecastArn))
.setter(setter(Builder::forecastArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ForecastArn").build()).build();
private static final SdkField TIME_SERIES_SELECTOR_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("TimeSeriesSelector")
.getter(getter(CreateWhatIfAnalysisRequest::timeSeriesSelector)).setter(setter(Builder::timeSeriesSelector))
.constructor(TimeSeriesSelector::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TimeSeriesSelector").build())
.build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(CreateWhatIfAnalysisRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(WHAT_IF_ANALYSIS_NAME_FIELD,
FORECAST_ARN_FIELD, TIME_SERIES_SELECTOR_FIELD, TAGS_FIELD));
private final String whatIfAnalysisName;
private final String forecastArn;
private final TimeSeriesSelector timeSeriesSelector;
private final List tags;
private CreateWhatIfAnalysisRequest(BuilderImpl builder) {
super(builder);
this.whatIfAnalysisName = builder.whatIfAnalysisName;
this.forecastArn = builder.forecastArn;
this.timeSeriesSelector = builder.timeSeriesSelector;
this.tags = builder.tags;
}
/**
*
* The name of the what-if analysis. Each name must be unique.
*
*
* @return The name of the what-if analysis. Each name must be unique.
*/
public final String whatIfAnalysisName() {
return whatIfAnalysisName;
}
/**
*
* The Amazon Resource Name (ARN) of the baseline forecast.
*
*
* @return The Amazon Resource Name (ARN) of the baseline forecast.
*/
public final String forecastArn() {
return forecastArn;
}
/**
*
* Defines the set of time series that are used in the what-if analysis with a TimeSeriesIdentifiers
* object. What-if analyses are performed only for the time series in this object.
*
*
* The TimeSeriesIdentifiers object needs the following information:
*
*
* -
*
* DataSource
*
*
* -
*
* Format
*
*
* -
*
* Schema
*
*
*
*
* @return Defines the set of time series that are used in the what-if analysis with a
* TimeSeriesIdentifiers object. What-if analyses are performed only for the time series in
* this object.
*
* The TimeSeriesIdentifiers object needs the following information:
*
*
* -
*
* DataSource
*
*
* -
*
* Format
*
*
* -
*
* Schema
*
*
*/
public final TimeSeriesSelector timeSeriesSelector() {
return timeSeriesSelector;
}
/**
* For responses, this returns true if the service returned a value for the Tags 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 hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* A list of tags to
* apply to the what if forecast.
*
*
* 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 #hasTags} method.
*
*
* @return A list of tags to apply
* to the what if forecast.
*/
public final List tags() {
return tags;
}
@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(whatIfAnalysisName());
hashCode = 31 * hashCode + Objects.hashCode(forecastArn());
hashCode = 31 * hashCode + Objects.hashCode(timeSeriesSelector());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : 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 CreateWhatIfAnalysisRequest)) {
return false;
}
CreateWhatIfAnalysisRequest other = (CreateWhatIfAnalysisRequest) obj;
return Objects.equals(whatIfAnalysisName(), other.whatIfAnalysisName())
&& Objects.equals(forecastArn(), other.forecastArn())
&& Objects.equals(timeSeriesSelector(), other.timeSeriesSelector()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags());
}
/**
* 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("CreateWhatIfAnalysisRequest").add("WhatIfAnalysisName", whatIfAnalysisName())
.add("ForecastArn", forecastArn()).add("TimeSeriesSelector", timeSeriesSelector())
.add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "WhatIfAnalysisName":
return Optional.ofNullable(clazz.cast(whatIfAnalysisName()));
case "ForecastArn":
return Optional.ofNullable(clazz.cast(forecastArn()));
case "TimeSeriesSelector":
return Optional.ofNullable(clazz.cast(timeSeriesSelector()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateWhatIfAnalysisRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ForecastRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the what-if analysis. Each name must be unique.
*
*
* @param whatIfAnalysisName
* The name of the what-if analysis. Each name must be unique.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder whatIfAnalysisName(String whatIfAnalysisName);
/**
*
* The Amazon Resource Name (ARN) of the baseline forecast.
*
*
* @param forecastArn
* The Amazon Resource Name (ARN) of the baseline forecast.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder forecastArn(String forecastArn);
/**
*
* Defines the set of time series that are used in the what-if analysis with a
* TimeSeriesIdentifiers object. What-if analyses are performed only for the time series in this
* object.
*
*
* The TimeSeriesIdentifiers object needs the following information:
*
*
* -
*
* DataSource
*
*
* -
*
* Format
*
*
* -
*
* Schema
*
*
*
*
* @param timeSeriesSelector
* Defines the set of time series that are used in the what-if analysis with a
* TimeSeriesIdentifiers object. What-if analyses are performed only for the time series in
* this object.
*
* The TimeSeriesIdentifiers object needs the following information:
*
*
* -
*
* DataSource
*
*
* -
*
* Format
*
*
* -
*
* Schema
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder timeSeriesSelector(TimeSeriesSelector timeSeriesSelector);
/**
*
* Defines the set of time series that are used in the what-if analysis with a
* TimeSeriesIdentifiers object. What-if analyses are performed only for the time series in this
* object.
*
*
* The TimeSeriesIdentifiers object needs the following information:
*
*
* -
*
* DataSource
*
*
* -
*
* Format
*
*
* -
*
* Schema
*
*
*
* This is a convenience method that creates an instance of the {@link TimeSeriesSelector.Builder} avoiding the
* need to create one manually via {@link TimeSeriesSelector#builder()}.
*
*
* When the {@link Consumer} completes, {@link TimeSeriesSelector.Builder#build()} is called immediately and its
* result is passed to {@link #timeSeriesSelector(TimeSeriesSelector)}.
*
* @param timeSeriesSelector
* a consumer that will call methods on {@link TimeSeriesSelector.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #timeSeriesSelector(TimeSeriesSelector)
*/
default Builder timeSeriesSelector(Consumer timeSeriesSelector) {
return timeSeriesSelector(TimeSeriesSelector.builder().applyMutation(timeSeriesSelector).build());
}
/**
*
* A list of tags
* to apply to the what if forecast.
*
*
* @param tags
* A list of tags to
* apply to the what if forecast.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* A list of tags
* to apply to the what if forecast.
*
*
* @param tags
* A list of tags to
* apply to the what if forecast.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* A list of tags
* to apply to the what if forecast.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.forecast.model.Tag.Builder} avoiding the need to create one manually
* via {@link software.amazon.awssdk.services.forecast.model.Tag#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.forecast.model.Tag.Builder#build()} is called immediately and its
* result is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.forecast.model.Tag.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(java.util.Collection)
*/
Builder tags(Consumer... tags);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends ForecastRequest.BuilderImpl implements Builder {
private String whatIfAnalysisName;
private String forecastArn;
private TimeSeriesSelector timeSeriesSelector;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateWhatIfAnalysisRequest model) {
super(model);
whatIfAnalysisName(model.whatIfAnalysisName);
forecastArn(model.forecastArn);
timeSeriesSelector(model.timeSeriesSelector);
tags(model.tags);
}
public final String getWhatIfAnalysisName() {
return whatIfAnalysisName;
}
public final void setWhatIfAnalysisName(String whatIfAnalysisName) {
this.whatIfAnalysisName = whatIfAnalysisName;
}
@Override
public final Builder whatIfAnalysisName(String whatIfAnalysisName) {
this.whatIfAnalysisName = whatIfAnalysisName;
return this;
}
public final String getForecastArn() {
return forecastArn;
}
public final void setForecastArn(String forecastArn) {
this.forecastArn = forecastArn;
}
@Override
public final Builder forecastArn(String forecastArn) {
this.forecastArn = forecastArn;
return this;
}
public final TimeSeriesSelector.Builder getTimeSeriesSelector() {
return timeSeriesSelector != null ? timeSeriesSelector.toBuilder() : null;
}
public final void setTimeSeriesSelector(TimeSeriesSelector.BuilderImpl timeSeriesSelector) {
this.timeSeriesSelector = timeSeriesSelector != null ? timeSeriesSelector.build() : null;
}
@Override
public final Builder timeSeriesSelector(TimeSeriesSelector timeSeriesSelector) {
this.timeSeriesSelector = timeSeriesSelector;
return this;
}
public final List getTags() {
List result = TagsCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = TagsCopier.copyFromBuilder(tags);
}
@Override
public final Builder tags(Collection tags) {
this.tags = TagsCopier.copy(tags);
return this;
}
@Override
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateWhatIfAnalysisRequest build() {
return new CreateWhatIfAnalysisRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}