software.amazon.awssdk.services.personalize.model.RecommenderSummary 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.personalize.model;
import java.io.Serializable;
import java.time.Instant;
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.Consumer;
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;
/**
*
* Provides a summary of the properties of the recommender.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class RecommenderSummary implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("name")
.getter(getter(RecommenderSummary::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("name").build()).build();
private static final SdkField RECOMMENDER_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("recommenderArn").getter(getter(RecommenderSummary::recommenderArn))
.setter(setter(Builder::recommenderArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("recommenderArn").build()).build();
private static final SdkField DATASET_GROUP_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("datasetGroupArn").getter(getter(RecommenderSummary::datasetGroupArn))
.setter(setter(Builder::datasetGroupArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("datasetGroupArn").build()).build();
private static final SdkField RECIPE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("recipeArn").getter(getter(RecommenderSummary::recipeArn)).setter(setter(Builder::recipeArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("recipeArn").build()).build();
private static final SdkField RECOMMENDER_CONFIG_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("recommenderConfig")
.getter(getter(RecommenderSummary::recommenderConfig)).setter(setter(Builder::recommenderConfig))
.constructor(RecommenderConfig::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("recommenderConfig").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("status")
.getter(getter(RecommenderSummary::status)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("status").build()).build();
private static final SdkField CREATION_DATE_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("creationDateTime").getter(getter(RecommenderSummary::creationDateTime))
.setter(setter(Builder::creationDateTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("creationDateTime").build()).build();
private static final SdkField LAST_UPDATED_DATE_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("lastUpdatedDateTime").getter(getter(RecommenderSummary::lastUpdatedDateTime))
.setter(setter(Builder::lastUpdatedDateTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("lastUpdatedDateTime").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD,
RECOMMENDER_ARN_FIELD, DATASET_GROUP_ARN_FIELD, RECIPE_ARN_FIELD, RECOMMENDER_CONFIG_FIELD, STATUS_FIELD,
CREATION_DATE_TIME_FIELD, LAST_UPDATED_DATE_TIME_FIELD));
private static final long serialVersionUID = 1L;
private final String name;
private final String recommenderArn;
private final String datasetGroupArn;
private final String recipeArn;
private final RecommenderConfig recommenderConfig;
private final String status;
private final Instant creationDateTime;
private final Instant lastUpdatedDateTime;
private RecommenderSummary(BuilderImpl builder) {
this.name = builder.name;
this.recommenderArn = builder.recommenderArn;
this.datasetGroupArn = builder.datasetGroupArn;
this.recipeArn = builder.recipeArn;
this.recommenderConfig = builder.recommenderConfig;
this.status = builder.status;
this.creationDateTime = builder.creationDateTime;
this.lastUpdatedDateTime = builder.lastUpdatedDateTime;
}
/**
*
* The name of the recommender.
*
*
* @return The name of the recommender.
*/
public final String name() {
return name;
}
/**
*
* The Amazon Resource Name (ARN) of the recommender.
*
*
* @return The Amazon Resource Name (ARN) of the recommender.
*/
public final String recommenderArn() {
return recommenderArn;
}
/**
*
* The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
*
*
* @return The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
*/
public final String datasetGroupArn() {
return datasetGroupArn;
}
/**
*
* The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created
* for.
*
*
* @return The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was
* created for.
*/
public final String recipeArn() {
return recipeArn;
}
/**
*
* The configuration details of the recommender.
*
*
* @return The configuration details of the recommender.
*/
public final RecommenderConfig recommenderConfig() {
return recommenderConfig;
}
/**
*
* The status of the recommender. A recommender can be in one of the following states:
*
*
* -
*
* CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*
*
* -
*
* STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
*
*
* -
*
* DELETE PENDING > DELETE IN_PROGRESS
*
*
*
*
* @return The status of the recommender. A recommender can be in one of the following states:
*
* -
*
* CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*
*
* -
*
* STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
*
*
* -
*
* DELETE PENDING > DELETE IN_PROGRESS
*
*
*/
public final String status() {
return status;
}
/**
*
* The date and time (in Unix format) that the recommender was created.
*
*
* @return The date and time (in Unix format) that the recommender was created.
*/
public final Instant creationDateTime() {
return creationDateTime;
}
/**
*
* The date and time (in Unix format) that the recommender was last updated.
*
*
* @return The date and time (in Unix format) that the recommender was last updated.
*/
public final Instant lastUpdatedDateTime() {
return lastUpdatedDateTime;
}
@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(name());
hashCode = 31 * hashCode + Objects.hashCode(recommenderArn());
hashCode = 31 * hashCode + Objects.hashCode(datasetGroupArn());
hashCode = 31 * hashCode + Objects.hashCode(recipeArn());
hashCode = 31 * hashCode + Objects.hashCode(recommenderConfig());
hashCode = 31 * hashCode + Objects.hashCode(status());
hashCode = 31 * hashCode + Objects.hashCode(creationDateTime());
hashCode = 31 * hashCode + Objects.hashCode(lastUpdatedDateTime());
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 RecommenderSummary)) {
return false;
}
RecommenderSummary other = (RecommenderSummary) obj;
return Objects.equals(name(), other.name()) && Objects.equals(recommenderArn(), other.recommenderArn())
&& Objects.equals(datasetGroupArn(), other.datasetGroupArn()) && Objects.equals(recipeArn(), other.recipeArn())
&& Objects.equals(recommenderConfig(), other.recommenderConfig()) && Objects.equals(status(), other.status())
&& Objects.equals(creationDateTime(), other.creationDateTime())
&& Objects.equals(lastUpdatedDateTime(), other.lastUpdatedDateTime());
}
/**
* 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("RecommenderSummary").add("Name", name()).add("RecommenderArn", recommenderArn())
.add("DatasetGroupArn", datasetGroupArn()).add("RecipeArn", recipeArn())
.add("RecommenderConfig", recommenderConfig()).add("Status", status())
.add("CreationDateTime", creationDateTime()).add("LastUpdatedDateTime", lastUpdatedDateTime()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "name":
return Optional.ofNullable(clazz.cast(name()));
case "recommenderArn":
return Optional.ofNullable(clazz.cast(recommenderArn()));
case "datasetGroupArn":
return Optional.ofNullable(clazz.cast(datasetGroupArn()));
case "recipeArn":
return Optional.ofNullable(clazz.cast(recipeArn()));
case "recommenderConfig":
return Optional.ofNullable(clazz.cast(recommenderConfig()));
case "status":
return Optional.ofNullable(clazz.cast(status()));
case "creationDateTime":
return Optional.ofNullable(clazz.cast(creationDateTime()));
case "lastUpdatedDateTime":
return Optional.ofNullable(clazz.cast(lastUpdatedDateTime()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((RecommenderSummary) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The name of the recommender.
*
*
* @param name
* The name of the recommender.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The Amazon Resource Name (ARN) of the recommender.
*
*
* @param recommenderArn
* The Amazon Resource Name (ARN) of the recommender.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder recommenderArn(String recommenderArn);
/**
*
* The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
*
*
* @param datasetGroupArn
* The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder datasetGroupArn(String datasetGroupArn);
/**
*
* The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created
* for.
*
*
* @param recipeArn
* The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was
* created for.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder recipeArn(String recipeArn);
/**
*
* The configuration details of the recommender.
*
*
* @param recommenderConfig
* The configuration details of the recommender.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder recommenderConfig(RecommenderConfig recommenderConfig);
/**
*
* The configuration details of the recommender.
*
* This is a convenience method that creates an instance of the {@link RecommenderConfig.Builder} avoiding the
* need to create one manually via {@link RecommenderConfig#builder()}.
*
*
* When the {@link Consumer} completes, {@link RecommenderConfig.Builder#build()} is called immediately and its
* result is passed to {@link #recommenderConfig(RecommenderConfig)}.
*
* @param recommenderConfig
* a consumer that will call methods on {@link RecommenderConfig.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #recommenderConfig(RecommenderConfig)
*/
default Builder recommenderConfig(Consumer recommenderConfig) {
return recommenderConfig(RecommenderConfig.builder().applyMutation(recommenderConfig).build());
}
/**
*
* The status of the recommender. A recommender can be in one of the following states:
*
*
* -
*
* CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*
*
* -
*
* STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
*
*
* -
*
* DELETE PENDING > DELETE IN_PROGRESS
*
*
*
*
* @param status
* The status of the recommender. A recommender can be in one of the following states:
*
* -
*
* CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*
*
* -
*
* STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
*
*
* -
*
* DELETE PENDING > DELETE IN_PROGRESS
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder status(String status);
/**
*
* The date and time (in Unix format) that the recommender was created.
*
*
* @param creationDateTime
* The date and time (in Unix format) that the recommender was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder creationDateTime(Instant creationDateTime);
/**
*
* The date and time (in Unix format) that the recommender was last updated.
*
*
* @param lastUpdatedDateTime
* The date and time (in Unix format) that the recommender was last updated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lastUpdatedDateTime(Instant lastUpdatedDateTime);
}
static final class BuilderImpl implements Builder {
private String name;
private String recommenderArn;
private String datasetGroupArn;
private String recipeArn;
private RecommenderConfig recommenderConfig;
private String status;
private Instant creationDateTime;
private Instant lastUpdatedDateTime;
private BuilderImpl() {
}
private BuilderImpl(RecommenderSummary model) {
name(model.name);
recommenderArn(model.recommenderArn);
datasetGroupArn(model.datasetGroupArn);
recipeArn(model.recipeArn);
recommenderConfig(model.recommenderConfig);
status(model.status);
creationDateTime(model.creationDateTime);
lastUpdatedDateTime(model.lastUpdatedDateTime);
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final String getRecommenderArn() {
return recommenderArn;
}
public final void setRecommenderArn(String recommenderArn) {
this.recommenderArn = recommenderArn;
}
@Override
public final Builder recommenderArn(String recommenderArn) {
this.recommenderArn = recommenderArn;
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 String getRecipeArn() {
return recipeArn;
}
public final void setRecipeArn(String recipeArn) {
this.recipeArn = recipeArn;
}
@Override
public final Builder recipeArn(String recipeArn) {
this.recipeArn = recipeArn;
return this;
}
public final RecommenderConfig.Builder getRecommenderConfig() {
return recommenderConfig != null ? recommenderConfig.toBuilder() : null;
}
public final void setRecommenderConfig(RecommenderConfig.BuilderImpl recommenderConfig) {
this.recommenderConfig = recommenderConfig != null ? recommenderConfig.build() : null;
}
@Override
public final Builder recommenderConfig(RecommenderConfig recommenderConfig) {
this.recommenderConfig = recommenderConfig;
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 getCreationDateTime() {
return creationDateTime;
}
public final void setCreationDateTime(Instant creationDateTime) {
this.creationDateTime = creationDateTime;
}
@Override
public final Builder creationDateTime(Instant creationDateTime) {
this.creationDateTime = creationDateTime;
return this;
}
public final Instant getLastUpdatedDateTime() {
return lastUpdatedDateTime;
}
public final void setLastUpdatedDateTime(Instant lastUpdatedDateTime) {
this.lastUpdatedDateTime = lastUpdatedDateTime;
}
@Override
public final Builder lastUpdatedDateTime(Instant lastUpdatedDateTime) {
this.lastUpdatedDateTime = lastUpdatedDateTime;
return this;
}
@Override
public RecommenderSummary build() {
return new RecommenderSummary(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}