com.amazonaws.services.sagemaker.model.OnlineStoreConfig Maven / Gradle / Ivy
/*
* 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.sagemaker.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, or KMSKeyId, for at
* rest data encryption. You can turn OnlineStore on or off by specifying the
* EnableOnlineStore flag at General Assembly.
*
*
* The default value is False.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class OnlineStoreConfig implements Serializable, Cloneable, StructuredPojo {
/**
*
* Use to specify KMS Key ID (KMSKeyId) for at-rest encryption of your OnlineStore.
*
*/
private OnlineStoreSecurityConfig securityConfig;
/**
*
* Turn OnlineStore off by specifying False for the EnableOnlineStore flag.
* Turn OnlineStore on by specifying True for the EnableOnlineStore flag.
*
*
* The default value is False.
*
*/
private Boolean enableOnlineStore;
/**
*
* Time to live duration, where the record is hard deleted after the expiration time is reached;
* ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see
* the
* DeleteRecord API in the Amazon SageMaker API Reference guide.
*
*/
private TtlDuration ttlDuration;
/**
*
* Option for different tiers of low latency storage for real-time data retrieval.
*
*
* -
*
* Standard: A managed low latency data store for feature groups.
*
*
* -
*
* InMemory: A managed data store for feature groups that supports very low latency retrieval.
*
*
*
*/
private String storageType;
/**
*
* Use to specify KMS Key ID (KMSKeyId) for at-rest encryption of your OnlineStore.
*
*
* @param securityConfig
* Use to specify KMS Key ID (KMSKeyId) for at-rest encryption of your OnlineStore.
*/
public void setSecurityConfig(OnlineStoreSecurityConfig securityConfig) {
this.securityConfig = securityConfig;
}
/**
*
* Use to specify KMS Key ID (KMSKeyId) for at-rest encryption of your OnlineStore.
*
*
* @return Use to specify KMS Key ID (KMSKeyId) for at-rest encryption of your OnlineStore
* .
*/
public OnlineStoreSecurityConfig getSecurityConfig() {
return this.securityConfig;
}
/**
*
* Use to specify KMS Key ID (KMSKeyId) for at-rest encryption of your OnlineStore.
*
*
* @param securityConfig
* Use to specify KMS Key ID (KMSKeyId) for at-rest encryption of your OnlineStore.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OnlineStoreConfig withSecurityConfig(OnlineStoreSecurityConfig securityConfig) {
setSecurityConfig(securityConfig);
return this;
}
/**
*
* Turn OnlineStore off by specifying False for the EnableOnlineStore flag.
* Turn OnlineStore on by specifying True for the EnableOnlineStore flag.
*
*
* The default value is False.
*
*
* @param enableOnlineStore
* Turn OnlineStore off by specifying False for the EnableOnlineStore
* flag. Turn OnlineStore on by specifying True for the
* EnableOnlineStore flag.
*
* The default value is False.
*/
public void setEnableOnlineStore(Boolean enableOnlineStore) {
this.enableOnlineStore = enableOnlineStore;
}
/**
*
* Turn OnlineStore off by specifying False for the EnableOnlineStore flag.
* Turn OnlineStore on by specifying True for the EnableOnlineStore flag.
*
*
* The default value is False.
*
*
* @return Turn OnlineStore off by specifying False for the EnableOnlineStore
* flag. Turn OnlineStore on by specifying True for the
* EnableOnlineStore flag.
*
* The default value is False.
*/
public Boolean getEnableOnlineStore() {
return this.enableOnlineStore;
}
/**
*
* Turn OnlineStore off by specifying False for the EnableOnlineStore flag.
* Turn OnlineStore on by specifying True for the EnableOnlineStore flag.
*
*
* The default value is False.
*
*
* @param enableOnlineStore
* Turn OnlineStore off by specifying False for the EnableOnlineStore
* flag. Turn OnlineStore on by specifying True for the
* EnableOnlineStore flag.
*
* The default value is False.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OnlineStoreConfig withEnableOnlineStore(Boolean enableOnlineStore) {
setEnableOnlineStore(enableOnlineStore);
return this;
}
/**
*
* Turn OnlineStore off by specifying False for the EnableOnlineStore flag.
* Turn OnlineStore on by specifying True for the EnableOnlineStore flag.
*
*
* The default value is False.
*
*
* @return Turn OnlineStore off by specifying False for the EnableOnlineStore
* flag. Turn OnlineStore on by specifying True for the
* EnableOnlineStore flag.
*
* The default value is False.
*/
public Boolean isEnableOnlineStore() {
return this.enableOnlineStore;
}
/**
*
* Time to live duration, where the record is hard deleted after the expiration time is reached;
* ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see
* the
* DeleteRecord API in the Amazon SageMaker API Reference guide.
*
*
* @param ttlDuration
* Time to live duration, where the record is hard deleted after the expiration time is reached;
* ExpiresAt = EventTime + TtlDuration. For information on HardDelete,
* see the DeleteRecord API in the Amazon SageMaker API Reference guide.
*/
public void setTtlDuration(TtlDuration ttlDuration) {
this.ttlDuration = ttlDuration;
}
/**
*
* Time to live duration, where the record is hard deleted after the expiration time is reached;
* ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see
* the
* DeleteRecord API in the Amazon SageMaker API Reference guide.
*
*
* @return Time to live duration, where the record is hard deleted after the expiration time is reached;
* ExpiresAt = EventTime + TtlDuration. For information on
* HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
*/
public TtlDuration getTtlDuration() {
return this.ttlDuration;
}
/**
*
* Time to live duration, where the record is hard deleted after the expiration time is reached;
* ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see
* the
* DeleteRecord API in the Amazon SageMaker API Reference guide.
*
*
* @param ttlDuration
* Time to live duration, where the record is hard deleted after the expiration time is reached;
* ExpiresAt = EventTime + TtlDuration. For information on HardDelete,
* see the DeleteRecord API in the Amazon SageMaker API Reference guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OnlineStoreConfig withTtlDuration(TtlDuration ttlDuration) {
setTtlDuration(ttlDuration);
return this;
}
/**
*
* Option for different tiers of low latency storage for real-time data retrieval.
*
*
* -
*
* Standard: A managed low latency data store for feature groups.
*
*
* -
*
* InMemory: A managed data store for feature groups that supports very low latency retrieval.
*
*
*
*
* @param storageType
* Option for different tiers of low latency storage for real-time data retrieval.
*
* -
*
* Standard: A managed low latency data store for feature groups.
*
*
* -
*
* InMemory: A managed data store for feature groups that supports very low latency retrieval.
*
*
* @see StorageType
*/
public void setStorageType(String storageType) {
this.storageType = storageType;
}
/**
*
* Option for different tiers of low latency storage for real-time data retrieval.
*
*
* -
*
* Standard: A managed low latency data store for feature groups.
*
*
* -
*
* InMemory: A managed data store for feature groups that supports very low latency retrieval.
*
*
*
*
* @return Option for different tiers of low latency storage for real-time data retrieval.
*
* -
*
* Standard: A managed low latency data store for feature groups.
*
*
* -
*
* InMemory: A managed data store for feature groups that supports very low latency retrieval.
*
*
* @see StorageType
*/
public String getStorageType() {
return this.storageType;
}
/**
*
* Option for different tiers of low latency storage for real-time data retrieval.
*
*
* -
*
* Standard: A managed low latency data store for feature groups.
*
*
* -
*
* InMemory: A managed data store for feature groups that supports very low latency retrieval.
*
*
*
*
* @param storageType
* Option for different tiers of low latency storage for real-time data retrieval.
*
* -
*
* Standard: A managed low latency data store for feature groups.
*
*
* -
*
* InMemory: A managed data store for feature groups that supports very low latency retrieval.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see StorageType
*/
public OnlineStoreConfig withStorageType(String storageType) {
setStorageType(storageType);
return this;
}
/**
*
* Option for different tiers of low latency storage for real-time data retrieval.
*
*
* -
*
* Standard: A managed low latency data store for feature groups.
*
*
* -
*
* InMemory: A managed data store for feature groups that supports very low latency retrieval.
*
*
*
*
* @param storageType
* Option for different tiers of low latency storage for real-time data retrieval.
*
* -
*
* Standard: A managed low latency data store for feature groups.
*
*
* -
*
* InMemory: A managed data store for feature groups that supports very low latency retrieval.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see StorageType
*/
public OnlineStoreConfig withStorageType(StorageType storageType) {
this.storageType = storageType.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 (getSecurityConfig() != null)
sb.append("SecurityConfig: ").append(getSecurityConfig()).append(",");
if (getEnableOnlineStore() != null)
sb.append("EnableOnlineStore: ").append(getEnableOnlineStore()).append(",");
if (getTtlDuration() != null)
sb.append("TtlDuration: ").append(getTtlDuration()).append(",");
if (getStorageType() != null)
sb.append("StorageType: ").append(getStorageType());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof OnlineStoreConfig == false)
return false;
OnlineStoreConfig other = (OnlineStoreConfig) obj;
if (other.getSecurityConfig() == null ^ this.getSecurityConfig() == null)
return false;
if (other.getSecurityConfig() != null && other.getSecurityConfig().equals(this.getSecurityConfig()) == false)
return false;
if (other.getEnableOnlineStore() == null ^ this.getEnableOnlineStore() == null)
return false;
if (other.getEnableOnlineStore() != null && other.getEnableOnlineStore().equals(this.getEnableOnlineStore()) == false)
return false;
if (other.getTtlDuration() == null ^ this.getTtlDuration() == null)
return false;
if (other.getTtlDuration() != null && other.getTtlDuration().equals(this.getTtlDuration()) == false)
return false;
if (other.getStorageType() == null ^ this.getStorageType() == null)
return false;
if (other.getStorageType() != null && other.getStorageType().equals(this.getStorageType()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getSecurityConfig() == null) ? 0 : getSecurityConfig().hashCode());
hashCode = prime * hashCode + ((getEnableOnlineStore() == null) ? 0 : getEnableOnlineStore().hashCode());
hashCode = prime * hashCode + ((getTtlDuration() == null) ? 0 : getTtlDuration().hashCode());
hashCode = prime * hashCode + ((getStorageType() == null) ? 0 : getStorageType().hashCode());
return hashCode;
}
@Override
public OnlineStoreConfig clone() {
try {
return (OnlineStoreConfig) 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.sagemaker.model.transform.OnlineStoreConfigMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}