software.amazon.awssdk.services.personalize.model.Dataset Maven / Gradle / Ivy
Show all versions of personalize 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.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 metadata for a dataset.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Dataset implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("name")
.getter(getter(Dataset::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("name").build()).build();
private static final SdkField DATASET_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("datasetArn").getter(getter(Dataset::datasetArn)).setter(setter(Builder::datasetArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("datasetArn").build()).build();
private static final SdkField DATASET_GROUP_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("datasetGroupArn").getter(getter(Dataset::datasetGroupArn)).setter(setter(Builder::datasetGroupArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("datasetGroupArn").build()).build();
private static final SdkField DATASET_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("datasetType").getter(getter(Dataset::datasetType)).setter(setter(Builder::datasetType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("datasetType").build()).build();
private static final SdkField SCHEMA_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("schemaArn").getter(getter(Dataset::schemaArn)).setter(setter(Builder::schemaArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("schemaArn").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("status")
.getter(getter(Dataset::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(Dataset::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(Dataset::lastUpdatedDateTime))
.setter(setter(Builder::lastUpdatedDateTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("lastUpdatedDateTime").build())
.build();
private static final SdkField LATEST_DATASET_UPDATE_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("latestDatasetUpdate")
.getter(getter(Dataset::latestDatasetUpdate)).setter(setter(Builder::latestDatasetUpdate))
.constructor(DatasetUpdateSummary::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("latestDatasetUpdate").build())
.build();
private static final SdkField TRACKING_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("trackingId").getter(getter(Dataset::trackingId)).setter(setter(Builder::trackingId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("trackingId").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD, DATASET_ARN_FIELD,
DATASET_GROUP_ARN_FIELD, DATASET_TYPE_FIELD, SCHEMA_ARN_FIELD, STATUS_FIELD, CREATION_DATE_TIME_FIELD,
LAST_UPDATED_DATE_TIME_FIELD, LATEST_DATASET_UPDATE_FIELD, TRACKING_ID_FIELD));
private static final long serialVersionUID = 1L;
private final String name;
private final String datasetArn;
private final String datasetGroupArn;
private final String datasetType;
private final String schemaArn;
private final String status;
private final Instant creationDateTime;
private final Instant lastUpdatedDateTime;
private final DatasetUpdateSummary latestDatasetUpdate;
private final String trackingId;
private Dataset(BuilderImpl builder) {
this.name = builder.name;
this.datasetArn = builder.datasetArn;
this.datasetGroupArn = builder.datasetGroupArn;
this.datasetType = builder.datasetType;
this.schemaArn = builder.schemaArn;
this.status = builder.status;
this.creationDateTime = builder.creationDateTime;
this.lastUpdatedDateTime = builder.lastUpdatedDateTime;
this.latestDatasetUpdate = builder.latestDatasetUpdate;
this.trackingId = builder.trackingId;
}
/**
*
* The name of the dataset.
*
*
* @return The name of the dataset.
*/
public final String name() {
return name;
}
/**
*
* The Amazon Resource Name (ARN) of the dataset that you want metadata for.
*
*
* @return The Amazon Resource Name (ARN) of the dataset that you want metadata for.
*/
public final String datasetArn() {
return datasetArn;
}
/**
*
* The Amazon Resource Name (ARN) of the dataset group.
*
*
* @return The Amazon Resource Name (ARN) of the dataset group.
*/
public final String datasetGroupArn() {
return datasetGroupArn;
}
/**
*
* One of the following values:
*
*
* -
*
* Interactions
*
*
* -
*
* Items
*
*
* -
*
* Users
*
*
* -
*
* Actions
*
*
* -
*
* Action_Interactions
*
*
*
*
* @return One of the following values:
*
* -
*
* Interactions
*
*
* -
*
* Items
*
*
* -
*
* Users
*
*
* -
*
* Actions
*
*
* -
*
* Action_Interactions
*
*
*/
public final String datasetType() {
return datasetType;
}
/**
*
* The ARN of the associated schema.
*
*
* @return The ARN of the associated schema.
*/
public final String schemaArn() {
return schemaArn;
}
/**
*
* The status of the dataset.
*
*
* A dataset can be in one of the following states:
*
*
* -
*
* CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*
*
* -
*
* DELETE PENDING > DELETE IN_PROGRESS
*
*
*
*
* @return The status of the dataset.
*
* A dataset can be in one of the following states:
*
*
* -
*
* CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*
*
* -
*
* DELETE PENDING > DELETE IN_PROGRESS
*
*
*/
public final String status() {
return status;
}
/**
*
* The creation date and time (in Unix time) of the dataset.
*
*
* @return The creation date and time (in Unix time) of the dataset.
*/
public final Instant creationDateTime() {
return creationDateTime;
}
/**
*
* A time stamp that shows when the dataset was updated.
*
*
* @return A time stamp that shows when the dataset was updated.
*/
public final Instant lastUpdatedDateTime() {
return lastUpdatedDateTime;
}
/**
*
* Describes the latest update to the dataset.
*
*
* @return Describes the latest update to the dataset.
*/
public final DatasetUpdateSummary latestDatasetUpdate() {
return latestDatasetUpdate;
}
/**
*
* The ID of the event tracker for an Action interactions dataset. You specify the tracker's ID in the
* PutActionInteractions API operation. Amazon Personalize uses it to direct new data to the Action
* interactions dataset in your dataset group.
*
*
* @return The ID of the event tracker for an Action interactions dataset. You specify the tracker's ID in the
* PutActionInteractions API operation. Amazon Personalize uses it to direct new data to the
* Action interactions dataset in your dataset group.
*/
public final String trackingId() {
return trackingId;
}
@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(datasetArn());
hashCode = 31 * hashCode + Objects.hashCode(datasetGroupArn());
hashCode = 31 * hashCode + Objects.hashCode(datasetType());
hashCode = 31 * hashCode + Objects.hashCode(schemaArn());
hashCode = 31 * hashCode + Objects.hashCode(status());
hashCode = 31 * hashCode + Objects.hashCode(creationDateTime());
hashCode = 31 * hashCode + Objects.hashCode(lastUpdatedDateTime());
hashCode = 31 * hashCode + Objects.hashCode(latestDatasetUpdate());
hashCode = 31 * hashCode + Objects.hashCode(trackingId());
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 Dataset)) {
return false;
}
Dataset other = (Dataset) obj;
return Objects.equals(name(), other.name()) && Objects.equals(datasetArn(), other.datasetArn())
&& Objects.equals(datasetGroupArn(), other.datasetGroupArn())
&& Objects.equals(datasetType(), other.datasetType()) && Objects.equals(schemaArn(), other.schemaArn())
&& Objects.equals(status(), other.status()) && Objects.equals(creationDateTime(), other.creationDateTime())
&& Objects.equals(lastUpdatedDateTime(), other.lastUpdatedDateTime())
&& Objects.equals(latestDatasetUpdate(), other.latestDatasetUpdate())
&& Objects.equals(trackingId(), other.trackingId());
}
/**
* 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("Dataset").add("Name", name()).add("DatasetArn", datasetArn())
.add("DatasetGroupArn", datasetGroupArn()).add("DatasetType", datasetType()).add("SchemaArn", schemaArn())
.add("Status", status()).add("CreationDateTime", creationDateTime())
.add("LastUpdatedDateTime", lastUpdatedDateTime()).add("LatestDatasetUpdate", latestDatasetUpdate())
.add("TrackingId", trackingId()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "name":
return Optional.ofNullable(clazz.cast(name()));
case "datasetArn":
return Optional.ofNullable(clazz.cast(datasetArn()));
case "datasetGroupArn":
return Optional.ofNullable(clazz.cast(datasetGroupArn()));
case "datasetType":
return Optional.ofNullable(clazz.cast(datasetType()));
case "schemaArn":
return Optional.ofNullable(clazz.cast(schemaArn()));
case "status":
return Optional.ofNullable(clazz.cast(status()));
case "creationDateTime":
return Optional.ofNullable(clazz.cast(creationDateTime()));
case "lastUpdatedDateTime":
return Optional.ofNullable(clazz.cast(lastUpdatedDateTime()));
case "latestDatasetUpdate":
return Optional.ofNullable(clazz.cast(latestDatasetUpdate()));
case "trackingId":
return Optional.ofNullable(clazz.cast(trackingId()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((Dataset) 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 dataset.
*
*
* @param name
* The name of the dataset.
* @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 dataset that you want metadata for.
*
*
* @param datasetArn
* The Amazon Resource Name (ARN) of the dataset that you want metadata for.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder datasetArn(String datasetArn);
/**
*
* The Amazon Resource Name (ARN) of the dataset group.
*
*
* @param datasetGroupArn
* The Amazon Resource Name (ARN) of the dataset group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder datasetGroupArn(String datasetGroupArn);
/**
*
* One of the following values:
*
*
* -
*
* Interactions
*
*
* -
*
* Items
*
*
* -
*
* Users
*
*
* -
*
* Actions
*
*
* -
*
* Action_Interactions
*
*
*
*
* @param datasetType
* One of the following values:
*
* -
*
* Interactions
*
*
* -
*
* Items
*
*
* -
*
* Users
*
*
* -
*
* Actions
*
*
* -
*
* Action_Interactions
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder datasetType(String datasetType);
/**
*
* The ARN of the associated schema.
*
*
* @param schemaArn
* The ARN of the associated schema.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder schemaArn(String schemaArn);
/**
*
* The status of the dataset.
*
*
* A dataset can be in one of the following states:
*
*
* -
*
* CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*
*
* -
*
* DELETE PENDING > DELETE IN_PROGRESS
*
*
*
*
* @param status
* The status of the dataset.
*
* A dataset can be in one of the following states:
*
*
* -
*
* CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*
*
* -
*
* 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 creation date and time (in Unix time) of the dataset.
*
*
* @param creationDateTime
* The creation date and time (in Unix time) of the dataset.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder creationDateTime(Instant creationDateTime);
/**
*
* A time stamp that shows when the dataset was updated.
*
*
* @param lastUpdatedDateTime
* A time stamp that shows when the dataset was updated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lastUpdatedDateTime(Instant lastUpdatedDateTime);
/**
*
* Describes the latest update to the dataset.
*
*
* @param latestDatasetUpdate
* Describes the latest update to the dataset.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder latestDatasetUpdate(DatasetUpdateSummary latestDatasetUpdate);
/**
*
* Describes the latest update to the dataset.
*
* This is a convenience method that creates an instance of the {@link DatasetUpdateSummary.Builder} avoiding
* the need to create one manually via {@link DatasetUpdateSummary#builder()}.
*
*
* When the {@link Consumer} completes, {@link DatasetUpdateSummary.Builder#build()} is called immediately and
* its result is passed to {@link #latestDatasetUpdate(DatasetUpdateSummary)}.
*
* @param latestDatasetUpdate
* a consumer that will call methods on {@link DatasetUpdateSummary.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #latestDatasetUpdate(DatasetUpdateSummary)
*/
default Builder latestDatasetUpdate(Consumer latestDatasetUpdate) {
return latestDatasetUpdate(DatasetUpdateSummary.builder().applyMutation(latestDatasetUpdate).build());
}
/**
*
* The ID of the event tracker for an Action interactions dataset. You specify the tracker's ID in the
* PutActionInteractions API operation. Amazon Personalize uses it to direct new data to the Action
* interactions dataset in your dataset group.
*
*
* @param trackingId
* The ID of the event tracker for an Action interactions dataset. You specify the tracker's ID in the
* PutActionInteractions API operation. Amazon Personalize uses it to direct new data to the
* Action interactions dataset in your dataset group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder trackingId(String trackingId);
}
static final class BuilderImpl implements Builder {
private String name;
private String datasetArn;
private String datasetGroupArn;
private String datasetType;
private String schemaArn;
private String status;
private Instant creationDateTime;
private Instant lastUpdatedDateTime;
private DatasetUpdateSummary latestDatasetUpdate;
private String trackingId;
private BuilderImpl() {
}
private BuilderImpl(Dataset model) {
name(model.name);
datasetArn(model.datasetArn);
datasetGroupArn(model.datasetGroupArn);
datasetType(model.datasetType);
schemaArn(model.schemaArn);
status(model.status);
creationDateTime(model.creationDateTime);
lastUpdatedDateTime(model.lastUpdatedDateTime);
latestDatasetUpdate(model.latestDatasetUpdate);
trackingId(model.trackingId);
}
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 getDatasetArn() {
return datasetArn;
}
public final void setDatasetArn(String datasetArn) {
this.datasetArn = datasetArn;
}
@Override
public final Builder datasetArn(String datasetArn) {
this.datasetArn = datasetArn;
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 getDatasetType() {
return datasetType;
}
public final void setDatasetType(String datasetType) {
this.datasetType = datasetType;
}
@Override
public final Builder datasetType(String datasetType) {
this.datasetType = datasetType;
return this;
}
public final String getSchemaArn() {
return schemaArn;
}
public final void setSchemaArn(String schemaArn) {
this.schemaArn = schemaArn;
}
@Override
public final Builder schemaArn(String schemaArn) {
this.schemaArn = schemaArn;
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;
}
public final DatasetUpdateSummary.Builder getLatestDatasetUpdate() {
return latestDatasetUpdate != null ? latestDatasetUpdate.toBuilder() : null;
}
public final void setLatestDatasetUpdate(DatasetUpdateSummary.BuilderImpl latestDatasetUpdate) {
this.latestDatasetUpdate = latestDatasetUpdate != null ? latestDatasetUpdate.build() : null;
}
@Override
public final Builder latestDatasetUpdate(DatasetUpdateSummary latestDatasetUpdate) {
this.latestDatasetUpdate = latestDatasetUpdate;
return this;
}
public final String getTrackingId() {
return trackingId;
}
public final void setTrackingId(String trackingId) {
this.trackingId = trackingId;
}
@Override
public final Builder trackingId(String trackingId) {
this.trackingId = trackingId;
return this;
}
@Override
public Dataset build() {
return new Dataset(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}