com.amazonaws.services.lookoutequipment.model.DataPreProcessingConfiguration Maven / Gradle / Ivy
Show all versions of aws-java-sdk-lookoutequipment 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.lookoutequipment.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The configuration is the TargetSamplingRate
, which is the sampling rate of the data after post
* processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected at a 1 second
* level and you want the system to resample the data at a 1 minute rate before training, the
* TargetSamplingRate
is 1 minute.
*
*
* When providing a value for the TargetSamplingRate
, you must attach the prefix "PT" to the rate you want.
* The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is PT15M, and the value
* for a 1 hour rate is PT1H
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DataPreProcessingConfiguration implements Serializable, Cloneable, StructuredPojo {
/**
*
* The sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you provide
* data that has been collected at a 1 second level and you want the system to resample the data at a 1 minute rate
* before training, the TargetSamplingRate
is 1 minute.
*
*
* When providing a value for the TargetSamplingRate
, you must attach the prefix "PT" to the rate you
* want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is PT15M, and
* the value for a 1 hour rate is PT1H
*
*/
private String targetSamplingRate;
/**
*
* The sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you provide
* data that has been collected at a 1 second level and you want the system to resample the data at a 1 minute rate
* before training, the TargetSamplingRate
is 1 minute.
*
*
* When providing a value for the TargetSamplingRate
, you must attach the prefix "PT" to the rate you
* want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is PT15M, and
* the value for a 1 hour rate is PT1H
*
*
* @param targetSamplingRate
* The sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you
* provide data that has been collected at a 1 second level and you want the system to resample the data at a
* 1 minute rate before training, the TargetSamplingRate
is 1 minute.
*
* When providing a value for the TargetSamplingRate
, you must attach the prefix "PT" to the
* rate you want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is
* PT15M, and the value for a 1 hour rate is PT1H
* @see TargetSamplingRate
*/
public void setTargetSamplingRate(String targetSamplingRate) {
this.targetSamplingRate = targetSamplingRate;
}
/**
*
* The sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you provide
* data that has been collected at a 1 second level and you want the system to resample the data at a 1 minute rate
* before training, the TargetSamplingRate
is 1 minute.
*
*
* When providing a value for the TargetSamplingRate
, you must attach the prefix "PT" to the rate you
* want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is PT15M, and
* the value for a 1 hour rate is PT1H
*
*
* @return The sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you
* provide data that has been collected at a 1 second level and you want the system to resample the data at
* a 1 minute rate before training, the TargetSamplingRate
is 1 minute.
*
* When providing a value for the TargetSamplingRate
, you must attach the prefix "PT" to the
* rate you want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is
* PT15M, and the value for a 1 hour rate is PT1H
* @see TargetSamplingRate
*/
public String getTargetSamplingRate() {
return this.targetSamplingRate;
}
/**
*
* The sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you provide
* data that has been collected at a 1 second level and you want the system to resample the data at a 1 minute rate
* before training, the TargetSamplingRate
is 1 minute.
*
*
* When providing a value for the TargetSamplingRate
, you must attach the prefix "PT" to the rate you
* want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is PT15M, and
* the value for a 1 hour rate is PT1H
*
*
* @param targetSamplingRate
* The sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you
* provide data that has been collected at a 1 second level and you want the system to resample the data at a
* 1 minute rate before training, the TargetSamplingRate
is 1 minute.
*
* When providing a value for the TargetSamplingRate
, you must attach the prefix "PT" to the
* rate you want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is
* PT15M, and the value for a 1 hour rate is PT1H
* @return Returns a reference to this object so that method calls can be chained together.
* @see TargetSamplingRate
*/
public DataPreProcessingConfiguration withTargetSamplingRate(String targetSamplingRate) {
setTargetSamplingRate(targetSamplingRate);
return this;
}
/**
*
* The sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you provide
* data that has been collected at a 1 second level and you want the system to resample the data at a 1 minute rate
* before training, the TargetSamplingRate
is 1 minute.
*
*
* When providing a value for the TargetSamplingRate
, you must attach the prefix "PT" to the rate you
* want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is PT15M, and
* the value for a 1 hour rate is PT1H
*
*
* @param targetSamplingRate
* The sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you
* provide data that has been collected at a 1 second level and you want the system to resample the data at a
* 1 minute rate before training, the TargetSamplingRate
is 1 minute.
*
* When providing a value for the TargetSamplingRate
, you must attach the prefix "PT" to the
* rate you want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is
* PT15M, and the value for a 1 hour rate is PT1H
* @return Returns a reference to this object so that method calls can be chained together.
* @see TargetSamplingRate
*/
public DataPreProcessingConfiguration withTargetSamplingRate(TargetSamplingRate targetSamplingRate) {
this.targetSamplingRate = targetSamplingRate.toString();
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 (getTargetSamplingRate() != null)
sb.append("TargetSamplingRate: ").append(getTargetSamplingRate());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DataPreProcessingConfiguration == false)
return false;
DataPreProcessingConfiguration other = (DataPreProcessingConfiguration) obj;
if (other.getTargetSamplingRate() == null ^ this.getTargetSamplingRate() == null)
return false;
if (other.getTargetSamplingRate() != null && other.getTargetSamplingRate().equals(this.getTargetSamplingRate()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getTargetSamplingRate() == null) ? 0 : getTargetSamplingRate().hashCode());
return hashCode;
}
@Override
public DataPreProcessingConfiguration clone() {
try {
return (DataPreProcessingConfiguration) 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.lookoutequipment.model.transform.DataPreProcessingConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}