com.amazonaws.services.sagemaker.model.CapacitySize 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;
/**
*
* Specifies the type and size of the endpoint capacity to activate for a blue/green deployment, a rolling deployment,
* or a rollback strategy. You can specify your batches as either instance count or the overall percentage or your
* fleet.
*
*
* For a rollback strategy, if you don't specify the fields in this object, or if you set the Value to
* 100%, then SageMaker uses a blue/green rollback strategy and rolls all traffic back to the blue fleet.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CapacitySize implements Serializable, Cloneable, StructuredPojo {
/**
*
* Specifies the endpoint capacity type.
*
*
* -
*
* INSTANCE_COUNT: The endpoint activates based on the number of instances.
*
*
* -
*
* CAPACITY_PERCENT: The endpoint activates based on the specified percentage of capacity.
*
*
*
*/
private String type;
/**
*
* Defines the capacity size, either as a number of instances or a capacity percentage.
*
*/
private Integer value;
/**
*
* Specifies the endpoint capacity type.
*
*
* -
*
* INSTANCE_COUNT: The endpoint activates based on the number of instances.
*
*
* -
*
* CAPACITY_PERCENT: The endpoint activates based on the specified percentage of capacity.
*
*
*
*
* @param type
* Specifies the endpoint capacity type.
*
* -
*
* INSTANCE_COUNT: The endpoint activates based on the number of instances.
*
*
* -
*
* CAPACITY_PERCENT: The endpoint activates based on the specified percentage of capacity.
*
*
* @see CapacitySizeType
*/
public void setType(String type) {
this.type = type;
}
/**
*
* Specifies the endpoint capacity type.
*
*
* -
*
* INSTANCE_COUNT: The endpoint activates based on the number of instances.
*
*
* -
*
* CAPACITY_PERCENT: The endpoint activates based on the specified percentage of capacity.
*
*
*
*
* @return Specifies the endpoint capacity type.
*
* -
*
* INSTANCE_COUNT: The endpoint activates based on the number of instances.
*
*
* -
*
* CAPACITY_PERCENT: The endpoint activates based on the specified percentage of capacity.
*
*
* @see CapacitySizeType
*/
public String getType() {
return this.type;
}
/**
*
* Specifies the endpoint capacity type.
*
*
* -
*
* INSTANCE_COUNT: The endpoint activates based on the number of instances.
*
*
* -
*
* CAPACITY_PERCENT: The endpoint activates based on the specified percentage of capacity.
*
*
*
*
* @param type
* Specifies the endpoint capacity type.
*
* -
*
* INSTANCE_COUNT: The endpoint activates based on the number of instances.
*
*
* -
*
* CAPACITY_PERCENT: The endpoint activates based on the specified percentage of capacity.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see CapacitySizeType
*/
public CapacitySize withType(String type) {
setType(type);
return this;
}
/**
*
* Specifies the endpoint capacity type.
*
*
* -
*
* INSTANCE_COUNT: The endpoint activates based on the number of instances.
*
*
* -
*
* CAPACITY_PERCENT: The endpoint activates based on the specified percentage of capacity.
*
*
*
*
* @param type
* Specifies the endpoint capacity type.
*
* -
*
* INSTANCE_COUNT: The endpoint activates based on the number of instances.
*
*
* -
*
* CAPACITY_PERCENT: The endpoint activates based on the specified percentage of capacity.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see CapacitySizeType
*/
public CapacitySize withType(CapacitySizeType type) {
this.type = type.toString();
return this;
}
/**
*
* Defines the capacity size, either as a number of instances or a capacity percentage.
*
*
* @param value
* Defines the capacity size, either as a number of instances or a capacity percentage.
*/
public void setValue(Integer value) {
this.value = value;
}
/**
*
* Defines the capacity size, either as a number of instances or a capacity percentage.
*
*
* @return Defines the capacity size, either as a number of instances or a capacity percentage.
*/
public Integer getValue() {
return this.value;
}
/**
*
* Defines the capacity size, either as a number of instances or a capacity percentage.
*
*
* @param value
* Defines the capacity size, either as a number of instances or a capacity percentage.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CapacitySize withValue(Integer value) {
setValue(value);
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 (getType() != null)
sb.append("Type: ").append(getType()).append(",");
if (getValue() != null)
sb.append("Value: ").append(getValue());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CapacitySize == false)
return false;
CapacitySize other = (CapacitySize) obj;
if (other.getType() == null ^ this.getType() == null)
return false;
if (other.getType() != null && other.getType().equals(this.getType()) == false)
return false;
if (other.getValue() == null ^ this.getValue() == null)
return false;
if (other.getValue() != null && other.getValue().equals(this.getValue()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
hashCode = prime * hashCode + ((getValue() == null) ? 0 : getValue().hashCode());
return hashCode;
}
@Override
public CapacitySize clone() {
try {
return (CapacitySize) 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.CapacitySizeMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}