software.amazon.awssdk.services.gamelift.model.DeleteGameServerGroupRequest Maven / Gradle / Ivy
Show all versions of gamelift 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.gamelift.model;
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.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DeleteGameServerGroupRequest extends GameLiftRequest implements
ToCopyableBuilder {
private static final SdkField GAME_SERVER_GROUP_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("GameServerGroupName").getter(getter(DeleteGameServerGroupRequest::gameServerGroupName))
.setter(setter(Builder::gameServerGroupName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GameServerGroupName").build())
.build();
private static final SdkField DELETE_OPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DeleteOption").getter(getter(DeleteGameServerGroupRequest::deleteOptionAsString))
.setter(setter(Builder::deleteOption))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DeleteOption").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(GAME_SERVER_GROUP_NAME_FIELD,
DELETE_OPTION_FIELD));
private final String gameServerGroupName;
private final String deleteOption;
private DeleteGameServerGroupRequest(BuilderImpl builder) {
super(builder);
this.gameServerGroupName = builder.gameServerGroupName;
this.deleteOption = builder.deleteOption;
}
/**
*
* A unique identifier for the game server group. Use either the name or ARN value.
*
*
* @return A unique identifier for the game server group. Use either the name or ARN value.
*/
public final String gameServerGroupName() {
return gameServerGroupName;
}
/**
*
* The type of delete to perform. Options include the following:
*
*
* -
*
* SAFE_DELETE – (default) Terminates the game server group and Amazon EC2 Auto Scaling group only when
* it has no game servers that are in UTILIZED status.
*
*
* -
*
* FORCE_DELETE – Terminates the game server group, including all active game servers regardless of
* their utilization status, and the Amazon EC2 Auto Scaling group.
*
*
* -
*
* RETAIN – Does a safe delete of the game server group but retains the Amazon EC2 Auto Scaling group
* as is.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #deleteOption} will
* return {@link GameServerGroupDeleteOption#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #deleteOptionAsString}.
*
*
* @return The type of delete to perform. Options include the following:
*
* -
*
* SAFE_DELETE – (default) Terminates the game server group and Amazon EC2 Auto Scaling group
* only when it has no game servers that are in UTILIZED status.
*
*
* -
*
* FORCE_DELETE – Terminates the game server group, including all active game servers
* regardless of their utilization status, and the Amazon EC2 Auto Scaling group.
*
*
* -
*
* RETAIN – Does a safe delete of the game server group but retains the Amazon EC2 Auto Scaling
* group as is.
*
*
* @see GameServerGroupDeleteOption
*/
public final GameServerGroupDeleteOption deleteOption() {
return GameServerGroupDeleteOption.fromValue(deleteOption);
}
/**
*
* The type of delete to perform. Options include the following:
*
*
* -
*
* SAFE_DELETE – (default) Terminates the game server group and Amazon EC2 Auto Scaling group only when
* it has no game servers that are in UTILIZED status.
*
*
* -
*
* FORCE_DELETE – Terminates the game server group, including all active game servers regardless of
* their utilization status, and the Amazon EC2 Auto Scaling group.
*
*
* -
*
* RETAIN – Does a safe delete of the game server group but retains the Amazon EC2 Auto Scaling group
* as is.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #deleteOption} will
* return {@link GameServerGroupDeleteOption#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #deleteOptionAsString}.
*
*
* @return The type of delete to perform. Options include the following:
*
* -
*
* SAFE_DELETE – (default) Terminates the game server group and Amazon EC2 Auto Scaling group
* only when it has no game servers that are in UTILIZED status.
*
*
* -
*
* FORCE_DELETE – Terminates the game server group, including all active game servers
* regardless of their utilization status, and the Amazon EC2 Auto Scaling group.
*
*
* -
*
* RETAIN – Does a safe delete of the game server group but retains the Amazon EC2 Auto Scaling
* group as is.
*
*
* @see GameServerGroupDeleteOption
*/
public final String deleteOptionAsString() {
return deleteOption;
}
@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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(gameServerGroupName());
hashCode = 31 * hashCode + Objects.hashCode(deleteOptionAsString());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DeleteGameServerGroupRequest)) {
return false;
}
DeleteGameServerGroupRequest other = (DeleteGameServerGroupRequest) obj;
return Objects.equals(gameServerGroupName(), other.gameServerGroupName())
&& Objects.equals(deleteOptionAsString(), other.deleteOptionAsString());
}
/**
* 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("DeleteGameServerGroupRequest").add("GameServerGroupName", gameServerGroupName())
.add("DeleteOption", deleteOptionAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "GameServerGroupName":
return Optional.ofNullable(clazz.cast(gameServerGroupName()));
case "DeleteOption":
return Optional.ofNullable(clazz.cast(deleteOptionAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DeleteGameServerGroupRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends GameLiftRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* A unique identifier for the game server group. Use either the name or ARN value.
*
*
* @param gameServerGroupName
* A unique identifier for the game server group. Use either the name or ARN value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder gameServerGroupName(String gameServerGroupName);
/**
*
* The type of delete to perform. Options include the following:
*
*
* -
*
* SAFE_DELETE – (default) Terminates the game server group and Amazon EC2 Auto Scaling group only
* when it has no game servers that are in UTILIZED status.
*
*
* -
*
* FORCE_DELETE – Terminates the game server group, including all active game servers regardless of
* their utilization status, and the Amazon EC2 Auto Scaling group.
*
*
* -
*
* RETAIN – Does a safe delete of the game server group but retains the Amazon EC2 Auto Scaling
* group as is.
*
*
*
*
* @param deleteOption
* The type of delete to perform. Options include the following:
*
* -
*
* SAFE_DELETE – (default) Terminates the game server group and Amazon EC2 Auto Scaling
* group only when it has no game servers that are in UTILIZED status.
*
*
* -
*
* FORCE_DELETE – Terminates the game server group, including all active game servers
* regardless of their utilization status, and the Amazon EC2 Auto Scaling group.
*
*
* -
*
* RETAIN – Does a safe delete of the game server group but retains the Amazon EC2 Auto
* Scaling group as is.
*
*
* @see GameServerGroupDeleteOption
* @return Returns a reference to this object so that method calls can be chained together.
* @see GameServerGroupDeleteOption
*/
Builder deleteOption(String deleteOption);
/**
*
* The type of delete to perform. Options include the following:
*
*
* -
*
* SAFE_DELETE – (default) Terminates the game server group and Amazon EC2 Auto Scaling group only
* when it has no game servers that are in UTILIZED status.
*
*
* -
*
* FORCE_DELETE – Terminates the game server group, including all active game servers regardless of
* their utilization status, and the Amazon EC2 Auto Scaling group.
*
*
* -
*
* RETAIN – Does a safe delete of the game server group but retains the Amazon EC2 Auto Scaling
* group as is.
*
*
*
*
* @param deleteOption
* The type of delete to perform. Options include the following:
*
* -
*
* SAFE_DELETE – (default) Terminates the game server group and Amazon EC2 Auto Scaling
* group only when it has no game servers that are in UTILIZED status.
*
*
* -
*
* FORCE_DELETE – Terminates the game server group, including all active game servers
* regardless of their utilization status, and the Amazon EC2 Auto Scaling group.
*
*
* -
*
* RETAIN – Does a safe delete of the game server group but retains the Amazon EC2 Auto
* Scaling group as is.
*
*
* @see GameServerGroupDeleteOption
* @return Returns a reference to this object so that method calls can be chained together.
* @see GameServerGroupDeleteOption
*/
Builder deleteOption(GameServerGroupDeleteOption deleteOption);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends GameLiftRequest.BuilderImpl implements Builder {
private String gameServerGroupName;
private String deleteOption;
private BuilderImpl() {
}
private BuilderImpl(DeleteGameServerGroupRequest model) {
super(model);
gameServerGroupName(model.gameServerGroupName);
deleteOption(model.deleteOption);
}
public final String getGameServerGroupName() {
return gameServerGroupName;
}
public final void setGameServerGroupName(String gameServerGroupName) {
this.gameServerGroupName = gameServerGroupName;
}
@Override
public final Builder gameServerGroupName(String gameServerGroupName) {
this.gameServerGroupName = gameServerGroupName;
return this;
}
public final String getDeleteOption() {
return deleteOption;
}
public final void setDeleteOption(String deleteOption) {
this.deleteOption = deleteOption;
}
@Override
public final Builder deleteOption(String deleteOption) {
this.deleteOption = deleteOption;
return this;
}
@Override
public final Builder deleteOption(GameServerGroupDeleteOption deleteOption) {
this.deleteOption(deleteOption == null ? null : deleteOption.toString());
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public DeleteGameServerGroupRequest build() {
return new DeleteGameServerGroupRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}