com.amazonaws.services.sagemaker.model.VariantProperty Maven / Gradle / Ivy
Show all versions of aws-java-sdk-sagemaker 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.sagemaker.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Specifies a production variant property type for an Endpoint.
*
*
* If you are updating an endpoint with the RetainAllVariantProperties option of UpdateEndpointInput set
* to true, the VariantProperty objects listed in the
* ExcludeRetainedVariantProperties parameter of UpdateEndpointInput
* override the existing variant properties of the endpoint.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class VariantProperty implements Serializable, Cloneable, StructuredPojo {
/**
*
* The type of variant property. The supported values are:
*
*
* -
*
* DesiredInstanceCount: Overrides the existing variant instance counts using the
* InitialInstanceCount values in the ProductionVariants of CreateEndpointConfig.
*
*
* -
*
* DesiredWeight: Overrides the existing variant weights using the InitialVariantWeight
* values in the ProductionVariants of CreateEndpointConfig.
*
*
* -
*
* DataCaptureConfig: (Not currently supported.)
*
*
*
*/
private String variantPropertyType;
/**
*
* The type of variant property. The supported values are:
*
*
* -
*
* DesiredInstanceCount: Overrides the existing variant instance counts using the
* InitialInstanceCount values in the ProductionVariants of CreateEndpointConfig.
*
*
* -
*
* DesiredWeight: Overrides the existing variant weights using the InitialVariantWeight
* values in the ProductionVariants of CreateEndpointConfig.
*
*
* -
*
* DataCaptureConfig: (Not currently supported.)
*
*
*
*
* @param variantPropertyType
* The type of variant property. The supported values are:
*
* -
*
* DesiredInstanceCount: Overrides the existing variant instance counts using the
* InitialInstanceCount values in the ProductionVariants of CreateEndpointConfig.
*
*
* -
*
* DesiredWeight: Overrides the existing variant weights using the
* InitialVariantWeight values in the ProductionVariants of CreateEndpointConfig.
*
*
* -
*
* DataCaptureConfig: (Not currently supported.)
*
*
* @see VariantPropertyType
*/
public void setVariantPropertyType(String variantPropertyType) {
this.variantPropertyType = variantPropertyType;
}
/**
*
* The type of variant property. The supported values are:
*
*
* -
*
* DesiredInstanceCount: Overrides the existing variant instance counts using the
* InitialInstanceCount values in the ProductionVariants of CreateEndpointConfig.
*
*
* -
*
* DesiredWeight: Overrides the existing variant weights using the InitialVariantWeight
* values in the ProductionVariants of CreateEndpointConfig.
*
*
* -
*
* DataCaptureConfig: (Not currently supported.)
*
*
*
*
* @return The type of variant property. The supported values are:
*
* -
*
* DesiredInstanceCount: Overrides the existing variant instance counts using the
* InitialInstanceCount values in the ProductionVariants of CreateEndpointConfig.
*
*
* -
*
* DesiredWeight: Overrides the existing variant weights using the
* InitialVariantWeight values in the ProductionVariants of CreateEndpointConfig.
*
*
* -
*
* DataCaptureConfig: (Not currently supported.)
*
*
* @see VariantPropertyType
*/
public String getVariantPropertyType() {
return this.variantPropertyType;
}
/**
*
* The type of variant property. The supported values are:
*
*
* -
*
* DesiredInstanceCount: Overrides the existing variant instance counts using the
* InitialInstanceCount values in the ProductionVariants of CreateEndpointConfig.
*
*
* -
*
* DesiredWeight: Overrides the existing variant weights using the InitialVariantWeight
* values in the ProductionVariants of CreateEndpointConfig.
*
*
* -
*
* DataCaptureConfig: (Not currently supported.)
*
*
*
*
* @param variantPropertyType
* The type of variant property. The supported values are:
*
* -
*
* DesiredInstanceCount: Overrides the existing variant instance counts using the
* InitialInstanceCount values in the ProductionVariants of CreateEndpointConfig.
*
*
* -
*
* DesiredWeight: Overrides the existing variant weights using the
* InitialVariantWeight values in the ProductionVariants of CreateEndpointConfig.
*
*
* -
*
* DataCaptureConfig: (Not currently supported.)
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see VariantPropertyType
*/
public VariantProperty withVariantPropertyType(String variantPropertyType) {
setVariantPropertyType(variantPropertyType);
return this;
}
/**
*
* The type of variant property. The supported values are:
*
*
* -
*
* DesiredInstanceCount: Overrides the existing variant instance counts using the
* InitialInstanceCount values in the ProductionVariants of CreateEndpointConfig.
*
*
* -
*
* DesiredWeight: Overrides the existing variant weights using the InitialVariantWeight
* values in the ProductionVariants of CreateEndpointConfig.
*
*
* -
*
* DataCaptureConfig: (Not currently supported.)
*
*
*
*
* @param variantPropertyType
* The type of variant property. The supported values are:
*
* -
*
* DesiredInstanceCount: Overrides the existing variant instance counts using the
* InitialInstanceCount values in the ProductionVariants of CreateEndpointConfig.
*
*
* -
*
* DesiredWeight: Overrides the existing variant weights using the
* InitialVariantWeight values in the ProductionVariants of CreateEndpointConfig.
*
*
* -
*
* DataCaptureConfig: (Not currently supported.)
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see VariantPropertyType
*/
public VariantProperty withVariantPropertyType(VariantPropertyType variantPropertyType) {
this.variantPropertyType = variantPropertyType.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 (getVariantPropertyType() != null)
sb.append("VariantPropertyType: ").append(getVariantPropertyType());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof VariantProperty == false)
return false;
VariantProperty other = (VariantProperty) obj;
if (other.getVariantPropertyType() == null ^ this.getVariantPropertyType() == null)
return false;
if (other.getVariantPropertyType() != null && other.getVariantPropertyType().equals(this.getVariantPropertyType()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getVariantPropertyType() == null) ? 0 : getVariantPropertyType().hashCode());
return hashCode;
}
@Override
public VariantProperty clone() {
try {
return (VariantProperty) 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.VariantPropertyMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}