software.amazon.awssdk.services.forecast.model.DescribeDatasetGroupResponse 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.time.Instant;
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.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.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 DescribeDatasetGroupResponse extends ForecastResponse implements
ToCopyableBuilder {
private static final SdkField DATASET_GROUP_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DatasetGroupName").getter(getter(DescribeDatasetGroupResponse::datasetGroupName))
.setter(setter(Builder::datasetGroupName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DatasetGroupName").build()).build();
private static final SdkField DATASET_GROUP_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DatasetGroupArn").getter(getter(DescribeDatasetGroupResponse::datasetGroupArn))
.setter(setter(Builder::datasetGroupArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DatasetGroupArn").build()).build();
private static final SdkField> DATASET_ARNS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("DatasetArns")
.getter(getter(DescribeDatasetGroupResponse::datasetArns))
.setter(setter(Builder::datasetArns))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DatasetArns").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField DOMAIN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Domain")
.getter(getter(DescribeDatasetGroupResponse::domainAsString)).setter(setter(Builder::domain))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Domain").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Status")
.getter(getter(DescribeDatasetGroupResponse::status)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Status").build()).build();
private static final SdkField CREATION_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("CreationTime").getter(getter(DescribeDatasetGroupResponse::creationTime))
.setter(setter(Builder::creationTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreationTime").build()).build();
private static final SdkField LAST_MODIFICATION_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("LastModificationTime").getter(getter(DescribeDatasetGroupResponse::lastModificationTime))
.setter(setter(Builder::lastModificationTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LastModificationTime").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DATASET_GROUP_NAME_FIELD,
DATASET_GROUP_ARN_FIELD, DATASET_ARNS_FIELD, DOMAIN_FIELD, STATUS_FIELD, CREATION_TIME_FIELD,
LAST_MODIFICATION_TIME_FIELD));
private final String datasetGroupName;
private final String datasetGroupArn;
private final List datasetArns;
private final String domain;
private final String status;
private final Instant creationTime;
private final Instant lastModificationTime;
private DescribeDatasetGroupResponse(BuilderImpl builder) {
super(builder);
this.datasetGroupName = builder.datasetGroupName;
this.datasetGroupArn = builder.datasetGroupArn;
this.datasetArns = builder.datasetArns;
this.domain = builder.domain;
this.status = builder.status;
this.creationTime = builder.creationTime;
this.lastModificationTime = builder.lastModificationTime;
}
/**
*
* The name of the dataset group.
*
*
* @return The name of the dataset group.
*/
public final String datasetGroupName() {
return datasetGroupName;
}
/**
*
* The ARN of the dataset group.
*
*
* @return The ARN of the dataset group.
*/
public final String datasetGroupArn() {
return datasetGroupArn;
}
/**
* For responses, this returns true if the service returned a value for the DatasetArns 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 hasDatasetArns() {
return datasetArns != null && !(datasetArns instanceof SdkAutoConstructList);
}
/**
*
* An array of Amazon Resource Names (ARNs) of the datasets contained in the dataset group.
*
*
* 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 #hasDatasetArns} method.
*
*
* @return An array of Amazon Resource Names (ARNs) of the datasets contained in the dataset group.
*/
public final List datasetArns() {
return datasetArns;
}
/**
*
* The domain associated with the dataset group.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #domain} will
* return {@link Domain#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #domainAsString}.
*
*
* @return The domain associated with the dataset group.
* @see Domain
*/
public final Domain domain() {
return Domain.fromValue(domain);
}
/**
*
* The domain associated with the dataset group.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #domain} will
* return {@link Domain#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #domainAsString}.
*
*
* @return The domain associated with the dataset group.
* @see Domain
*/
public final String domainAsString() {
return domain;
}
/**
*
* The status of the dataset group. States include:
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
* -
*
* UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED
*
*
*
*
* The UPDATE states apply when you call the UpdateDatasetGroup
* operation.
*
*
*
* The Status of the dataset group must be ACTIVE before you can use the dataset group to
* create a predictor.
*
*
*
* @return The status of the dataset group. States include:
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
* -
*
* UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED
*
*
*
*
* The UPDATE states apply when you call the UpdateDatasetGroup
* operation.
*
*
*
* The Status of the dataset group must be ACTIVE before you can use the dataset
* group to create a predictor.
*
*/
public final String status() {
return status;
}
/**
*
* When the dataset group was created.
*
*
* @return When the dataset group was created.
*/
public final Instant creationTime() {
return creationTime;
}
/**
*
* When the dataset group was created or last updated from a call to the UpdateDatasetGroup
* operation. While the dataset group is being updated, LastModificationTime is the current time of the
* DescribeDatasetGroup call.
*
*
* @return When the dataset group was created or last updated from a call to the UpdateDatasetGroup
* operation. While the dataset group is being updated, LastModificationTime is the current
* time of the DescribeDatasetGroup call.
*/
public final Instant lastModificationTime() {
return lastModificationTime;
}
@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(datasetGroupName());
hashCode = 31 * hashCode + Objects.hashCode(datasetGroupArn());
hashCode = 31 * hashCode + Objects.hashCode(hasDatasetArns() ? datasetArns() : null);
hashCode = 31 * hashCode + Objects.hashCode(domainAsString());
hashCode = 31 * hashCode + Objects.hashCode(status());
hashCode = 31 * hashCode + Objects.hashCode(creationTime());
hashCode = 31 * hashCode + Objects.hashCode(lastModificationTime());
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 DescribeDatasetGroupResponse)) {
return false;
}
DescribeDatasetGroupResponse other = (DescribeDatasetGroupResponse) obj;
return Objects.equals(datasetGroupName(), other.datasetGroupName())
&& Objects.equals(datasetGroupArn(), other.datasetGroupArn()) && hasDatasetArns() == other.hasDatasetArns()
&& Objects.equals(datasetArns(), other.datasetArns()) && Objects.equals(domainAsString(), other.domainAsString())
&& Objects.equals(status(), other.status()) && Objects.equals(creationTime(), other.creationTime())
&& Objects.equals(lastModificationTime(), other.lastModificationTime());
}
/**
* 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("DescribeDatasetGroupResponse").add("DatasetGroupName", datasetGroupName())
.add("DatasetGroupArn", datasetGroupArn()).add("DatasetArns", hasDatasetArns() ? datasetArns() : null)
.add("Domain", domainAsString()).add("Status", status()).add("CreationTime", creationTime())
.add("LastModificationTime", lastModificationTime()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DatasetGroupName":
return Optional.ofNullable(clazz.cast(datasetGroupName()));
case "DatasetGroupArn":
return Optional.ofNullable(clazz.cast(datasetGroupArn()));
case "DatasetArns":
return Optional.ofNullable(clazz.cast(datasetArns()));
case "Domain":
return Optional.ofNullable(clazz.cast(domainAsString()));
case "Status":
return Optional.ofNullable(clazz.cast(status()));
case "CreationTime":
return Optional.ofNullable(clazz.cast(creationTime()));
case "LastModificationTime":
return Optional.ofNullable(clazz.cast(lastModificationTime()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeDatasetGroupResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ForecastResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the dataset group.
*
*
* @param datasetGroupName
* The name of the dataset group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder datasetGroupName(String datasetGroupName);
/**
*
* The ARN of the dataset group.
*
*
* @param datasetGroupArn
* The ARN of the dataset group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder datasetGroupArn(String datasetGroupArn);
/**
*
* An array of Amazon Resource Names (ARNs) of the datasets contained in the dataset group.
*
*
* @param datasetArns
* An array of Amazon Resource Names (ARNs) of the datasets contained in the dataset group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder datasetArns(Collection datasetArns);
/**
*
* An array of Amazon Resource Names (ARNs) of the datasets contained in the dataset group.
*
*
* @param datasetArns
* An array of Amazon Resource Names (ARNs) of the datasets contained in the dataset group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder datasetArns(String... datasetArns);
/**
*
* The domain associated with the dataset group.
*
*
* @param domain
* The domain associated with the dataset group.
* @see Domain
* @return Returns a reference to this object so that method calls can be chained together.
* @see Domain
*/
Builder domain(String domain);
/**
*
* The domain associated with the dataset group.
*
*
* @param domain
* The domain associated with the dataset group.
* @see Domain
* @return Returns a reference to this object so that method calls can be chained together.
* @see Domain
*/
Builder domain(Domain domain);
/**
*
* The status of the dataset group. States include:
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
* -
*
* UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED
*
*
*
*
* The UPDATE states apply when you call the UpdateDatasetGroup
* operation.
*
*
*
* The Status of the dataset group must be ACTIVE before you can use the dataset group
* to create a predictor.
*
*
*
* @param status
* The status of the dataset group. States include:
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
* -
*
* UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED
*
*
*
*
* The UPDATE states apply when you call the UpdateDatasetGroup operation.
*
*
*
* The Status of the dataset group must be ACTIVE before you can use the
* dataset group to create a predictor.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder status(String status);
/**
*
* When the dataset group was created.
*
*
* @param creationTime
* When the dataset group was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder creationTime(Instant creationTime);
/**
*
* When the dataset group was created or last updated from a call to the UpdateDatasetGroup
* operation. While the dataset group is being updated, LastModificationTime is the current time of
* the DescribeDatasetGroup call.
*
*
* @param lastModificationTime
* When the dataset group was created or last updated from a call to the UpdateDatasetGroup operation. While the dataset group is being updated,
* LastModificationTime is the current time of the DescribeDatasetGroup call.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lastModificationTime(Instant lastModificationTime);
}
static final class BuilderImpl extends ForecastResponse.BuilderImpl implements Builder {
private String datasetGroupName;
private String datasetGroupArn;
private List datasetArns = DefaultSdkAutoConstructList.getInstance();
private String domain;
private String status;
private Instant creationTime;
private Instant lastModificationTime;
private BuilderImpl() {
}
private BuilderImpl(DescribeDatasetGroupResponse model) {
super(model);
datasetGroupName(model.datasetGroupName);
datasetGroupArn(model.datasetGroupArn);
datasetArns(model.datasetArns);
domain(model.domain);
status(model.status);
creationTime(model.creationTime);
lastModificationTime(model.lastModificationTime);
}
public final String getDatasetGroupName() {
return datasetGroupName;
}
public final void setDatasetGroupName(String datasetGroupName) {
this.datasetGroupName = datasetGroupName;
}
@Override
public final Builder datasetGroupName(String datasetGroupName) {
this.datasetGroupName = datasetGroupName;
return this;
}
public final String getDatasetGroupArn() {
return datasetGroupArn;
}
public final void setDatasetGroupArn(String datasetGroupArn) {
this.datasetGroupArn = datasetGroupArn;
}
@Override
public final Builder datasetGroupArn(String datasetGroupArn) {
this.datasetGroupArn = datasetGroupArn;
return this;
}
public final Collection getDatasetArns() {
if (datasetArns instanceof SdkAutoConstructList) {
return null;
}
return datasetArns;
}
public final void setDatasetArns(Collection datasetArns) {
this.datasetArns = ArnListCopier.copy(datasetArns);
}
@Override
public final Builder datasetArns(Collection datasetArns) {
this.datasetArns = ArnListCopier.copy(datasetArns);
return this;
}
@Override
@SafeVarargs
public final Builder datasetArns(String... datasetArns) {
datasetArns(Arrays.asList(datasetArns));
return this;
}
public final String getDomain() {
return domain;
}
public final void setDomain(String domain) {
this.domain = domain;
}
@Override
public final Builder domain(String domain) {
this.domain = domain;
return this;
}
@Override
public final Builder domain(Domain domain) {
this.domain(domain == null ? null : domain.toString());
return this;
}
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;
}
public final Instant getCreationTime() {
return creationTime;
}
public final void setCreationTime(Instant creationTime) {
this.creationTime = creationTime;
}
@Override
public final Builder creationTime(Instant creationTime) {
this.creationTime = creationTime;
return this;
}
public final Instant getLastModificationTime() {
return lastModificationTime;
}
public final void setLastModificationTime(Instant lastModificationTime) {
this.lastModificationTime = lastModificationTime;
}
@Override
public final Builder lastModificationTime(Instant lastModificationTime) {
this.lastModificationTime = lastModificationTime;
return this;
}
@Override
public DescribeDatasetGroupResponse build() {
return new DescribeDatasetGroupResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}