com.amazonaws.services.iotanalytics.model.Dataset Maven / Gradle / Ivy
Show all versions of aws-java-sdk-iotanalytics 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.iotanalytics.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Information about 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 ARN of the dataset.
*
*/
private String arn;
/**
*
* The DatasetAction objects that automatically create the dataset contents.
*
*/
private java.util.List actions;
/**
*
* The DatasetTrigger objects that specify when the dataset is automatically updated.
*
*/
private java.util.List triggers;
/**
*
* When dataset contents are created they are delivered to destinations specified here.
*
*/
private java.util.List contentDeliveryRules;
/**
*
* The status of the dataset.
*
*/
private String status;
/**
*
* When the dataset was created.
*
*/
private java.util.Date creationTime;
/**
*
* The last time the dataset was updated.
*
*/
private java.util.Date lastUpdateTime;
/**
*
* Optional. How long, in days, message data is kept for the dataset.
*
*/
private RetentionPeriod retentionPeriod;
/**
*
* Optional. How many versions of dataset contents are kept. If not specified or set to null, only the latest
* version plus the latest succeeded version (if they are different) are kept for the time period specified by the
* retentionPeriod parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.
*
*/
private VersioningConfiguration versioningConfiguration;
/**
*
* A list of data rules that send notifications to CloudWatch, when data arrives late. To specify
* lateDataRules, the dataset must use a DeltaTimer filter.
*
*/
private java.util.List lateDataRules;
/**
*
* 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 ARN of the dataset.
*
*
* @param arn
* The ARN of the dataset.
*/
public void setArn(String arn) {
this.arn = arn;
}
/**
*
* The ARN of the dataset.
*
*
* @return The ARN of the dataset.
*/
public String getArn() {
return this.arn;
}
/**
*
* The ARN of the dataset.
*
*
* @param arn
* The ARN of the dataset.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Dataset withArn(String arn) {
setArn(arn);
return this;
}
/**
*
* The DatasetAction objects that automatically create the dataset contents.
*
*
* @return The DatasetAction objects that automatically create the dataset contents.
*/
public java.util.List getActions() {
return actions;
}
/**
*
* The DatasetAction objects that automatically create the dataset contents.
*
*
* @param actions
* The DatasetAction objects that automatically create the dataset contents.
*/
public void setActions(java.util.Collection actions) {
if (actions == null) {
this.actions = null;
return;
}
this.actions = new java.util.ArrayList(actions);
}
/**
*
* The DatasetAction objects that automatically create the dataset contents.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setActions(java.util.Collection)} or {@link #withActions(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param actions
* The DatasetAction objects that automatically create the dataset contents.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Dataset withActions(DatasetAction... actions) {
if (this.actions == null) {
setActions(new java.util.ArrayList(actions.length));
}
for (DatasetAction ele : actions) {
this.actions.add(ele);
}
return this;
}
/**
*
* The DatasetAction objects that automatically create the dataset contents.
*
*
* @param actions
* The DatasetAction objects that automatically create the dataset contents.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Dataset withActions(java.util.Collection actions) {
setActions(actions);
return this;
}
/**
*
* The DatasetTrigger objects that specify when the dataset is automatically updated.
*
*
* @return The DatasetTrigger objects that specify when the dataset is automatically updated.
*/
public java.util.List getTriggers() {
return triggers;
}
/**
*
* The DatasetTrigger objects that specify when the dataset is automatically updated.
*
*
* @param triggers
* The DatasetTrigger objects that specify when the dataset is automatically updated.
*/
public void setTriggers(java.util.Collection triggers) {
if (triggers == null) {
this.triggers = null;
return;
}
this.triggers = new java.util.ArrayList(triggers);
}
/**
*
* The DatasetTrigger objects that specify when the dataset is automatically updated.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTriggers(java.util.Collection)} or {@link #withTriggers(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param triggers
* The DatasetTrigger objects that specify when the dataset is automatically updated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Dataset withTriggers(DatasetTrigger... triggers) {
if (this.triggers == null) {
setTriggers(new java.util.ArrayList(triggers.length));
}
for (DatasetTrigger ele : triggers) {
this.triggers.add(ele);
}
return this;
}
/**
*
* The DatasetTrigger objects that specify when the dataset is automatically updated.
*
*
* @param triggers
* The DatasetTrigger objects that specify when the dataset is automatically updated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Dataset withTriggers(java.util.Collection triggers) {
setTriggers(triggers);
return this;
}
/**
*
* When dataset contents are created they are delivered to destinations specified here.
*
*
* @return When dataset contents are created they are delivered to destinations specified here.
*/
public java.util.List getContentDeliveryRules() {
return contentDeliveryRules;
}
/**
*
* When dataset contents are created they are delivered to destinations specified here.
*
*
* @param contentDeliveryRules
* When dataset contents are created they are delivered to destinations specified here.
*/
public void setContentDeliveryRules(java.util.Collection contentDeliveryRules) {
if (contentDeliveryRules == null) {
this.contentDeliveryRules = null;
return;
}
this.contentDeliveryRules = new java.util.ArrayList(contentDeliveryRules);
}
/**
*
* When dataset contents are created they are delivered to destinations specified here.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setContentDeliveryRules(java.util.Collection)} or {@link #withContentDeliveryRules(java.util.Collection)}
* if you want to override the existing values.
*
*
* @param contentDeliveryRules
* When dataset contents are created they are delivered to destinations specified here.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Dataset withContentDeliveryRules(DatasetContentDeliveryRule... contentDeliveryRules) {
if (this.contentDeliveryRules == null) {
setContentDeliveryRules(new java.util.ArrayList(contentDeliveryRules.length));
}
for (DatasetContentDeliveryRule ele : contentDeliveryRules) {
this.contentDeliveryRules.add(ele);
}
return this;
}
/**
*
* When dataset contents are created they are delivered to destinations specified here.
*
*
* @param contentDeliveryRules
* When dataset contents are created they are delivered to destinations specified here.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Dataset withContentDeliveryRules(java.util.Collection contentDeliveryRules) {
setContentDeliveryRules(contentDeliveryRules);
return this;
}
/**
*
* The status of the dataset.
*
*
* @param status
* The status of the dataset.
* @see DatasetStatus
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The status of the dataset.
*
*
* @return The status of the dataset.
* @see DatasetStatus
*/
public String getStatus() {
return this.status;
}
/**
*
* The status of the dataset.
*
*
* @param status
* The status of the dataset.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DatasetStatus
*/
public Dataset withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* The status of the dataset.
*
*
* @param status
* The status of the dataset.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DatasetStatus
*/
public Dataset withStatus(DatasetStatus status) {
this.status = status.toString();
return this;
}
/**
*
* When the dataset was created.
*
*
* @param creationTime
* When the dataset was created.
*/
public void setCreationTime(java.util.Date creationTime) {
this.creationTime = creationTime;
}
/**
*
* When the dataset was created.
*
*
* @return When the dataset was created.
*/
public java.util.Date getCreationTime() {
return this.creationTime;
}
/**
*
* When the dataset was created.
*
*
* @param creationTime
* When the dataset was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Dataset withCreationTime(java.util.Date creationTime) {
setCreationTime(creationTime);
return this;
}
/**
*
* The last time the dataset was updated.
*
*
* @param lastUpdateTime
* The last time the dataset was updated.
*/
public void setLastUpdateTime(java.util.Date lastUpdateTime) {
this.lastUpdateTime = lastUpdateTime;
}
/**
*
* The last time the dataset was updated.
*
*
* @return The last time the dataset was updated.
*/
public java.util.Date getLastUpdateTime() {
return this.lastUpdateTime;
}
/**
*
* The last time the dataset was updated.
*
*
* @param lastUpdateTime
* The last time the dataset was updated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Dataset withLastUpdateTime(java.util.Date lastUpdateTime) {
setLastUpdateTime(lastUpdateTime);
return this;
}
/**
*
* Optional. How long, in days, message data is kept for the dataset.
*
*
* @param retentionPeriod
* Optional. How long, in days, message data is kept for the dataset.
*/
public void setRetentionPeriod(RetentionPeriod retentionPeriod) {
this.retentionPeriod = retentionPeriod;
}
/**
*
* Optional. How long, in days, message data is kept for the dataset.
*
*
* @return Optional. How long, in days, message data is kept for the dataset.
*/
public RetentionPeriod getRetentionPeriod() {
return this.retentionPeriod;
}
/**
*
* Optional. How long, in days, message data is kept for the dataset.
*
*
* @param retentionPeriod
* Optional. How long, in days, message data is kept for the dataset.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Dataset withRetentionPeriod(RetentionPeriod retentionPeriod) {
setRetentionPeriod(retentionPeriod);
return this;
}
/**
*
* Optional. How many versions of dataset contents are kept. If not specified or set to null, only the latest
* version plus the latest succeeded version (if they are different) are kept for the time period specified by the
* retentionPeriod parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.
*
*
* @param versioningConfiguration
* Optional. How many versions of dataset contents are kept. If not specified or set to null, only the latest
* version plus the latest succeeded version (if they are different) are kept for the time period specified
* by the retentionPeriod parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.
*/
public void setVersioningConfiguration(VersioningConfiguration versioningConfiguration) {
this.versioningConfiguration = versioningConfiguration;
}
/**
*
* Optional. How many versions of dataset contents are kept. If not specified or set to null, only the latest
* version plus the latest succeeded version (if they are different) are kept for the time period specified by the
* retentionPeriod parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.
*
*
* @return Optional. How many versions of dataset contents are kept. If not specified or set to null, only the
* latest version plus the latest succeeded version (if they are different) are kept for the time period
* specified by the retentionPeriod parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.
*/
public VersioningConfiguration getVersioningConfiguration() {
return this.versioningConfiguration;
}
/**
*
* Optional. How many versions of dataset contents are kept. If not specified or set to null, only the latest
* version plus the latest succeeded version (if they are different) are kept for the time period specified by the
* retentionPeriod parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.
*
*
* @param versioningConfiguration
* Optional. How many versions of dataset contents are kept. If not specified or set to null, only the latest
* version plus the latest succeeded version (if they are different) are kept for the time period specified
* by the retentionPeriod parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Dataset withVersioningConfiguration(VersioningConfiguration versioningConfiguration) {
setVersioningConfiguration(versioningConfiguration);
return this;
}
/**
*
* A list of data rules that send notifications to CloudWatch, when data arrives late. To specify
* lateDataRules, the dataset must use a DeltaTimer filter.
*
*
* @return A list of data rules that send notifications to CloudWatch, when data arrives late. To specify
* lateDataRules, the dataset must use a DeltaTimer
* filter.
*/
public java.util.List getLateDataRules() {
return lateDataRules;
}
/**
*
* A list of data rules that send notifications to CloudWatch, when data arrives late. To specify
* lateDataRules, the dataset must use a DeltaTimer filter.
*
*
* @param lateDataRules
* A list of data rules that send notifications to CloudWatch, when data arrives late. To specify
* lateDataRules, the dataset must use a DeltaTimer
* filter.
*/
public void setLateDataRules(java.util.Collection lateDataRules) {
if (lateDataRules == null) {
this.lateDataRules = null;
return;
}
this.lateDataRules = new java.util.ArrayList(lateDataRules);
}
/**
*
* A list of data rules that send notifications to CloudWatch, when data arrives late. To specify
* lateDataRules, the dataset must use a DeltaTimer filter.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setLateDataRules(java.util.Collection)} or {@link #withLateDataRules(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param lateDataRules
* A list of data rules that send notifications to CloudWatch, when data arrives late. To specify
* lateDataRules, the dataset must use a DeltaTimer
* filter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Dataset withLateDataRules(LateDataRule... lateDataRules) {
if (this.lateDataRules == null) {
setLateDataRules(new java.util.ArrayList(lateDataRules.length));
}
for (LateDataRule ele : lateDataRules) {
this.lateDataRules.add(ele);
}
return this;
}
/**
*
* A list of data rules that send notifications to CloudWatch, when data arrives late. To specify
* lateDataRules, the dataset must use a DeltaTimer filter.
*
*
* @param lateDataRules
* A list of data rules that send notifications to CloudWatch, when data arrives late. To specify
* lateDataRules, the dataset must use a DeltaTimer
* filter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Dataset withLateDataRules(java.util.Collection lateDataRules) {
setLateDataRules(lateDataRules);
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 (getArn() != null)
sb.append("Arn: ").append(getArn()).append(",");
if (getActions() != null)
sb.append("Actions: ").append(getActions()).append(",");
if (getTriggers() != null)
sb.append("Triggers: ").append(getTriggers()).append(",");
if (getContentDeliveryRules() != null)
sb.append("ContentDeliveryRules: ").append(getContentDeliveryRules()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getCreationTime() != null)
sb.append("CreationTime: ").append(getCreationTime()).append(",");
if (getLastUpdateTime() != null)
sb.append("LastUpdateTime: ").append(getLastUpdateTime()).append(",");
if (getRetentionPeriod() != null)
sb.append("RetentionPeriod: ").append(getRetentionPeriod()).append(",");
if (getVersioningConfiguration() != null)
sb.append("VersioningConfiguration: ").append(getVersioningConfiguration()).append(",");
if (getLateDataRules() != null)
sb.append("LateDataRules: ").append(getLateDataRules());
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.getArn() == null ^ this.getArn() == null)
return false;
if (other.getArn() != null && other.getArn().equals(this.getArn()) == false)
return false;
if (other.getActions() == null ^ this.getActions() == null)
return false;
if (other.getActions() != null && other.getActions().equals(this.getActions()) == false)
return false;
if (other.getTriggers() == null ^ this.getTriggers() == null)
return false;
if (other.getTriggers() != null && other.getTriggers().equals(this.getTriggers()) == false)
return false;
if (other.getContentDeliveryRules() == null ^ this.getContentDeliveryRules() == null)
return false;
if (other.getContentDeliveryRules() != null && other.getContentDeliveryRules().equals(this.getContentDeliveryRules()) == 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.getCreationTime() == null ^ this.getCreationTime() == null)
return false;
if (other.getCreationTime() != null && other.getCreationTime().equals(this.getCreationTime()) == false)
return false;
if (other.getLastUpdateTime() == null ^ this.getLastUpdateTime() == null)
return false;
if (other.getLastUpdateTime() != null && other.getLastUpdateTime().equals(this.getLastUpdateTime()) == false)
return false;
if (other.getRetentionPeriod() == null ^ this.getRetentionPeriod() == null)
return false;
if (other.getRetentionPeriod() != null && other.getRetentionPeriod().equals(this.getRetentionPeriod()) == false)
return false;
if (other.getVersioningConfiguration() == null ^ this.getVersioningConfiguration() == null)
return false;
if (other.getVersioningConfiguration() != null && other.getVersioningConfiguration().equals(this.getVersioningConfiguration()) == false)
return false;
if (other.getLateDataRules() == null ^ this.getLateDataRules() == null)
return false;
if (other.getLateDataRules() != null && other.getLateDataRules().equals(this.getLateDataRules()) == 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 + ((getArn() == null) ? 0 : getArn().hashCode());
hashCode = prime * hashCode + ((getActions() == null) ? 0 : getActions().hashCode());
hashCode = prime * hashCode + ((getTriggers() == null) ? 0 : getTriggers().hashCode());
hashCode = prime * hashCode + ((getContentDeliveryRules() == null) ? 0 : getContentDeliveryRules().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getCreationTime() == null) ? 0 : getCreationTime().hashCode());
hashCode = prime * hashCode + ((getLastUpdateTime() == null) ? 0 : getLastUpdateTime().hashCode());
hashCode = prime * hashCode + ((getRetentionPeriod() == null) ? 0 : getRetentionPeriod().hashCode());
hashCode = prime * hashCode + ((getVersioningConfiguration() == null) ? 0 : getVersioningConfiguration().hashCode());
hashCode = prime * hashCode + ((getLateDataRules() == null) ? 0 : getLateDataRules().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.iotanalytics.model.transform.DatasetMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}