com.amazonaws.services.personalize.model.Dataset Maven / Gradle / Ivy
Show all versions of aws-java-sdk-personalize Show documentation
/*
* Copyright 2019-2024 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 com.amazonaws.services.personalize.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Provides metadata for a dataset.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Dataset implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the dataset.
*
*/
private String name;
/**
*
* The Amazon Resource Name (ARN) of the dataset that you want metadata for.
*
*/
private String datasetArn;
/**
*
* The Amazon Resource Name (ARN) of the dataset group.
*
*/
private String datasetGroupArn;
/**
*
* One of the following values:
*
*
* -
*
* Interactions
*
*
* -
*
* Items
*
*
* -
*
* Users
*
*
* -
*
* Actions
*
*
* -
*
* Action_Interactions
*
*
*
*/
private String datasetType;
/**
*
* The ARN of the associated schema.
*
*/
private 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
*
*
*
*/
private String status;
/**
*
* The creation date and time (in Unix time) of the dataset.
*
*/
private java.util.Date creationDateTime;
/**
*
* A time stamp that shows when the dataset was updated.
*
*/
private java.util.Date lastUpdatedDateTime;
/**
*
* Describes the latest update to the dataset.
*
*/
private DatasetUpdateSummary 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.
*
*/
private String trackingId;
/**
*
* The name of the dataset.
*
*
* @param name
* The name of the dataset.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the dataset.
*
*
* @return The name of the dataset.
*/
public String getName() {
return this.name;
}
/**
*
* 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.
*/
public Dataset withName(String name) {
setName(name);
return this;
}
/**
*
* 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.
*/
public void setDatasetArn(String datasetArn) {
this.datasetArn = datasetArn;
}
/**
*
* 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 String getDatasetArn() {
return this.datasetArn;
}
/**
*
* 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.
*/
public Dataset withDatasetArn(String datasetArn) {
setDatasetArn(datasetArn);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the dataset group.
*
*
* @param datasetGroupArn
* The Amazon Resource Name (ARN) of the dataset group.
*/
public void setDatasetGroupArn(String datasetGroupArn) {
this.datasetGroupArn = datasetGroupArn;
}
/**
*
* The Amazon Resource Name (ARN) of the dataset group.
*
*
* @return The Amazon Resource Name (ARN) of the dataset group.
*/
public String getDatasetGroupArn() {
return this.datasetGroupArn;
}
/**
*
* 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.
*/
public Dataset withDatasetGroupArn(String datasetGroupArn) {
setDatasetGroupArn(datasetGroupArn);
return this;
}
/**
*
* One of the following values:
*
*
* -
*
* Interactions
*
*
* -
*
* Items
*
*
* -
*
* Users
*
*
* -
*
* Actions
*
*
* -
*
* Action_Interactions
*
*
*
*
* @param datasetType
* One of the following values:
*
* -
*
* Interactions
*
*
* -
*
* Items
*
*
* -
*
* Users
*
*
* -
*
* Actions
*
*
* -
*
* Action_Interactions
*
*
*/
public void setDatasetType(String datasetType) {
this.datasetType = datasetType;
}
/**
*
* One of the following values:
*
*
* -
*
* Interactions
*
*
* -
*
* Items
*
*
* -
*
* Users
*
*
* -
*
* Actions
*
*
* -
*
* Action_Interactions
*
*
*
*
* @return One of the following values:
*
* -
*
* Interactions
*
*
* -
*
* Items
*
*
* -
*
* Users
*
*
* -
*
* Actions
*
*
* -
*
* Action_Interactions
*
*
*/
public String getDatasetType() {
return this.datasetType;
}
/**
*
* 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.
*/
public Dataset withDatasetType(String datasetType) {
setDatasetType(datasetType);
return this;
}
/**
*
* The ARN of the associated schema.
*
*
* @param schemaArn
* The ARN of the associated schema.
*/
public void setSchemaArn(String schemaArn) {
this.schemaArn = schemaArn;
}
/**
*
* The ARN of the associated schema.
*
*
* @return The ARN of the associated schema.
*/
public String getSchemaArn() {
return this.schemaArn;
}
/**
*
* 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.
*/
public Dataset withSchemaArn(String schemaArn) {
setSchemaArn(schemaArn);
return this;
}
/**
*
* 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
*
*
*/
public void setStatus(String status) {
this.status = 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 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 String getStatus() {
return this.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
*
*
*
*
* @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.
*/
public Dataset withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* The creation date and time (in Unix time) of the dataset.
*
*
* @param creationDateTime
* The creation date and time (in Unix time) of the dataset.
*/
public void setCreationDateTime(java.util.Date creationDateTime) {
this.creationDateTime = creationDateTime;
}
/**
*
* The creation date and time (in Unix time) of the dataset.
*
*
* @return The creation date and time (in Unix time) of the dataset.
*/
public java.util.Date getCreationDateTime() {
return this.creationDateTime;
}
/**
*
* 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.
*/
public Dataset withCreationDateTime(java.util.Date creationDateTime) {
setCreationDateTime(creationDateTime);
return this;
}
/**
*
* A time stamp that shows when the dataset was updated.
*
*
* @param lastUpdatedDateTime
* A time stamp that shows when the dataset was updated.
*/
public void setLastUpdatedDateTime(java.util.Date lastUpdatedDateTime) {
this.lastUpdatedDateTime = lastUpdatedDateTime;
}
/**
*
* A time stamp that shows when the dataset was updated.
*
*
* @return A time stamp that shows when the dataset was updated.
*/
public java.util.Date getLastUpdatedDateTime() {
return this.lastUpdatedDateTime;
}
/**
*
* 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.
*/
public Dataset withLastUpdatedDateTime(java.util.Date lastUpdatedDateTime) {
setLastUpdatedDateTime(lastUpdatedDateTime);
return this;
}
/**
*
* Describes the latest update to the dataset.
*
*
* @param latestDatasetUpdate
* Describes the latest update to the dataset.
*/
public void setLatestDatasetUpdate(DatasetUpdateSummary latestDatasetUpdate) {
this.latestDatasetUpdate = latestDatasetUpdate;
}
/**
*
* Describes the latest update to the dataset.
*
*
* @return Describes the latest update to the dataset.
*/
public DatasetUpdateSummary getLatestDatasetUpdate() {
return this.latestDatasetUpdate;
}
/**
*
* 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.
*/
public Dataset withLatestDatasetUpdate(DatasetUpdateSummary latestDatasetUpdate) {
setLatestDatasetUpdate(latestDatasetUpdate);
return this;
}
/**
*
* 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.
*/
public void setTrackingId(String trackingId) {
this.trackingId = 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 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 String getTrackingId() {
return this.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.
*
*
* @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.
*/
public Dataset withTrackingId(String trackingId) {
setTrackingId(trackingId);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getDatasetArn() != null)
sb.append("DatasetArn: ").append(getDatasetArn()).append(",");
if (getDatasetGroupArn() != null)
sb.append("DatasetGroupArn: ").append(getDatasetGroupArn()).append(",");
if (getDatasetType() != null)
sb.append("DatasetType: ").append(getDatasetType()).append(",");
if (getSchemaArn() != null)
sb.append("SchemaArn: ").append(getSchemaArn()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getCreationDateTime() != null)
sb.append("CreationDateTime: ").append(getCreationDateTime()).append(",");
if (getLastUpdatedDateTime() != null)
sb.append("LastUpdatedDateTime: ").append(getLastUpdatedDateTime()).append(",");
if (getLatestDatasetUpdate() != null)
sb.append("LatestDatasetUpdate: ").append(getLatestDatasetUpdate()).append(",");
if (getTrackingId() != null)
sb.append("TrackingId: ").append(getTrackingId());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Dataset == false)
return false;
Dataset other = (Dataset) obj;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getDatasetArn() == null ^ this.getDatasetArn() == null)
return false;
if (other.getDatasetArn() != null && other.getDatasetArn().equals(this.getDatasetArn()) == false)
return false;
if (other.getDatasetGroupArn() == null ^ this.getDatasetGroupArn() == null)
return false;
if (other.getDatasetGroupArn() != null && other.getDatasetGroupArn().equals(this.getDatasetGroupArn()) == false)
return false;
if (other.getDatasetType() == null ^ this.getDatasetType() == null)
return false;
if (other.getDatasetType() != null && other.getDatasetType().equals(this.getDatasetType()) == false)
return false;
if (other.getSchemaArn() == null ^ this.getSchemaArn() == null)
return false;
if (other.getSchemaArn() != null && other.getSchemaArn().equals(this.getSchemaArn()) == false)
return false;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getCreationDateTime() == null ^ this.getCreationDateTime() == null)
return false;
if (other.getCreationDateTime() != null && other.getCreationDateTime().equals(this.getCreationDateTime()) == false)
return false;
if (other.getLastUpdatedDateTime() == null ^ this.getLastUpdatedDateTime() == null)
return false;
if (other.getLastUpdatedDateTime() != null && other.getLastUpdatedDateTime().equals(this.getLastUpdatedDateTime()) == false)
return false;
if (other.getLatestDatasetUpdate() == null ^ this.getLatestDatasetUpdate() == null)
return false;
if (other.getLatestDatasetUpdate() != null && other.getLatestDatasetUpdate().equals(this.getLatestDatasetUpdate()) == false)
return false;
if (other.getTrackingId() == null ^ this.getTrackingId() == null)
return false;
if (other.getTrackingId() != null && other.getTrackingId().equals(this.getTrackingId()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getDatasetArn() == null) ? 0 : getDatasetArn().hashCode());
hashCode = prime * hashCode + ((getDatasetGroupArn() == null) ? 0 : getDatasetGroupArn().hashCode());
hashCode = prime * hashCode + ((getDatasetType() == null) ? 0 : getDatasetType().hashCode());
hashCode = prime * hashCode + ((getSchemaArn() == null) ? 0 : getSchemaArn().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getCreationDateTime() == null) ? 0 : getCreationDateTime().hashCode());
hashCode = prime * hashCode + ((getLastUpdatedDateTime() == null) ? 0 : getLastUpdatedDateTime().hashCode());
hashCode = prime * hashCode + ((getLatestDatasetUpdate() == null) ? 0 : getLatestDatasetUpdate().hashCode());
hashCode = prime * hashCode + ((getTrackingId() == null) ? 0 : getTrackingId().hashCode());
return hashCode;
}
@Override
public Dataset clone() {
try {
return (Dataset) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.personalize.model.transform.DatasetMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}