com.amazonaws.services.gamelift.model.UpdateFleetAttributesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-gamelift Show documentation
/*
* Copyright 2013-2018 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.AmazonWebServiceRequest;
/**
*
* Represents the input for a request action.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class UpdateFleetAttributesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* Unique identifier for a fleet to update attribute metadata for.
*
*/
private String fleetId;
/**
*
* Descriptive label that is associated with a fleet. Fleet names do not need to be unique.
*
*/
private String name;
/**
*
* Human-readable description of a fleet.
*
*/
private String description;
/**
*
* Game session protection policy to apply to all new instances created in this fleet. Instances that already exist
* are not affected. You can set protection for individual instances using UpdateGameSession.
*
*
* -
*
* NoProtection -- The game session can be terminated during a scale-down event.
*
*
* -
*
* FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during
* a scale-down event.
*
*
*
*/
private String newGameSessionProtectionPolicy;
/**
*
* Policy that limits the number of game sessions an individual player can create over a span of time.
*
*/
private ResourceCreationLimitPolicy resourceCreationLimitPolicy;
/**
*
* Names of metric groups to include this fleet in. Amazon CloudWatch uses a fleet metric group is to aggregate
* metrics from multiple fleets. Use an existing metric group name to add this fleet to the group. Or use a new name
* to create a new metric group. A fleet can only be included in one metric group at a time.
*
*/
private java.util.List metricGroups;
/**
*
* Unique identifier for a fleet to update attribute metadata for.
*
*
* @param fleetId
* Unique identifier for a fleet to update attribute metadata for.
*/
public void setFleetId(String fleetId) {
this.fleetId = fleetId;
}
/**
*
* Unique identifier for a fleet to update attribute metadata for.
*
*
* @return Unique identifier for a fleet to update attribute metadata for.
*/
public String getFleetId() {
return this.fleetId;
}
/**
*
* Unique identifier for a fleet to update attribute metadata for.
*
*
* @param fleetId
* Unique identifier for a fleet to update attribute metadata for.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateFleetAttributesRequest withFleetId(String fleetId) {
setFleetId(fleetId);
return this;
}
/**
*
* Descriptive label that is associated with a fleet. Fleet names do not need to be unique.
*
*
* @param name
* Descriptive label that is associated with a fleet. Fleet names do not need to be unique.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* Descriptive label that is associated with a fleet. Fleet names do not need to be unique.
*
*
* @return Descriptive label that is associated with a fleet. Fleet names do not need to be unique.
*/
public String getName() {
return this.name;
}
/**
*
* Descriptive label that is associated with a fleet. Fleet names do not need to be unique.
*
*
* @param name
* Descriptive label that is associated with a fleet. Fleet names do not need to be unique.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateFleetAttributesRequest withName(String name) {
setName(name);
return this;
}
/**
*
* Human-readable description of a fleet.
*
*
* @param description
* Human-readable description of a fleet.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* Human-readable description of a fleet.
*
*
* @return Human-readable description of a fleet.
*/
public String getDescription() {
return this.description;
}
/**
*
* Human-readable description of a fleet.
*
*
* @param description
* Human-readable description of a fleet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateFleetAttributesRequest withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* Game session protection policy to apply to all new instances created in this fleet. Instances that already exist
* are not affected. You can set protection for individual instances using UpdateGameSession.
*
*
* -
*
* NoProtection -- The game session can be terminated during a scale-down event.
*
*
* -
*
* FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during
* a scale-down event.
*
*
*
*
* @param newGameSessionProtectionPolicy
* Game session protection policy to apply to all new instances created in this fleet. Instances that already
* exist are not affected. You can set protection for individual instances using
* UpdateGameSession.
*
* -
*
* NoProtection -- The game session can be terminated during a scale-down event.
*
*
* -
*
* FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated
* during a scale-down event.
*
*
* @see ProtectionPolicy
*/
public void setNewGameSessionProtectionPolicy(String newGameSessionProtectionPolicy) {
this.newGameSessionProtectionPolicy = newGameSessionProtectionPolicy;
}
/**
*
* Game session protection policy to apply to all new instances created in this fleet. Instances that already exist
* are not affected. You can set protection for individual instances using UpdateGameSession.
*
*
* -
*
* NoProtection -- The game session can be terminated during a scale-down event.
*
*
* -
*
* FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during
* a scale-down event.
*
*
*
*
* @return Game session protection policy to apply to all new instances created in this fleet. Instances that
* already exist are not affected. You can set protection for individual instances using
* UpdateGameSession.
*
* -
*
* NoProtection -- The game session can be terminated during a scale-down event.
*
*
* -
*
* FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated
* during a scale-down event.
*
*
* @see ProtectionPolicy
*/
public String getNewGameSessionProtectionPolicy() {
return this.newGameSessionProtectionPolicy;
}
/**
*
* Game session protection policy to apply to all new instances created in this fleet. Instances that already exist
* are not affected. You can set protection for individual instances using UpdateGameSession.
*
*
* -
*
* NoProtection -- The game session can be terminated during a scale-down event.
*
*
* -
*
* FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during
* a scale-down event.
*
*
*
*
* @param newGameSessionProtectionPolicy
* Game session protection policy to apply to all new instances created in this fleet. Instances that already
* exist are not affected. You can set protection for individual instances using
* UpdateGameSession.
*
* -
*
* NoProtection -- The game session can be terminated during a scale-down event.
*
*
* -
*
* FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated
* during a scale-down event.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ProtectionPolicy
*/
public UpdateFleetAttributesRequest withNewGameSessionProtectionPolicy(String newGameSessionProtectionPolicy) {
setNewGameSessionProtectionPolicy(newGameSessionProtectionPolicy);
return this;
}
/**
*
* Game session protection policy to apply to all new instances created in this fleet. Instances that already exist
* are not affected. You can set protection for individual instances using UpdateGameSession.
*
*
* -
*
* NoProtection -- The game session can be terminated during a scale-down event.
*
*
* -
*
* FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during
* a scale-down event.
*
*
*
*
* @param newGameSessionProtectionPolicy
* Game session protection policy to apply to all new instances created in this fleet. Instances that already
* exist are not affected. You can set protection for individual instances using
* UpdateGameSession.
*
* -
*
* NoProtection -- The game session can be terminated during a scale-down event.
*
*
* -
*
* FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated
* during a scale-down event.
*
*
* @see ProtectionPolicy
*/
public void setNewGameSessionProtectionPolicy(ProtectionPolicy newGameSessionProtectionPolicy) {
withNewGameSessionProtectionPolicy(newGameSessionProtectionPolicy);
}
/**
*
* Game session protection policy to apply to all new instances created in this fleet. Instances that already exist
* are not affected. You can set protection for individual instances using UpdateGameSession.
*
*
* -
*
* NoProtection -- The game session can be terminated during a scale-down event.
*
*
* -
*
* FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during
* a scale-down event.
*
*
*
*
* @param newGameSessionProtectionPolicy
* Game session protection policy to apply to all new instances created in this fleet. Instances that already
* exist are not affected. You can set protection for individual instances using
* UpdateGameSession.
*
* -
*
* NoProtection -- The game session can be terminated during a scale-down event.
*
*
* -
*
* FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated
* during a scale-down event.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ProtectionPolicy
*/
public UpdateFleetAttributesRequest withNewGameSessionProtectionPolicy(ProtectionPolicy newGameSessionProtectionPolicy) {
this.newGameSessionProtectionPolicy = newGameSessionProtectionPolicy.toString();
return this;
}
/**
*
* Policy that limits the number of game sessions an individual player can create over a span of time.
*
*
* @param resourceCreationLimitPolicy
* Policy that limits the number of game sessions an individual player can create over a span of time.
*/
public void setResourceCreationLimitPolicy(ResourceCreationLimitPolicy resourceCreationLimitPolicy) {
this.resourceCreationLimitPolicy = resourceCreationLimitPolicy;
}
/**
*
* Policy that limits the number of game sessions an individual player can create over a span of time.
*
*
* @return Policy that limits the number of game sessions an individual player can create over a span of time.
*/
public ResourceCreationLimitPolicy getResourceCreationLimitPolicy() {
return this.resourceCreationLimitPolicy;
}
/**
*
* Policy that limits the number of game sessions an individual player can create over a span of time.
*
*
* @param resourceCreationLimitPolicy
* Policy that limits the number of game sessions an individual player can create over a span of time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateFleetAttributesRequest withResourceCreationLimitPolicy(ResourceCreationLimitPolicy resourceCreationLimitPolicy) {
setResourceCreationLimitPolicy(resourceCreationLimitPolicy);
return this;
}
/**
*
* Names of metric groups to include this fleet in. Amazon CloudWatch uses a fleet metric group is to aggregate
* metrics from multiple fleets. Use an existing metric group name to add this fleet to the group. Or use a new name
* to create a new metric group. A fleet can only be included in one metric group at a time.
*
*
* @return Names of metric groups to include this fleet in. Amazon CloudWatch uses a fleet metric group is to
* aggregate metrics from multiple fleets. Use an existing metric group name to add this fleet to the group.
* Or use a new name to create a new metric group. A fleet can only be included in one metric group at a
* time.
*/
public java.util.List getMetricGroups() {
return metricGroups;
}
/**
*
* Names of metric groups to include this fleet in. Amazon CloudWatch uses a fleet metric group is to aggregate
* metrics from multiple fleets. Use an existing metric group name to add this fleet to the group. Or use a new name
* to create a new metric group. A fleet can only be included in one metric group at a time.
*
*
* @param metricGroups
* Names of metric groups to include this fleet in. Amazon CloudWatch uses a fleet metric group is to
* aggregate metrics from multiple fleets. Use an existing metric group name to add this fleet to the group.
* Or use a new name to create a new metric group. A fleet can only be included in one metric group at a
* time.
*/
public void setMetricGroups(java.util.Collection metricGroups) {
if (metricGroups == null) {
this.metricGroups = null;
return;
}
this.metricGroups = new java.util.ArrayList(metricGroups);
}
/**
*
* Names of metric groups to include this fleet in. Amazon CloudWatch uses a fleet metric group is to aggregate
* metrics from multiple fleets. Use an existing metric group name to add this fleet to the group. Or use a new name
* to create a new metric group. A fleet can only be included in one metric group at a time.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setMetricGroups(java.util.Collection)} or {@link #withMetricGroups(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param metricGroups
* Names of metric groups to include this fleet in. Amazon CloudWatch uses a fleet metric group is to
* aggregate metrics from multiple fleets. Use an existing metric group name to add this fleet to the group.
* Or use a new name to create a new metric group. A fleet can only be included in one metric group at a
* time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateFleetAttributesRequest withMetricGroups(String... metricGroups) {
if (this.metricGroups == null) {
setMetricGroups(new java.util.ArrayList(metricGroups.length));
}
for (String ele : metricGroups) {
this.metricGroups.add(ele);
}
return this;
}
/**
*
* Names of metric groups to include this fleet in. Amazon CloudWatch uses a fleet metric group is to aggregate
* metrics from multiple fleets. Use an existing metric group name to add this fleet to the group. Or use a new name
* to create a new metric group. A fleet can only be included in one metric group at a time.
*
*
* @param metricGroups
* Names of metric groups to include this fleet in. Amazon CloudWatch uses a fleet metric group is to
* aggregate metrics from multiple fleets. Use an existing metric group name to add this fleet to the group.
* Or use a new name to create a new metric group. A fleet can only be included in one metric group at a
* time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateFleetAttributesRequest withMetricGroups(java.util.Collection metricGroups) {
setMetricGroups(metricGroups);
return this;
}
/**
* Returns a string representation of this object; useful for testing and debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getFleetId() != null)
sb.append("FleetId: ").append(getFleetId()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getNewGameSessionProtectionPolicy() != null)
sb.append("NewGameSessionProtectionPolicy: ").append(getNewGameSessionProtectionPolicy()).append(",");
if (getResourceCreationLimitPolicy() != null)
sb.append("ResourceCreationLimitPolicy: ").append(getResourceCreationLimitPolicy()).append(",");
if (getMetricGroups() != null)
sb.append("MetricGroups: ").append(getMetricGroups());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof UpdateFleetAttributesRequest == false)
return false;
UpdateFleetAttributesRequest other = (UpdateFleetAttributesRequest) obj;
if (other.getFleetId() == null ^ this.getFleetId() == null)
return false;
if (other.getFleetId() != null && other.getFleetId().equals(this.getFleetId()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getNewGameSessionProtectionPolicy() == null ^ this.getNewGameSessionProtectionPolicy() == null)
return false;
if (other.getNewGameSessionProtectionPolicy() != null
&& other.getNewGameSessionProtectionPolicy().equals(this.getNewGameSessionProtectionPolicy()) == false)
return false;
if (other.getResourceCreationLimitPolicy() == null ^ this.getResourceCreationLimitPolicy() == null)
return false;
if (other.getResourceCreationLimitPolicy() != null && other.getResourceCreationLimitPolicy().equals(this.getResourceCreationLimitPolicy()) == false)
return false;
if (other.getMetricGroups() == null ^ this.getMetricGroups() == null)
return false;
if (other.getMetricGroups() != null && other.getMetricGroups().equals(this.getMetricGroups()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getFleetId() == null) ? 0 : getFleetId().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getNewGameSessionProtectionPolicy() == null) ? 0 : getNewGameSessionProtectionPolicy().hashCode());
hashCode = prime * hashCode + ((getResourceCreationLimitPolicy() == null) ? 0 : getResourceCreationLimitPolicy().hashCode());
hashCode = prime * hashCode + ((getMetricGroups() == null) ? 0 : getMetricGroups().hashCode());
return hashCode;
}
@Override
public UpdateFleetAttributesRequest clone() {
return (UpdateFleetAttributesRequest) super.clone();
}
}