software.amazon.awssdk.services.ecs.model.DeploymentController Maven / Gradle / Ivy
Show all versions of ecs 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.ecs.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;
/**
*
* The deployment controller to use for the service. For more information, see Amazon ECS deployment
* types in the Amazon Elastic Container Service Developer Guide.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DeploymentController implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField TYPE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("type")
.getter(getter(DeploymentController::typeAsString)).setter(setter(Builder::type))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("type").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TYPE_FIELD));
private static final long serialVersionUID = 1L;
private final String type;
private DeploymentController(BuilderImpl builder) {
this.type = builder.type;
}
/**
*
* The deployment controller type to use.
*
*
* There are three deployment controller types available:
*
*
* - ECS
* -
*
* The rolling update (ECS) deployment type involves replacing the current running version of the
* container with the latest version. The number of containers Amazon ECS adds or removes from the service during a
* rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a
* service deployment, as specified in the DeploymentConfiguration.
*
*
* - CODE_DEPLOY
* -
*
* The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by
* CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it.
*
*
* - EXTERNAL
* -
*
* The external (EXTERNAL) deployment type enables you to use any third-party deployment controller for
* full control over the deployment process for an Amazon ECS service.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link DeploymentControllerType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return The deployment controller type to use.
*
* There are three deployment controller types available:
*
*
* - ECS
* -
*
* The rolling update (ECS) deployment type involves replacing the current running version of
* the container with the latest version. The number of containers Amazon ECS adds or removes from the
* service during a rolling update is controlled by adjusting the minimum and maximum number of healthy
* tasks allowed during a service deployment, as specified in the DeploymentConfiguration.
*
*
* - CODE_DEPLOY
* -
*
* The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by
* CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to
* it.
*
*
* - EXTERNAL
* -
*
* The external (EXTERNAL) deployment type enables you to use any third-party deployment
* controller for full control over the deployment process for an Amazon ECS service.
*
*
* @see DeploymentControllerType
*/
public final DeploymentControllerType type() {
return DeploymentControllerType.fromValue(type);
}
/**
*
* The deployment controller type to use.
*
*
* There are three deployment controller types available:
*
*
* - ECS
* -
*
* The rolling update (ECS) deployment type involves replacing the current running version of the
* container with the latest version. The number of containers Amazon ECS adds or removes from the service during a
* rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a
* service deployment, as specified in the DeploymentConfiguration.
*
*
* - CODE_DEPLOY
* -
*
* The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by
* CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it.
*
*
* - EXTERNAL
* -
*
* The external (EXTERNAL) deployment type enables you to use any third-party deployment controller for
* full control over the deployment process for an Amazon ECS service.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link DeploymentControllerType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return The deployment controller type to use.
*
* There are three deployment controller types available:
*
*
* - ECS
* -
*
* The rolling update (ECS) deployment type involves replacing the current running version of
* the container with the latest version. The number of containers Amazon ECS adds or removes from the
* service during a rolling update is controlled by adjusting the minimum and maximum number of healthy
* tasks allowed during a service deployment, as specified in the DeploymentConfiguration.
*
*
* - CODE_DEPLOY
* -
*
* The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by
* CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to
* it.
*
*
* - EXTERNAL
* -
*
* The external (EXTERNAL) deployment type enables you to use any third-party deployment
* controller for full control over the deployment process for an Amazon ECS service.
*
*
* @see DeploymentControllerType
*/
public final String typeAsString() {
return type;
}
@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());
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 DeploymentController)) {
return false;
}
DeploymentController other = (DeploymentController) obj;
return Objects.equals(typeAsString(), other.typeAsString());
}
/**
* 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("DeploymentController").add("Type", typeAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "type":
return Optional.ofNullable(clazz.cast(typeAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DeploymentController) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The deployment controller type to use.
*
*
* There are three deployment controller types available:
*
*
* - ECS
* -
*
* The rolling update (ECS) deployment type involves replacing the current running version of the
* container with the latest version. The number of containers Amazon ECS adds or removes from the service
* during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed
* during a service deployment, as specified in the DeploymentConfiguration.
*
*
* - CODE_DEPLOY
* -
*
* The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by
* CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it.
*
*
* - EXTERNAL
* -
*
* The external (EXTERNAL) deployment type enables you to use any third-party deployment controller
* for full control over the deployment process for an Amazon ECS service.
*
*
*
*
* @param type
* The deployment controller type to use.
*
* There are three deployment controller types available:
*
*
* - ECS
* -
*
* The rolling update (ECS) deployment type involves replacing the current running version
* of the container with the latest version. The number of containers Amazon ECS adds or removes from the
* service during a rolling update is controlled by adjusting the minimum and maximum number of healthy
* tasks allowed during a service deployment, as specified in the DeploymentConfiguration.
*
*
* - CODE_DEPLOY
* -
*
* The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered
* by CodeDeploy, which allows you to verify a new deployment of a service before sending production
* traffic to it.
*
*
* - EXTERNAL
* -
*
* The external (EXTERNAL) deployment type enables you to use any third-party deployment
* controller for full control over the deployment process for an Amazon ECS service.
*
*
* @see DeploymentControllerType
* @return Returns a reference to this object so that method calls can be chained together.
* @see DeploymentControllerType
*/
Builder type(String type);
/**
*
* The deployment controller type to use.
*
*
* There are three deployment controller types available:
*
*
* - ECS
* -
*
* The rolling update (ECS) deployment type involves replacing the current running version of the
* container with the latest version. The number of containers Amazon ECS adds or removes from the service
* during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed
* during a service deployment, as specified in the DeploymentConfiguration.
*
*
* - CODE_DEPLOY
* -
*
* The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by
* CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it.
*
*
* - EXTERNAL
* -
*
* The external (EXTERNAL) deployment type enables you to use any third-party deployment controller
* for full control over the deployment process for an Amazon ECS service.
*
*
*
*
* @param type
* The deployment controller type to use.
*
* There are three deployment controller types available:
*
*
* - ECS
* -
*
* The rolling update (ECS) deployment type involves replacing the current running version
* of the container with the latest version. The number of containers Amazon ECS adds or removes from the
* service during a rolling update is controlled by adjusting the minimum and maximum number of healthy
* tasks allowed during a service deployment, as specified in the DeploymentConfiguration.
*
*
* - CODE_DEPLOY
* -
*
* The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered
* by CodeDeploy, which allows you to verify a new deployment of a service before sending production
* traffic to it.
*
*
* - EXTERNAL
* -
*
* The external (EXTERNAL) deployment type enables you to use any third-party deployment
* controller for full control over the deployment process for an Amazon ECS service.
*
*
* @see DeploymentControllerType
* @return Returns a reference to this object so that method calls can be chained together.
* @see DeploymentControllerType
*/
Builder type(DeploymentControllerType type);
}
static final class BuilderImpl implements Builder {
private String type;
private BuilderImpl() {
}
private BuilderImpl(DeploymentController model) {
type(model.type);
}
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(DeploymentControllerType type) {
this.type(type == null ? null : type.toString());
return this;
}
@Override
public DeploymentController build() {
return new DeploymentController(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}