software.amazon.awscdk.services.gamelift.alpha.AliasProps Maven / Gradle / Ivy
Show all versions of gamelift-alpha Show documentation
package software.amazon.awscdk.services.gamelift.alpha;
/**
* (experimental) Properties for a new Fleet alias.
*
* Example:
*
*
* BuildFleet fleet;
* // Add an alias to an existing fleet using a dedicated fleet method
* Alias liveAlias = fleet.addAlias("live");
* // You can also create a standalone alias
* // You can also create a standalone alias
* Alias.Builder.create(this, "TerminalAlias")
* .aliasName("terminal-alias")
* .terminalMessage("A terminal message")
* .build();
*
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.104.0 (build e79254c)", date = "2024-12-27T17:02:12.078Z")
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.services.gamelift.alpha.$Module.class, fqn = "@aws-cdk/aws-gamelift-alpha.AliasProps")
@software.amazon.jsii.Jsii.Proxy(AliasProps.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public interface AliasProps extends software.amazon.jsii.JsiiSerializable {
/**
* (experimental) Name of this alias.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull java.lang.String getAliasName();
/**
* (experimental) A human-readable description of the alias.
*
* Default: no description
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable java.lang.String getDescription() {
return null;
}
/**
* (experimental) A fleet that the alias points to. If specified, the alias resolves to one specific fleet.
*
* At least one of fleet and terminalMessage must be provided.
*
* Default: no fleet that the alias points to.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.gamelift.alpha.IFleet getFleet() {
return null;
}
/**
* (experimental) The message text to be used with a terminal routing strategy.
*
* At least one of fleet and terminalMessage must be provided.
*
* Default: no terminal message
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable java.lang.String getTerminalMessage() {
return null;
}
/**
* @return a {@link Builder} of {@link AliasProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link AliasProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static final class Builder implements software.amazon.jsii.Builder {
java.lang.String aliasName;
java.lang.String description;
software.amazon.awscdk.services.gamelift.alpha.IFleet fleet;
java.lang.String terminalMessage;
/**
* Sets the value of {@link AliasProps#getAliasName}
* @param aliasName Name of this alias. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder aliasName(java.lang.String aliasName) {
this.aliasName = aliasName;
return this;
}
/**
* Sets the value of {@link AliasProps#getDescription}
* @param description A human-readable description of the alias.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder description(java.lang.String description) {
this.description = description;
return this;
}
/**
* Sets the value of {@link AliasProps#getFleet}
* @param fleet A fleet that the alias points to. If specified, the alias resolves to one specific fleet.
* At least one of fleet and terminalMessage must be provided.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder fleet(software.amazon.awscdk.services.gamelift.alpha.IFleet fleet) {
this.fleet = fleet;
return this;
}
/**
* Sets the value of {@link AliasProps#getTerminalMessage}
* @param terminalMessage The message text to be used with a terminal routing strategy.
* At least one of fleet and terminalMessage must be provided.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder terminalMessage(java.lang.String terminalMessage) {
this.terminalMessage = terminalMessage;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link AliasProps}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public AliasProps build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link AliasProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements AliasProps {
private final java.lang.String aliasName;
private final java.lang.String description;
private final software.amazon.awscdk.services.gamelift.alpha.IFleet fleet;
private final java.lang.String terminalMessage;
/**
* Constructor that initializes the object based on values retrieved from the JsiiObject.
* @param objRef Reference to the JSII managed object.
*/
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
this.aliasName = software.amazon.jsii.Kernel.get(this, "aliasName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.description = software.amazon.jsii.Kernel.get(this, "description", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.fleet = software.amazon.jsii.Kernel.get(this, "fleet", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.gamelift.alpha.IFleet.class));
this.terminalMessage = software.amazon.jsii.Kernel.get(this, "terminalMessage", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Constructor that initializes the object based on literal property values passed by the {@link Builder}.
*/
protected Jsii$Proxy(final Builder builder) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
this.aliasName = java.util.Objects.requireNonNull(builder.aliasName, "aliasName is required");
this.description = builder.description;
this.fleet = builder.fleet;
this.terminalMessage = builder.terminalMessage;
}
@Override
public final java.lang.String getAliasName() {
return this.aliasName;
}
@Override
public final java.lang.String getDescription() {
return this.description;
}
@Override
public final software.amazon.awscdk.services.gamelift.alpha.IFleet getFleet() {
return this.fleet;
}
@Override
public final java.lang.String getTerminalMessage() {
return this.terminalMessage;
}
@Override
@software.amazon.jsii.Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson() {
final com.fasterxml.jackson.databind.ObjectMapper om = software.amazon.jsii.JsiiObjectMapper.INSTANCE;
final com.fasterxml.jackson.databind.node.ObjectNode data = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
data.set("aliasName", om.valueToTree(this.getAliasName()));
if (this.getDescription() != null) {
data.set("description", om.valueToTree(this.getDescription()));
}
if (this.getFleet() != null) {
data.set("fleet", om.valueToTree(this.getFleet()));
}
if (this.getTerminalMessage() != null) {
data.set("terminalMessage", om.valueToTree(this.getTerminalMessage()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("@aws-cdk/aws-gamelift-alpha.AliasProps"));
struct.set("data", data);
final com.fasterxml.jackson.databind.node.ObjectNode obj = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
obj.set("$jsii.struct", struct);
return obj;
}
@Override
public final boolean equals(final Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
AliasProps.Jsii$Proxy that = (AliasProps.Jsii$Proxy) o;
if (!aliasName.equals(that.aliasName)) return false;
if (this.description != null ? !this.description.equals(that.description) : that.description != null) return false;
if (this.fleet != null ? !this.fleet.equals(that.fleet) : that.fleet != null) return false;
return this.terminalMessage != null ? this.terminalMessage.equals(that.terminalMessage) : that.terminalMessage == null;
}
@Override
public final int hashCode() {
int result = this.aliasName.hashCode();
result = 31 * result + (this.description != null ? this.description.hashCode() : 0);
result = 31 * result + (this.fleet != null ? this.fleet.hashCode() : 0);
result = 31 * result + (this.terminalMessage != null ? this.terminalMessage.hashCode() : 0);
return result;
}
}
}