software.amazon.awssdk.services.codedeploy.model.MinimumHealthyHosts Maven / Gradle / Ivy
Show all versions of codedeploy Show documentation
/*
* Copyright 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 software.amazon.awssdk.services.codedeploy.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Information about the minimum number of healthy instances.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class MinimumHealthyHosts implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField TYPE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("type")
.getter(getter(MinimumHealthyHosts::typeAsString)).setter(setter(Builder::type))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("type").build()).build();
private static final SdkField VALUE_FIELD = SdkField. builder(MarshallingType.INTEGER).memberName("value")
.getter(getter(MinimumHealthyHosts::value)).setter(setter(Builder::value))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("value").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TYPE_FIELD, VALUE_FIELD));
private static final long serialVersionUID = 1L;
private final String type;
private final Integer value;
private MinimumHealthyHosts(BuilderImpl builder) {
this.type = builder.type;
this.value = builder.value;
}
/**
*
* The minimum healthy instance type:
*
*
* -
*
* HOST_COUNT: The minimum number of healthy instances as an absolute value.
*
*
* -
*
* FLEET_PERCENT: The minimum number of healthy instances as a percentage of the total number of
* instances in the deployment.
*
*
*
*
* In an example of nine instances, if a HOST_COUNT of six is specified, deploy to up to three instances at a time.
* The deployment is successful if six or more instances are deployed to successfully. Otherwise, the deployment
* fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five instances at a time. The deployment is
* successful if four or more instances are deployed to successfully. Otherwise, the deployment fails.
*
*
*
* In a call to the GetDeploymentConfig, CodeDeployDefault.OneAtATime returns a minimum healthy
* instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one instance at a time. (You
* cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.) In addition, with
* CodeDeployDefault.OneAtATime, CodeDeploy attempts to ensure that all instances but one are kept in a healthy
* state during the deployment. Although this allows one instance at a time to be taken offline for a new
* deployment, it also means that if the deployment to the last instance fails, the overall deployment is still
* successful.
*
*
*
* For more information, see CodeDeploy Instance
* Health in the CodeDeploy User Guide.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link MinimumHealthyHostsType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return The minimum healthy instance type:
*
* -
*
* HOST_COUNT: The minimum number of healthy instances as an absolute value.
*
*
* -
*
* FLEET_PERCENT: The minimum number of healthy instances as a percentage of the total number
* of instances in the deployment.
*
*
*
*
* In an example of nine instances, if a HOST_COUNT of six is specified, deploy to up to three instances at
* a time. The deployment is successful if six or more instances are deployed to successfully. Otherwise,
* the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five instances at a time.
* The deployment is successful if four or more instances are deployed to successfully. Otherwise, the
* deployment fails.
*
*
*
* In a call to the GetDeploymentConfig, CodeDeployDefault.OneAtATime returns a minimum healthy
* instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one instance at a
* time. (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.) In addition,
* with CodeDeployDefault.OneAtATime, CodeDeploy attempts to ensure that all instances but one are kept in a
* healthy state during the deployment. Although this allows one instance at a time to be taken offline for
* a new deployment, it also means that if the deployment to the last instance fails, the overall deployment
* is still successful.
*
*
*
* For more information, see CodeDeploy Instance
* Health in the CodeDeploy User Guide.
* @see MinimumHealthyHostsType
*/
public final MinimumHealthyHostsType type() {
return MinimumHealthyHostsType.fromValue(type);
}
/**
*
* The minimum healthy instance type:
*
*
* -
*
* HOST_COUNT: The minimum number of healthy instances as an absolute value.
*
*
* -
*
* FLEET_PERCENT: The minimum number of healthy instances as a percentage of the total number of
* instances in the deployment.
*
*
*
*
* In an example of nine instances, if a HOST_COUNT of six is specified, deploy to up to three instances at a time.
* The deployment is successful if six or more instances are deployed to successfully. Otherwise, the deployment
* fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five instances at a time. The deployment is
* successful if four or more instances are deployed to successfully. Otherwise, the deployment fails.
*
*
*
* In a call to the GetDeploymentConfig, CodeDeployDefault.OneAtATime returns a minimum healthy
* instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one instance at a time. (You
* cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.) In addition, with
* CodeDeployDefault.OneAtATime, CodeDeploy attempts to ensure that all instances but one are kept in a healthy
* state during the deployment. Although this allows one instance at a time to be taken offline for a new
* deployment, it also means that if the deployment to the last instance fails, the overall deployment is still
* successful.
*
*
*
* For more information, see CodeDeploy Instance
* Health in the CodeDeploy User Guide.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link MinimumHealthyHostsType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return The minimum healthy instance type:
*
* -
*
* HOST_COUNT: The minimum number of healthy instances as an absolute value.
*
*
* -
*
* FLEET_PERCENT: The minimum number of healthy instances as a percentage of the total number
* of instances in the deployment.
*
*
*
*
* In an example of nine instances, if a HOST_COUNT of six is specified, deploy to up to three instances at
* a time. The deployment is successful if six or more instances are deployed to successfully. Otherwise,
* the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five instances at a time.
* The deployment is successful if four or more instances are deployed to successfully. Otherwise, the
* deployment fails.
*
*
*
* In a call to the GetDeploymentConfig, CodeDeployDefault.OneAtATime returns a minimum healthy
* instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one instance at a
* time. (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.) In addition,
* with CodeDeployDefault.OneAtATime, CodeDeploy attempts to ensure that all instances but one are kept in a
* healthy state during the deployment. Although this allows one instance at a time to be taken offline for
* a new deployment, it also means that if the deployment to the last instance fails, the overall deployment
* is still successful.
*
*
*
* For more information, see CodeDeploy Instance
* Health in the CodeDeploy User Guide.
* @see MinimumHealthyHostsType
*/
public final String typeAsString() {
return type;
}
/**
*
* The minimum healthy instance value.
*
*
* @return The minimum healthy instance value.
*/
public final Integer value() {
return value;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(typeAsString());
hashCode = 31 * hashCode + Objects.hashCode(value());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof MinimumHealthyHosts)) {
return false;
}
MinimumHealthyHosts other = (MinimumHealthyHosts) obj;
return Objects.equals(typeAsString(), other.typeAsString()) && Objects.equals(value(), other.value());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("MinimumHealthyHosts").add("Type", typeAsString()).add("Value", value()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "type":
return Optional.ofNullable(clazz.cast(typeAsString()));
case "value":
return Optional.ofNullable(clazz.cast(value()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((MinimumHealthyHosts) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The minimum healthy instance type:
*
*
* -
*
* HOST_COUNT: The minimum number of healthy instances as an absolute value.
*
*
* -
*
* FLEET_PERCENT: The minimum number of healthy instances as a percentage of the total number of
* instances in the deployment.
*
*
*
*
* In an example of nine instances, if a HOST_COUNT of six is specified, deploy to up to three instances at a
* time. The deployment is successful if six or more instances are deployed to successfully. Otherwise, the
* deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five instances at a time. The
* deployment is successful if four or more instances are deployed to successfully. Otherwise, the deployment
* fails.
*
*
*
* In a call to the GetDeploymentConfig, CodeDeployDefault.OneAtATime returns a minimum healthy
* instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one instance at a time.
* (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.) In addition, with
* CodeDeployDefault.OneAtATime, CodeDeploy attempts to ensure that all instances but one are kept in a healthy
* state during the deployment. Although this allows one instance at a time to be taken offline for a new
* deployment, it also means that if the deployment to the last instance fails, the overall deployment is still
* successful.
*
*
*
* For more information, see CodeDeploy Instance
* Health in the CodeDeploy User Guide.
*
*
* @param type
* The minimum healthy instance type:
*
* -
*
* HOST_COUNT: The minimum number of healthy instances as an absolute value.
*
*
* -
*
* FLEET_PERCENT: The minimum number of healthy instances as a percentage of the total
* number of instances in the deployment.
*
*
*
*
* In an example of nine instances, if a HOST_COUNT of six is specified, deploy to up to three instances
* at a time. The deployment is successful if six or more instances are deployed to successfully.
* Otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five instances
* at a time. The deployment is successful if four or more instances are deployed to successfully.
* Otherwise, the deployment fails.
*
*
*
* In a call to the GetDeploymentConfig, CodeDeployDefault.OneAtATime returns a minimum
* healthy instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one
* instance at a time. (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or
* FLEET_PERCENT.) In addition, with CodeDeployDefault.OneAtATime, CodeDeploy attempts to ensure that all
* instances but one are kept in a healthy state during the deployment. Although this allows one instance
* at a time to be taken offline for a new deployment, it also means that if the deployment to the last
* instance fails, the overall deployment is still successful.
*
*
*
* For more information, see CodeDeploy
* Instance Health in the CodeDeploy User Guide.
* @see MinimumHealthyHostsType
* @return Returns a reference to this object so that method calls can be chained together.
* @see MinimumHealthyHostsType
*/
Builder type(String type);
/**
*
* The minimum healthy instance type:
*
*
* -
*
* HOST_COUNT: The minimum number of healthy instances as an absolute value.
*
*
* -
*
* FLEET_PERCENT: The minimum number of healthy instances as a percentage of the total number of
* instances in the deployment.
*
*
*
*
* In an example of nine instances, if a HOST_COUNT of six is specified, deploy to up to three instances at a
* time. The deployment is successful if six or more instances are deployed to successfully. Otherwise, the
* deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five instances at a time. The
* deployment is successful if four or more instances are deployed to successfully. Otherwise, the deployment
* fails.
*
*
*
* In a call to the GetDeploymentConfig, CodeDeployDefault.OneAtATime returns a minimum healthy
* instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one instance at a time.
* (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.) In addition, with
* CodeDeployDefault.OneAtATime, CodeDeploy attempts to ensure that all instances but one are kept in a healthy
* state during the deployment. Although this allows one instance at a time to be taken offline for a new
* deployment, it also means that if the deployment to the last instance fails, the overall deployment is still
* successful.
*
*
*
* For more information, see CodeDeploy Instance
* Health in the CodeDeploy User Guide.
*
*
* @param type
* The minimum healthy instance type:
*
* -
*
* HOST_COUNT: The minimum number of healthy instances as an absolute value.
*
*
* -
*
* FLEET_PERCENT: The minimum number of healthy instances as a percentage of the total
* number of instances in the deployment.
*
*
*
*
* In an example of nine instances, if a HOST_COUNT of six is specified, deploy to up to three instances
* at a time. The deployment is successful if six or more instances are deployed to successfully.
* Otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five instances
* at a time. The deployment is successful if four or more instances are deployed to successfully.
* Otherwise, the deployment fails.
*
*
*
* In a call to the GetDeploymentConfig, CodeDeployDefault.OneAtATime returns a minimum
* healthy instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one
* instance at a time. (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or
* FLEET_PERCENT.) In addition, with CodeDeployDefault.OneAtATime, CodeDeploy attempts to ensure that all
* instances but one are kept in a healthy state during the deployment. Although this allows one instance
* at a time to be taken offline for a new deployment, it also means that if the deployment to the last
* instance fails, the overall deployment is still successful.
*
*
*
* For more information, see CodeDeploy
* Instance Health in the CodeDeploy User Guide.
* @see MinimumHealthyHostsType
* @return Returns a reference to this object so that method calls can be chained together.
* @see MinimumHealthyHostsType
*/
Builder type(MinimumHealthyHostsType type);
/**
*
* The minimum healthy instance value.
*
*
* @param value
* The minimum healthy instance value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder value(Integer value);
}
static final class BuilderImpl implements Builder {
private String type;
private Integer value;
private BuilderImpl() {
}
private BuilderImpl(MinimumHealthyHosts model) {
type(model.type);
value(model.value);
}
public final String getType() {
return type;
}
public final void setType(String type) {
this.type = type;
}
@Override
public final Builder type(String type) {
this.type = type;
return this;
}
@Override
public final Builder type(MinimumHealthyHostsType type) {
this.type(type == null ? null : type.toString());
return this;
}
public final Integer getValue() {
return value;
}
public final void setValue(Integer value) {
this.value = value;
}
@Override
public final Builder value(Integer value) {
this.value = value;
return this;
}
@Override
public MinimumHealthyHosts build() {
return new MinimumHealthyHosts(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}