com.amazonaws.services.ec2.model.CreatePlacementGroupRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 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.ec2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.CreatePlacementGroupRequestMarshaller;
/**
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreatePlacementGroupRequest extends AmazonWebServiceRequest implements Serializable, Cloneable,
DryRunSupportedRequest {
/**
*
* A name for the placement group. Must be unique within the scope of your account for the Region.
*
*
* Constraints: Up to 255 ASCII characters
*
*/
private String groupName;
/**
*
* The placement strategy.
*
*/
private String strategy;
/**
*
* The number of partitions. Valid only when Strategy is set to partition.
*
*/
private Integer partitionCount;
/**
*
* The tags to apply to the new placement group.
*
*/
private com.amazonaws.internal.SdkInternalList tagSpecifications;
/**
*
* Determines how placement groups spread instances.
*
*
* -
*
* Host – You can use host only with Outpost placement groups.
*
*
* -
*
* Rack – No usage restrictions.
*
*
*
*/
private String spreadLevel;
/**
* Default constructor for CreatePlacementGroupRequest object. Callers should use the setter or fluent setter
* (with...) methods to initialize the object after creating it.
*/
public CreatePlacementGroupRequest() {
}
/**
* Constructs a new CreatePlacementGroupRequest object. Callers should use the setter or fluent setter (with...)
* methods to initialize any additional object members.
*
* @param groupName
* A name for the placement group. Must be unique within the scope of your account for the Region.
*
* Constraints: Up to 255 ASCII characters
* @param strategy
* The placement strategy.
*/
public CreatePlacementGroupRequest(String groupName, String strategy) {
setGroupName(groupName);
setStrategy(strategy);
}
/**
* Constructs a new CreatePlacementGroupRequest object. Callers should use the setter or fluent setter (with...)
* methods to initialize any additional object members.
*
* @param groupName
* A name for the placement group. Must be unique within the scope of your account for the Region.
*
* Constraints: Up to 255 ASCII characters
* @param strategy
* The placement strategy.
*/
public CreatePlacementGroupRequest(String groupName, PlacementStrategy strategy) {
setGroupName(groupName);
setStrategy(strategy.toString());
}
/**
*
* A name for the placement group. Must be unique within the scope of your account for the Region.
*
*
* Constraints: Up to 255 ASCII characters
*
*
* @param groupName
* A name for the placement group. Must be unique within the scope of your account for the Region.
*
* Constraints: Up to 255 ASCII characters
*/
public void setGroupName(String groupName) {
this.groupName = groupName;
}
/**
*
* A name for the placement group. Must be unique within the scope of your account for the Region.
*
*
* Constraints: Up to 255 ASCII characters
*
*
* @return A name for the placement group. Must be unique within the scope of your account for the Region.
*
* Constraints: Up to 255 ASCII characters
*/
public String getGroupName() {
return this.groupName;
}
/**
*
* A name for the placement group. Must be unique within the scope of your account for the Region.
*
*
* Constraints: Up to 255 ASCII characters
*
*
* @param groupName
* A name for the placement group. Must be unique within the scope of your account for the Region.
*
* Constraints: Up to 255 ASCII characters
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePlacementGroupRequest withGroupName(String groupName) {
setGroupName(groupName);
return this;
}
/**
*
* The placement strategy.
*
*
* @param strategy
* The placement strategy.
* @see PlacementStrategy
*/
public void setStrategy(String strategy) {
this.strategy = strategy;
}
/**
*
* The placement strategy.
*
*
* @return The placement strategy.
* @see PlacementStrategy
*/
public String getStrategy() {
return this.strategy;
}
/**
*
* The placement strategy.
*
*
* @param strategy
* The placement strategy.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PlacementStrategy
*/
public CreatePlacementGroupRequest withStrategy(String strategy) {
setStrategy(strategy);
return this;
}
/**
*
* The placement strategy.
*
*
* @param strategy
* The placement strategy.
* @see PlacementStrategy
*/
public void setStrategy(PlacementStrategy strategy) {
withStrategy(strategy);
}
/**
*
* The placement strategy.
*
*
* @param strategy
* The placement strategy.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PlacementStrategy
*/
public CreatePlacementGroupRequest withStrategy(PlacementStrategy strategy) {
this.strategy = strategy.toString();
return this;
}
/**
*
* The number of partitions. Valid only when Strategy is set to partition.
*
*
* @param partitionCount
* The number of partitions. Valid only when Strategy is set to partition.
*/
public void setPartitionCount(Integer partitionCount) {
this.partitionCount = partitionCount;
}
/**
*
* The number of partitions. Valid only when Strategy is set to partition.
*
*
* @return The number of partitions. Valid only when Strategy is set to partition.
*/
public Integer getPartitionCount() {
return this.partitionCount;
}
/**
*
* The number of partitions. Valid only when Strategy is set to partition.
*
*
* @param partitionCount
* The number of partitions. Valid only when Strategy is set to partition.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePlacementGroupRequest withPartitionCount(Integer partitionCount) {
setPartitionCount(partitionCount);
return this;
}
/**
*
* The tags to apply to the new placement group.
*
*
* @return The tags to apply to the new placement group.
*/
public java.util.List getTagSpecifications() {
if (tagSpecifications == null) {
tagSpecifications = new com.amazonaws.internal.SdkInternalList();
}
return tagSpecifications;
}
/**
*
* The tags to apply to the new placement group.
*
*
* @param tagSpecifications
* The tags to apply to the new placement group.
*/
public void setTagSpecifications(java.util.Collection tagSpecifications) {
if (tagSpecifications == null) {
this.tagSpecifications = null;
return;
}
this.tagSpecifications = new com.amazonaws.internal.SdkInternalList(tagSpecifications);
}
/**
*
* The tags to apply to the new placement group.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTagSpecifications(java.util.Collection)} or {@link #withTagSpecifications(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param tagSpecifications
* The tags to apply to the new placement group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePlacementGroupRequest withTagSpecifications(TagSpecification... tagSpecifications) {
if (this.tagSpecifications == null) {
setTagSpecifications(new com.amazonaws.internal.SdkInternalList(tagSpecifications.length));
}
for (TagSpecification ele : tagSpecifications) {
this.tagSpecifications.add(ele);
}
return this;
}
/**
*
* The tags to apply to the new placement group.
*
*
* @param tagSpecifications
* The tags to apply to the new placement group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePlacementGroupRequest withTagSpecifications(java.util.Collection tagSpecifications) {
setTagSpecifications(tagSpecifications);
return this;
}
/**
*
* Determines how placement groups spread instances.
*
*
* -
*
* Host – You can use host only with Outpost placement groups.
*
*
* -
*
* Rack – No usage restrictions.
*
*
*
*
* @param spreadLevel
* Determines how placement groups spread instances.
*
* -
*
* Host – You can use host only with Outpost placement groups.
*
*
* -
*
* Rack – No usage restrictions.
*
*
* @see SpreadLevel
*/
public void setSpreadLevel(String spreadLevel) {
this.spreadLevel = spreadLevel;
}
/**
*
* Determines how placement groups spread instances.
*
*
* -
*
* Host – You can use host only with Outpost placement groups.
*
*
* -
*
* Rack – No usage restrictions.
*
*
*
*
* @return Determines how placement groups spread instances.
*
* -
*
* Host – You can use host only with Outpost placement groups.
*
*
* -
*
* Rack – No usage restrictions.
*
*
* @see SpreadLevel
*/
public String getSpreadLevel() {
return this.spreadLevel;
}
/**
*
* Determines how placement groups spread instances.
*
*
* -
*
* Host – You can use host only with Outpost placement groups.
*
*
* -
*
* Rack – No usage restrictions.
*
*
*
*
* @param spreadLevel
* Determines how placement groups spread instances.
*
* -
*
* Host – You can use host only with Outpost placement groups.
*
*
* -
*
* Rack – No usage restrictions.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see SpreadLevel
*/
public CreatePlacementGroupRequest withSpreadLevel(String spreadLevel) {
setSpreadLevel(spreadLevel);
return this;
}
/**
*
* Determines how placement groups spread instances.
*
*
* -
*
* Host – You can use host only with Outpost placement groups.
*
*
* -
*
* Rack – No usage restrictions.
*
*
*
*
* @param spreadLevel
* Determines how placement groups spread instances.
*
* -
*
* Host – You can use host only with Outpost placement groups.
*
*
* -
*
* Rack – No usage restrictions.
*
*
* @see SpreadLevel
*/
public void setSpreadLevel(SpreadLevel spreadLevel) {
withSpreadLevel(spreadLevel);
}
/**
*
* Determines how placement groups spread instances.
*
*
* -
*
* Host – You can use host only with Outpost placement groups.
*
*
* -
*
* Rack – No usage restrictions.
*
*
*
*
* @param spreadLevel
* Determines how placement groups spread instances.
*
* -
*
* Host – You can use host only with Outpost placement groups.
*
*
* -
*
* Rack – No usage restrictions.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see SpreadLevel
*/
public CreatePlacementGroupRequest withSpreadLevel(SpreadLevel spreadLevel) {
this.spreadLevel = spreadLevel.toString();
return this;
}
/**
* This method is intended for internal use only. Returns the marshaled request configured with additional
* parameters to enable operation dry-run.
*/
@Override
public Request getDryRunRequest() {
Request request = new CreatePlacementGroupRequestMarshaller().marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* 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 (getGroupName() != null)
sb.append("GroupName: ").append(getGroupName()).append(",");
if (getStrategy() != null)
sb.append("Strategy: ").append(getStrategy()).append(",");
if (getPartitionCount() != null)
sb.append("PartitionCount: ").append(getPartitionCount()).append(",");
if (getTagSpecifications() != null)
sb.append("TagSpecifications: ").append(getTagSpecifications()).append(",");
if (getSpreadLevel() != null)
sb.append("SpreadLevel: ").append(getSpreadLevel());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreatePlacementGroupRequest == false)
return false;
CreatePlacementGroupRequest other = (CreatePlacementGroupRequest) obj;
if (other.getGroupName() == null ^ this.getGroupName() == null)
return false;
if (other.getGroupName() != null && other.getGroupName().equals(this.getGroupName()) == false)
return false;
if (other.getStrategy() == null ^ this.getStrategy() == null)
return false;
if (other.getStrategy() != null && other.getStrategy().equals(this.getStrategy()) == false)
return false;
if (other.getPartitionCount() == null ^ this.getPartitionCount() == null)
return false;
if (other.getPartitionCount() != null && other.getPartitionCount().equals(this.getPartitionCount()) == false)
return false;
if (other.getTagSpecifications() == null ^ this.getTagSpecifications() == null)
return false;
if (other.getTagSpecifications() != null && other.getTagSpecifications().equals(this.getTagSpecifications()) == false)
return false;
if (other.getSpreadLevel() == null ^ this.getSpreadLevel() == null)
return false;
if (other.getSpreadLevel() != null && other.getSpreadLevel().equals(this.getSpreadLevel()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getGroupName() == null) ? 0 : getGroupName().hashCode());
hashCode = prime * hashCode + ((getStrategy() == null) ? 0 : getStrategy().hashCode());
hashCode = prime * hashCode + ((getPartitionCount() == null) ? 0 : getPartitionCount().hashCode());
hashCode = prime * hashCode + ((getTagSpecifications() == null) ? 0 : getTagSpecifications().hashCode());
hashCode = prime * hashCode + ((getSpreadLevel() == null) ? 0 : getSpreadLevel().hashCode());
return hashCode;
}
@Override
public CreatePlacementGroupRequest clone() {
return (CreatePlacementGroupRequest) super.clone();
}
}