software.amazon.awssdk.services.sagemaker.model.TimeSeriesForecastingSettings Maven / Gradle / Ivy
/*
* 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.sagemaker.model;
import java.io.Serializable;
import java.util.Arrays;
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.Function;
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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Time series forecast settings for the SageMaker Canvas application.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class TimeSeriesForecastingSettings implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Status")
.getter(getter(TimeSeriesForecastingSettings::statusAsString)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Status").build()).build();
private static final SdkField AMAZON_FORECAST_ROLE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AmazonForecastRoleArn").getter(getter(TimeSeriesForecastingSettings::amazonForecastRoleArn))
.setter(setter(Builder::amazonForecastRoleArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AmazonForecastRoleArn").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(STATUS_FIELD,
AMAZON_FORECAST_ROLE_ARN_FIELD));
private static final long serialVersionUID = 1L;
private final String status;
private final String amazonForecastRoleArn;
private TimeSeriesForecastingSettings(BuilderImpl builder) {
this.status = builder.status;
this.amazonForecastRoleArn = builder.amazonForecastRoleArn;
}
/**
*
* Describes whether time series forecasting is enabled or disabled in the Canvas application.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link FeatureStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return Describes whether time series forecasting is enabled or disabled in the Canvas application.
* @see FeatureStatus
*/
public final FeatureStatus status() {
return FeatureStatus.fromValue(status);
}
/**
*
* Describes whether time series forecasting is enabled or disabled in the Canvas application.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link FeatureStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return Describes whether time series forecasting is enabled or disabled in the Canvas application.
* @see FeatureStatus
*/
public final String statusAsString() {
return status;
}
/**
*
* The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the
* execution role specified in the UserProfile that launches the Canvas application. If an execution
* role is not specified in the UserProfile, Canvas uses the execution role specified in the Domain
* that owns the UserProfile. To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in the
* trust relationship as a service principal.
*
*
* @return The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses
* the execution role specified in the UserProfile that launches the Canvas application. If an
* execution role is not specified in the UserProfile, Canvas uses the execution role specified
* in the Domain that owns the UserProfile. To allow time series forecasting, this IAM role
* should have the AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added
* in the trust relationship as a service principal.
*/
public final String amazonForecastRoleArn() {
return amazonForecastRoleArn;
}
@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(statusAsString());
hashCode = 31 * hashCode + Objects.hashCode(amazonForecastRoleArn());
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 TimeSeriesForecastingSettings)) {
return false;
}
TimeSeriesForecastingSettings other = (TimeSeriesForecastingSettings) obj;
return Objects.equals(statusAsString(), other.statusAsString())
&& Objects.equals(amazonForecastRoleArn(), other.amazonForecastRoleArn());
}
/**
* 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("TimeSeriesForecastingSettings").add("Status", statusAsString())
.add("AmazonForecastRoleArn", amazonForecastRoleArn()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Status":
return Optional.ofNullable(clazz.cast(statusAsString()));
case "AmazonForecastRoleArn":
return Optional.ofNullable(clazz.cast(amazonForecastRoleArn()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((TimeSeriesForecastingSettings) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Describes whether time series forecasting is enabled or disabled in the Canvas application.
*
*
* @param status
* Describes whether time series forecasting is enabled or disabled in the Canvas application.
* @see FeatureStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see FeatureStatus
*/
Builder status(String status);
/**
*
* Describes whether time series forecasting is enabled or disabled in the Canvas application.
*
*
* @param status
* Describes whether time series forecasting is enabled or disabled in the Canvas application.
* @see FeatureStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see FeatureStatus
*/
Builder status(FeatureStatus status);
/**
*
* The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the
* execution role specified in the UserProfile that launches the Canvas application. If an
* execution role is not specified in the UserProfile, Canvas uses the execution role specified in
* the Domain that owns the UserProfile. To allow time series forecasting, this IAM role should
* have the AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in
* the trust relationship as a service principal.
*
*
* @param amazonForecastRoleArn
* The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas
* uses the execution role specified in the UserProfile that launches the Canvas
* application. If an execution role is not specified in the UserProfile, Canvas uses the
* execution role specified in the Domain that owns the UserProfile. To allow time series
* forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com
* added in the trust relationship as a service principal.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder amazonForecastRoleArn(String amazonForecastRoleArn);
}
static final class BuilderImpl implements Builder {
private String status;
private String amazonForecastRoleArn;
private BuilderImpl() {
}
private BuilderImpl(TimeSeriesForecastingSettings model) {
status(model.status);
amazonForecastRoleArn(model.amazonForecastRoleArn);
}
public final String getStatus() {
return status;
}
public final void setStatus(String status) {
this.status = status;
}
@Override
public final Builder status(String status) {
this.status = status;
return this;
}
@Override
public final Builder status(FeatureStatus status) {
this.status(status == null ? null : status.toString());
return this;
}
public final String getAmazonForecastRoleArn() {
return amazonForecastRoleArn;
}
public final void setAmazonForecastRoleArn(String amazonForecastRoleArn) {
this.amazonForecastRoleArn = amazonForecastRoleArn;
}
@Override
public final Builder amazonForecastRoleArn(String amazonForecastRoleArn) {
this.amazonForecastRoleArn = amazonForecastRoleArn;
return this;
}
@Override
public TimeSeriesForecastingSettings build() {
return new TimeSeriesForecastingSettings(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}