com.amazonaws.services.gamelift.model.RoutingStrategy Maven / Gradle / Ivy
Show all versions of aws-java-sdk-gamelift Show documentation
/*
* 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.gamelift.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The routing configuration for a fleet alias.
*
*
* Related actions
*
*
* All APIs by task
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class RoutingStrategy implements Serializable, Cloneable, StructuredPojo {
/**
*
* The type of routing strategy for the alias.
*
*
* Possible routing types include the following:
*
*
* -
*
* SIMPLE - The alias resolves to one specific fleet. Use this type when routing to active fleets.
*
*
* -
*
* TERMINAL - The alias does not resolve to a fleet but instead can be used to display a message to the user.
* A terminal alias throws a TerminalRoutingStrategyException with the message embedded.
*
*
*
*/
private String type;
/**
*
* A unique identifier for the fleet that the alias points to. This value is the fleet ID, not the fleet ARN.
*
*/
private String fleetId;
/**
*
* The message text to be used with a terminal routing strategy.
*
*/
private String message;
/**
*
* The type of routing strategy for the alias.
*
*
* Possible routing types include the following:
*
*
* -
*
* SIMPLE - The alias resolves to one specific fleet. Use this type when routing to active fleets.
*
*
* -
*
* TERMINAL - The alias does not resolve to a fleet but instead can be used to display a message to the user.
* A terminal alias throws a TerminalRoutingStrategyException with the message embedded.
*
*
*
*
* @param type
* The type of routing strategy for the alias.
*
* Possible routing types include the following:
*
*
* -
*
* SIMPLE - The alias resolves to one specific fleet. Use this type when routing to active fleets.
*
*
* -
*
* TERMINAL - The alias does not resolve to a fleet but instead can be used to display a message to
* the user. A terminal alias throws a TerminalRoutingStrategyException with the message embedded.
*
*
* @see RoutingStrategyType
*/
public void setType(String type) {
this.type = type;
}
/**
*
* The type of routing strategy for the alias.
*
*
* Possible routing types include the following:
*
*
* -
*
* SIMPLE - The alias resolves to one specific fleet. Use this type when routing to active fleets.
*
*
* -
*
* TERMINAL - The alias does not resolve to a fleet but instead can be used to display a message to the user.
* A terminal alias throws a TerminalRoutingStrategyException with the message embedded.
*
*
*
*
* @return The type of routing strategy for the alias.
*
* Possible routing types include the following:
*
*
* -
*
* SIMPLE - The alias resolves to one specific fleet. Use this type when routing to active fleets.
*
*
* -
*
* TERMINAL - The alias does not resolve to a fleet but instead can be used to display a message to
* the user. A terminal alias throws a TerminalRoutingStrategyException with the message embedded.
*
*
* @see RoutingStrategyType
*/
public String getType() {
return this.type;
}
/**
*
* The type of routing strategy for the alias.
*
*
* Possible routing types include the following:
*
*
* -
*
* SIMPLE - The alias resolves to one specific fleet. Use this type when routing to active fleets.
*
*
* -
*
* TERMINAL - The alias does not resolve to a fleet but instead can be used to display a message to the user.
* A terminal alias throws a TerminalRoutingStrategyException with the message embedded.
*
*
*
*
* @param type
* The type of routing strategy for the alias.
*
* Possible routing types include the following:
*
*
* -
*
* SIMPLE - The alias resolves to one specific fleet. Use this type when routing to active fleets.
*
*
* -
*
* TERMINAL - The alias does not resolve to a fleet but instead can be used to display a message to
* the user. A terminal alias throws a TerminalRoutingStrategyException with the message embedded.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see RoutingStrategyType
*/
public RoutingStrategy withType(String type) {
setType(type);
return this;
}
/**
*
* The type of routing strategy for the alias.
*
*
* Possible routing types include the following:
*
*
* -
*
* SIMPLE - The alias resolves to one specific fleet. Use this type when routing to active fleets.
*
*
* -
*
* TERMINAL - The alias does not resolve to a fleet but instead can be used to display a message to the user.
* A terminal alias throws a TerminalRoutingStrategyException with the message embedded.
*
*
*
*
* @param type
* The type of routing strategy for the alias.
*
* Possible routing types include the following:
*
*
* -
*
* SIMPLE - The alias resolves to one specific fleet. Use this type when routing to active fleets.
*
*
* -
*
* TERMINAL - The alias does not resolve to a fleet but instead can be used to display a message to
* the user. A terminal alias throws a TerminalRoutingStrategyException with the message embedded.
*
*
* @see RoutingStrategyType
*/
public void setType(RoutingStrategyType type) {
withType(type);
}
/**
*
* The type of routing strategy for the alias.
*
*
* Possible routing types include the following:
*
*
* -
*
* SIMPLE - The alias resolves to one specific fleet. Use this type when routing to active fleets.
*
*
* -
*
* TERMINAL - The alias does not resolve to a fleet but instead can be used to display a message to the user.
* A terminal alias throws a TerminalRoutingStrategyException with the message embedded.
*
*
*
*
* @param type
* The type of routing strategy for the alias.
*
* Possible routing types include the following:
*
*
* -
*
* SIMPLE - The alias resolves to one specific fleet. Use this type when routing to active fleets.
*
*
* -
*
* TERMINAL - The alias does not resolve to a fleet but instead can be used to display a message to
* the user. A terminal alias throws a TerminalRoutingStrategyException with the message embedded.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see RoutingStrategyType
*/
public RoutingStrategy withType(RoutingStrategyType type) {
this.type = type.toString();
return this;
}
/**
*
* A unique identifier for the fleet that the alias points to. This value is the fleet ID, not the fleet ARN.
*
*
* @param fleetId
* A unique identifier for the fleet that the alias points to. This value is the fleet ID, not the fleet ARN.
*/
public void setFleetId(String fleetId) {
this.fleetId = fleetId;
}
/**
*
* A unique identifier for the fleet that the alias points to. This value is the fleet ID, not the fleet ARN.
*
*
* @return A unique identifier for the fleet that the alias points to. This value is the fleet ID, not the fleet
* ARN.
*/
public String getFleetId() {
return this.fleetId;
}
/**
*
* A unique identifier for the fleet that the alias points to. This value is the fleet ID, not the fleet ARN.
*
*
* @param fleetId
* A unique identifier for the fleet that the alias points to. This value is the fleet ID, not the fleet ARN.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RoutingStrategy withFleetId(String fleetId) {
setFleetId(fleetId);
return this;
}
/**
*
* The message text to be used with a terminal routing strategy.
*
*
* @param message
* The message text to be used with a terminal routing strategy.
*/
public void setMessage(String message) {
this.message = message;
}
/**
*
* The message text to be used with a terminal routing strategy.
*
*
* @return The message text to be used with a terminal routing strategy.
*/
public String getMessage() {
return this.message;
}
/**
*
* The message text to be used with a terminal routing strategy.
*
*
* @param message
* The message text to be used with a terminal routing strategy.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RoutingStrategy withMessage(String message) {
setMessage(message);
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 (getFleetId() != null)
sb.append("FleetId: ").append(getFleetId()).append(",");
if (getMessage() != null)
sb.append("Message: ").append(getMessage());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof RoutingStrategy == false)
return false;
RoutingStrategy other = (RoutingStrategy) obj;
if (other.getType() == null ^ this.getType() == null)
return false;
if (other.getType() != null && other.getType().equals(this.getType()) == false)
return false;
if (other.getFleetId() == null ^ this.getFleetId() == null)
return false;
if (other.getFleetId() != null && other.getFleetId().equals(this.getFleetId()) == false)
return false;
if (other.getMessage() == null ^ this.getMessage() == null)
return false;
if (other.getMessage() != null && other.getMessage().equals(this.getMessage()) == 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 + ((getFleetId() == null) ? 0 : getFleetId().hashCode());
hashCode = prime * hashCode + ((getMessage() == null) ? 0 : getMessage().hashCode());
return hashCode;
}
@Override
public RoutingStrategy clone() {
try {
return (RoutingStrategy) 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.gamelift.model.transform.RoutingStrategyMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}