com.amazonaws.services.outposts.model.GetCapacityTaskResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-outposts 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.outposts.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GetCapacityTaskResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* ID of the capacity task.
*
*/
private String capacityTaskId;
/**
*
* ID of the Outpost associated with the specified capacity task.
*
*/
private String outpostId;
/**
*
* ID of the Amazon Web Services Outposts order associated with the specified capacity task.
*
*/
private String orderId;
/**
*
* List of instance pools requested in the capacity task.
*
*/
private java.util.List requestedInstancePools;
/**
*
* Performs a dry run to determine if you are above or below instance capacity.
*
*/
private Boolean dryRun;
/**
*
* Status of the capacity task.
*
*
* A capacity task can have one of the following statuses:
*
*
* -
*
* REQUESTED - The capacity task was created and is awaiting the next step by Amazon Web Services
* Outposts.
*
*
* -
*
* IN_PROGRESS - The capacity task is running and cannot be cancelled.
*
*
* -
*
* WAITING_FOR_EVACUATION - The capacity task requires capacity to run. You must stop the recommended
* EC2 running instances to free up capacity for the task to run.
*
*
*
*/
private String capacityTaskStatus;
/**
*
* Reason why the capacity task failed.
*
*/
private CapacityTaskFailure failed;
/**
*
* The date the capacity task was created.
*
*/
private java.util.Date creationDate;
/**
*
* The date the capacity task ran successfully.
*
*/
private java.util.Date completionDate;
/**
*
* The date the capacity task was last modified.
*
*/
private java.util.Date lastModifiedDate;
/**
*
* ID of the capacity task.
*
*
* @param capacityTaskId
* ID of the capacity task.
*/
public void setCapacityTaskId(String capacityTaskId) {
this.capacityTaskId = capacityTaskId;
}
/**
*
* ID of the capacity task.
*
*
* @return ID of the capacity task.
*/
public String getCapacityTaskId() {
return this.capacityTaskId;
}
/**
*
* ID of the capacity task.
*
*
* @param capacityTaskId
* ID of the capacity task.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetCapacityTaskResult withCapacityTaskId(String capacityTaskId) {
setCapacityTaskId(capacityTaskId);
return this;
}
/**
*
* ID of the Outpost associated with the specified capacity task.
*
*
* @param outpostId
* ID of the Outpost associated with the specified capacity task.
*/
public void setOutpostId(String outpostId) {
this.outpostId = outpostId;
}
/**
*
* ID of the Outpost associated with the specified capacity task.
*
*
* @return ID of the Outpost associated with the specified capacity task.
*/
public String getOutpostId() {
return this.outpostId;
}
/**
*
* ID of the Outpost associated with the specified capacity task.
*
*
* @param outpostId
* ID of the Outpost associated with the specified capacity task.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetCapacityTaskResult withOutpostId(String outpostId) {
setOutpostId(outpostId);
return this;
}
/**
*
* ID of the Amazon Web Services Outposts order associated with the specified capacity task.
*
*
* @param orderId
* ID of the Amazon Web Services Outposts order associated with the specified capacity task.
*/
public void setOrderId(String orderId) {
this.orderId = orderId;
}
/**
*
* ID of the Amazon Web Services Outposts order associated with the specified capacity task.
*
*
* @return ID of the Amazon Web Services Outposts order associated with the specified capacity task.
*/
public String getOrderId() {
return this.orderId;
}
/**
*
* ID of the Amazon Web Services Outposts order associated with the specified capacity task.
*
*
* @param orderId
* ID of the Amazon Web Services Outposts order associated with the specified capacity task.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetCapacityTaskResult withOrderId(String orderId) {
setOrderId(orderId);
return this;
}
/**
*
* List of instance pools requested in the capacity task.
*
*
* @return List of instance pools requested in the capacity task.
*/
public java.util.List getRequestedInstancePools() {
return requestedInstancePools;
}
/**
*
* List of instance pools requested in the capacity task.
*
*
* @param requestedInstancePools
* List of instance pools requested in the capacity task.
*/
public void setRequestedInstancePools(java.util.Collection requestedInstancePools) {
if (requestedInstancePools == null) {
this.requestedInstancePools = null;
return;
}
this.requestedInstancePools = new java.util.ArrayList(requestedInstancePools);
}
/**
*
* List of instance pools requested in the capacity task.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setRequestedInstancePools(java.util.Collection)} or
* {@link #withRequestedInstancePools(java.util.Collection)} if you want to override the existing values.
*
*
* @param requestedInstancePools
* List of instance pools requested in the capacity task.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetCapacityTaskResult withRequestedInstancePools(InstanceTypeCapacity... requestedInstancePools) {
if (this.requestedInstancePools == null) {
setRequestedInstancePools(new java.util.ArrayList(requestedInstancePools.length));
}
for (InstanceTypeCapacity ele : requestedInstancePools) {
this.requestedInstancePools.add(ele);
}
return this;
}
/**
*
* List of instance pools requested in the capacity task.
*
*
* @param requestedInstancePools
* List of instance pools requested in the capacity task.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetCapacityTaskResult withRequestedInstancePools(java.util.Collection requestedInstancePools) {
setRequestedInstancePools(requestedInstancePools);
return this;
}
/**
*
* Performs a dry run to determine if you are above or below instance capacity.
*
*
* @param dryRun
* Performs a dry run to determine if you are above or below instance capacity.
*/
public void setDryRun(Boolean dryRun) {
this.dryRun = dryRun;
}
/**
*
* Performs a dry run to determine if you are above or below instance capacity.
*
*
* @return Performs a dry run to determine if you are above or below instance capacity.
*/
public Boolean getDryRun() {
return this.dryRun;
}
/**
*
* Performs a dry run to determine if you are above or below instance capacity.
*
*
* @param dryRun
* Performs a dry run to determine if you are above or below instance capacity.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetCapacityTaskResult withDryRun(Boolean dryRun) {
setDryRun(dryRun);
return this;
}
/**
*
* Performs a dry run to determine if you are above or below instance capacity.
*
*
* @return Performs a dry run to determine if you are above or below instance capacity.
*/
public Boolean isDryRun() {
return this.dryRun;
}
/**
*
* Status of the capacity task.
*
*
* A capacity task can have one of the following statuses:
*
*
* -
*
* REQUESTED - The capacity task was created and is awaiting the next step by Amazon Web Services
* Outposts.
*
*
* -
*
* IN_PROGRESS - The capacity task is running and cannot be cancelled.
*
*
* -
*
* WAITING_FOR_EVACUATION - The capacity task requires capacity to run. You must stop the recommended
* EC2 running instances to free up capacity for the task to run.
*
*
*
*
* @param capacityTaskStatus
* Status of the capacity task.
*
* A capacity task can have one of the following statuses:
*
*
* -
*
* REQUESTED - The capacity task was created and is awaiting the next step by Amazon Web
* Services Outposts.
*
*
* -
*
* IN_PROGRESS - The capacity task is running and cannot be cancelled.
*
*
* -
*
* WAITING_FOR_EVACUATION - The capacity task requires capacity to run. You must stop the
* recommended EC2 running instances to free up capacity for the task to run.
*
*
* @see CapacityTaskStatus
*/
public void setCapacityTaskStatus(String capacityTaskStatus) {
this.capacityTaskStatus = capacityTaskStatus;
}
/**
*
* Status of the capacity task.
*
*
* A capacity task can have one of the following statuses:
*
*
* -
*
* REQUESTED - The capacity task was created and is awaiting the next step by Amazon Web Services
* Outposts.
*
*
* -
*
* IN_PROGRESS - The capacity task is running and cannot be cancelled.
*
*
* -
*
* WAITING_FOR_EVACUATION - The capacity task requires capacity to run. You must stop the recommended
* EC2 running instances to free up capacity for the task to run.
*
*
*
*
* @return Status of the capacity task.
*
* A capacity task can have one of the following statuses:
*
*
* -
*
* REQUESTED - The capacity task was created and is awaiting the next step by Amazon Web
* Services Outposts.
*
*
* -
*
* IN_PROGRESS - The capacity task is running and cannot be cancelled.
*
*
* -
*
* WAITING_FOR_EVACUATION - The capacity task requires capacity to run. You must stop the
* recommended EC2 running instances to free up capacity for the task to run.
*
*
* @see CapacityTaskStatus
*/
public String getCapacityTaskStatus() {
return this.capacityTaskStatus;
}
/**
*
* Status of the capacity task.
*
*
* A capacity task can have one of the following statuses:
*
*
* -
*
* REQUESTED - The capacity task was created and is awaiting the next step by Amazon Web Services
* Outposts.
*
*
* -
*
* IN_PROGRESS - The capacity task is running and cannot be cancelled.
*
*
* -
*
* WAITING_FOR_EVACUATION - The capacity task requires capacity to run. You must stop the recommended
* EC2 running instances to free up capacity for the task to run.
*
*
*
*
* @param capacityTaskStatus
* Status of the capacity task.
*
* A capacity task can have one of the following statuses:
*
*
* -
*
* REQUESTED - The capacity task was created and is awaiting the next step by Amazon Web
* Services Outposts.
*
*
* -
*
* IN_PROGRESS - The capacity task is running and cannot be cancelled.
*
*
* -
*
* WAITING_FOR_EVACUATION - The capacity task requires capacity to run. You must stop the
* recommended EC2 running instances to free up capacity for the task to run.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see CapacityTaskStatus
*/
public GetCapacityTaskResult withCapacityTaskStatus(String capacityTaskStatus) {
setCapacityTaskStatus(capacityTaskStatus);
return this;
}
/**
*
* Status of the capacity task.
*
*
* A capacity task can have one of the following statuses:
*
*
* -
*
* REQUESTED - The capacity task was created and is awaiting the next step by Amazon Web Services
* Outposts.
*
*
* -
*
* IN_PROGRESS - The capacity task is running and cannot be cancelled.
*
*
* -
*
* WAITING_FOR_EVACUATION - The capacity task requires capacity to run. You must stop the recommended
* EC2 running instances to free up capacity for the task to run.
*
*
*
*
* @param capacityTaskStatus
* Status of the capacity task.
*
* A capacity task can have one of the following statuses:
*
*
* -
*
* REQUESTED - The capacity task was created and is awaiting the next step by Amazon Web
* Services Outposts.
*
*
* -
*
* IN_PROGRESS - The capacity task is running and cannot be cancelled.
*
*
* -
*
* WAITING_FOR_EVACUATION - The capacity task requires capacity to run. You must stop the
* recommended EC2 running instances to free up capacity for the task to run.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see CapacityTaskStatus
*/
public GetCapacityTaskResult withCapacityTaskStatus(CapacityTaskStatus capacityTaskStatus) {
this.capacityTaskStatus = capacityTaskStatus.toString();
return this;
}
/**
*
* Reason why the capacity task failed.
*
*
* @param failed
* Reason why the capacity task failed.
*/
public void setFailed(CapacityTaskFailure failed) {
this.failed = failed;
}
/**
*
* Reason why the capacity task failed.
*
*
* @return Reason why the capacity task failed.
*/
public CapacityTaskFailure getFailed() {
return this.failed;
}
/**
*
* Reason why the capacity task failed.
*
*
* @param failed
* Reason why the capacity task failed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetCapacityTaskResult withFailed(CapacityTaskFailure failed) {
setFailed(failed);
return this;
}
/**
*
* The date the capacity task was created.
*
*
* @param creationDate
* The date the capacity task was created.
*/
public void setCreationDate(java.util.Date creationDate) {
this.creationDate = creationDate;
}
/**
*
* The date the capacity task was created.
*
*
* @return The date the capacity task was created.
*/
public java.util.Date getCreationDate() {
return this.creationDate;
}
/**
*
* The date the capacity task was created.
*
*
* @param creationDate
* The date the capacity task was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetCapacityTaskResult withCreationDate(java.util.Date creationDate) {
setCreationDate(creationDate);
return this;
}
/**
*
* The date the capacity task ran successfully.
*
*
* @param completionDate
* The date the capacity task ran successfully.
*/
public void setCompletionDate(java.util.Date completionDate) {
this.completionDate = completionDate;
}
/**
*
* The date the capacity task ran successfully.
*
*
* @return The date the capacity task ran successfully.
*/
public java.util.Date getCompletionDate() {
return this.completionDate;
}
/**
*
* The date the capacity task ran successfully.
*
*
* @param completionDate
* The date the capacity task ran successfully.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetCapacityTaskResult withCompletionDate(java.util.Date completionDate) {
setCompletionDate(completionDate);
return this;
}
/**
*
* The date the capacity task was last modified.
*
*
* @param lastModifiedDate
* The date the capacity task was last modified.
*/
public void setLastModifiedDate(java.util.Date lastModifiedDate) {
this.lastModifiedDate = lastModifiedDate;
}
/**
*
* The date the capacity task was last modified.
*
*
* @return The date the capacity task was last modified.
*/
public java.util.Date getLastModifiedDate() {
return this.lastModifiedDate;
}
/**
*
* The date the capacity task was last modified.
*
*
* @param lastModifiedDate
* The date the capacity task was last modified.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetCapacityTaskResult withLastModifiedDate(java.util.Date lastModifiedDate) {
setLastModifiedDate(lastModifiedDate);
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 (getCapacityTaskId() != null)
sb.append("CapacityTaskId: ").append(getCapacityTaskId()).append(",");
if (getOutpostId() != null)
sb.append("OutpostId: ").append(getOutpostId()).append(",");
if (getOrderId() != null)
sb.append("OrderId: ").append(getOrderId()).append(",");
if (getRequestedInstancePools() != null)
sb.append("RequestedInstancePools: ").append(getRequestedInstancePools()).append(",");
if (getDryRun() != null)
sb.append("DryRun: ").append(getDryRun()).append(",");
if (getCapacityTaskStatus() != null)
sb.append("CapacityTaskStatus: ").append(getCapacityTaskStatus()).append(",");
if (getFailed() != null)
sb.append("Failed: ").append(getFailed()).append(",");
if (getCreationDate() != null)
sb.append("CreationDate: ").append(getCreationDate()).append(",");
if (getCompletionDate() != null)
sb.append("CompletionDate: ").append(getCompletionDate()).append(",");
if (getLastModifiedDate() != null)
sb.append("LastModifiedDate: ").append(getLastModifiedDate());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetCapacityTaskResult == false)
return false;
GetCapacityTaskResult other = (GetCapacityTaskResult) obj;
if (other.getCapacityTaskId() == null ^ this.getCapacityTaskId() == null)
return false;
if (other.getCapacityTaskId() != null && other.getCapacityTaskId().equals(this.getCapacityTaskId()) == false)
return false;
if (other.getOutpostId() == null ^ this.getOutpostId() == null)
return false;
if (other.getOutpostId() != null && other.getOutpostId().equals(this.getOutpostId()) == false)
return false;
if (other.getOrderId() == null ^ this.getOrderId() == null)
return false;
if (other.getOrderId() != null && other.getOrderId().equals(this.getOrderId()) == false)
return false;
if (other.getRequestedInstancePools() == null ^ this.getRequestedInstancePools() == null)
return false;
if (other.getRequestedInstancePools() != null && other.getRequestedInstancePools().equals(this.getRequestedInstancePools()) == false)
return false;
if (other.getDryRun() == null ^ this.getDryRun() == null)
return false;
if (other.getDryRun() != null && other.getDryRun().equals(this.getDryRun()) == false)
return false;
if (other.getCapacityTaskStatus() == null ^ this.getCapacityTaskStatus() == null)
return false;
if (other.getCapacityTaskStatus() != null && other.getCapacityTaskStatus().equals(this.getCapacityTaskStatus()) == false)
return false;
if (other.getFailed() == null ^ this.getFailed() == null)
return false;
if (other.getFailed() != null && other.getFailed().equals(this.getFailed()) == false)
return false;
if (other.getCreationDate() == null ^ this.getCreationDate() == null)
return false;
if (other.getCreationDate() != null && other.getCreationDate().equals(this.getCreationDate()) == false)
return false;
if (other.getCompletionDate() == null ^ this.getCompletionDate() == null)
return false;
if (other.getCompletionDate() != null && other.getCompletionDate().equals(this.getCompletionDate()) == false)
return false;
if (other.getLastModifiedDate() == null ^ this.getLastModifiedDate() == null)
return false;
if (other.getLastModifiedDate() != null && other.getLastModifiedDate().equals(this.getLastModifiedDate()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getCapacityTaskId() == null) ? 0 : getCapacityTaskId().hashCode());
hashCode = prime * hashCode + ((getOutpostId() == null) ? 0 : getOutpostId().hashCode());
hashCode = prime * hashCode + ((getOrderId() == null) ? 0 : getOrderId().hashCode());
hashCode = prime * hashCode + ((getRequestedInstancePools() == null) ? 0 : getRequestedInstancePools().hashCode());
hashCode = prime * hashCode + ((getDryRun() == null) ? 0 : getDryRun().hashCode());
hashCode = prime * hashCode + ((getCapacityTaskStatus() == null) ? 0 : getCapacityTaskStatus().hashCode());
hashCode = prime * hashCode + ((getFailed() == null) ? 0 : getFailed().hashCode());
hashCode = prime * hashCode + ((getCreationDate() == null) ? 0 : getCreationDate().hashCode());
hashCode = prime * hashCode + ((getCompletionDate() == null) ? 0 : getCompletionDate().hashCode());
hashCode = prime * hashCode + ((getLastModifiedDate() == null) ? 0 : getLastModifiedDate().hashCode());
return hashCode;
}
@Override
public GetCapacityTaskResult clone() {
try {
return (GetCapacityTaskResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}