com.amazonaws.services.ec2.model.DescribeFleetsRequest 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.DescribeFleetsRequestMarshaller;
/**
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeFleetsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest {
/**
*
* The maximum number of items to return for this request. To get the next page of items, make another request with
* the token returned in the output. For more information, see Pagination.
*
*/
private Integer maxResults;
/**
*
* The token returned from a previous paginated request. Pagination continues from the end of the items returned by
* the previous request.
*
*/
private String nextToken;
/**
*
* The IDs of the EC2 Fleets.
*
*
*
* If a fleet is of type instant, you must specify the fleet ID, otherwise it does not appear in the
* response.
*
*
*/
private com.amazonaws.internal.SdkInternalList fleetIds;
/**
*
* The filters.
*
*
* -
*
* activity-status - The progress of the EC2 Fleet ( error |
* pending-fulfillment | pending-termination | fulfilled).
*
*
* -
*
* excess-capacity-termination-policy - Indicates whether to terminate running instances if the target
* capacity is decreased below the current EC2 Fleet size (true | false).
*
*
* -
*
* fleet-state - The state of the EC2 Fleet (submitted | active |
* deleted | failed | deleted-running | deleted-terminating |
* modifying).
*
*
* -
*
* replace-unhealthy-instances - Indicates whether EC2 Fleet should replace unhealthy instances (
* true | false).
*
*
* -
*
* type - The type of request (instant | request | maintain).
*
*
*
*/
private com.amazonaws.internal.SdkInternalList filters;
/**
*
* The maximum number of items to return for this request. To get the next page of items, make another request with
* the token returned in the output. For more information, see Pagination.
*
*
* @param maxResults
* The maximum number of items to return for this request. To get the next page of items, make another
* request with the token returned in the output. For more information, see Pagination.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of items to return for this request. To get the next page of items, make another request with
* the token returned in the output. For more information, see Pagination.
*
*
* @return The maximum number of items to return for this request. To get the next page of items, make another
* request with the token returned in the output. For more information, see Pagination.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of items to return for this request. To get the next page of items, make another request with
* the token returned in the output. For more information, see Pagination.
*
*
* @param maxResults
* The maximum number of items to return for this request. To get the next page of items, make another
* request with the token returned in the output. For more information, see Pagination.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeFleetsRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* The token returned from a previous paginated request. Pagination continues from the end of the items returned by
* the previous request.
*
*
* @param nextToken
* The token returned from a previous paginated request. Pagination continues from the end of the items
* returned by the previous request.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The token returned from a previous paginated request. Pagination continues from the end of the items returned by
* the previous request.
*
*
* @return The token returned from a previous paginated request. Pagination continues from the end of the items
* returned by the previous request.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The token returned from a previous paginated request. Pagination continues from the end of the items returned by
* the previous request.
*
*
* @param nextToken
* The token returned from a previous paginated request. Pagination continues from the end of the items
* returned by the previous request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeFleetsRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The IDs of the EC2 Fleets.
*
*
*
* If a fleet is of type instant, you must specify the fleet ID, otherwise it does not appear in the
* response.
*
*
*
* @return The IDs of the EC2 Fleets.
*
* If a fleet is of type instant, you must specify the fleet ID, otherwise it does not appear
* in the response.
*
*/
public java.util.List getFleetIds() {
if (fleetIds == null) {
fleetIds = new com.amazonaws.internal.SdkInternalList();
}
return fleetIds;
}
/**
*
* The IDs of the EC2 Fleets.
*
*
*
* If a fleet is of type instant, you must specify the fleet ID, otherwise it does not appear in the
* response.
*
*
*
* @param fleetIds
* The IDs of the EC2 Fleets.
*
* If a fleet is of type instant, you must specify the fleet ID, otherwise it does not appear in
* the response.
*
*/
public void setFleetIds(java.util.Collection fleetIds) {
if (fleetIds == null) {
this.fleetIds = null;
return;
}
this.fleetIds = new com.amazonaws.internal.SdkInternalList(fleetIds);
}
/**
*
* The IDs of the EC2 Fleets.
*
*
*
* If a fleet is of type instant, you must specify the fleet ID, otherwise it does not appear in the
* response.
*
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setFleetIds(java.util.Collection)} or {@link #withFleetIds(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param fleetIds
* The IDs of the EC2 Fleets.
*
* If a fleet is of type instant, you must specify the fleet ID, otherwise it does not appear in
* the response.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeFleetsRequest withFleetIds(String... fleetIds) {
if (this.fleetIds == null) {
setFleetIds(new com.amazonaws.internal.SdkInternalList(fleetIds.length));
}
for (String ele : fleetIds) {
this.fleetIds.add(ele);
}
return this;
}
/**
*
* The IDs of the EC2 Fleets.
*
*
*
* If a fleet is of type instant, you must specify the fleet ID, otherwise it does not appear in the
* response.
*
*
*
* @param fleetIds
* The IDs of the EC2 Fleets.
*
* If a fleet is of type instant, you must specify the fleet ID, otherwise it does not appear in
* the response.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeFleetsRequest withFleetIds(java.util.Collection fleetIds) {
setFleetIds(fleetIds);
return this;
}
/**
*
* The filters.
*
*
* -
*
* activity-status - The progress of the EC2 Fleet ( error |
* pending-fulfillment | pending-termination | fulfilled).
*
*
* -
*
* excess-capacity-termination-policy - Indicates whether to terminate running instances if the target
* capacity is decreased below the current EC2 Fleet size (true | false).
*
*
* -
*
* fleet-state - The state of the EC2 Fleet (submitted | active |
* deleted | failed | deleted-running | deleted-terminating |
* modifying).
*
*
* -
*
* replace-unhealthy-instances - Indicates whether EC2 Fleet should replace unhealthy instances (
* true | false).
*
*
* -
*
* type - The type of request (instant | request | maintain).
*
*
*
*
* @return The filters.
*
* -
*
* activity-status - The progress of the EC2 Fleet ( error |
* pending-fulfillment | pending-termination | fulfilled).
*
*
* -
*
* excess-capacity-termination-policy - Indicates whether to terminate running instances if the
* target capacity is decreased below the current EC2 Fleet size (true | false).
*
*
* -
*
* fleet-state - The state of the EC2 Fleet (submitted | active |
* deleted | failed | deleted-running |
* deleted-terminating | modifying).
*
*
* -
*
* replace-unhealthy-instances - Indicates whether EC2 Fleet should replace unhealthy instances
* (true | false).
*
*
* -
*
* type - The type of request (instant | request |
* maintain).
*
*
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.SdkInternalList();
}
return filters;
}
/**
*
* The filters.
*
*
* -
*
* activity-status - The progress of the EC2 Fleet ( error |
* pending-fulfillment | pending-termination | fulfilled).
*
*
* -
*
* excess-capacity-termination-policy - Indicates whether to terminate running instances if the target
* capacity is decreased below the current EC2 Fleet size (true | false).
*
*
* -
*
* fleet-state - The state of the EC2 Fleet (submitted | active |
* deleted | failed | deleted-running | deleted-terminating |
* modifying).
*
*
* -
*
* replace-unhealthy-instances - Indicates whether EC2 Fleet should replace unhealthy instances (
* true | false).
*
*
* -
*
* type - The type of request (instant | request | maintain).
*
*
*
*
* @param filters
* The filters.
*
* -
*
* activity-status - The progress of the EC2 Fleet ( error |
* pending-fulfillment | pending-termination | fulfilled).
*
*
* -
*
* excess-capacity-termination-policy - Indicates whether to terminate running instances if the
* target capacity is decreased below the current EC2 Fleet size (true | false).
*
*
* -
*
* fleet-state - The state of the EC2 Fleet (submitted | active |
* deleted | failed | deleted-running |
* deleted-terminating | modifying).
*
*
* -
*
* replace-unhealthy-instances - Indicates whether EC2 Fleet should replace unhealthy instances
* (true | false).
*
*
* -
*
* type - The type of request (instant | request |
* maintain).
*
*
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new com.amazonaws.internal.SdkInternalList(filters);
}
/**
*
* The filters.
*
*
* -
*
* activity-status - The progress of the EC2 Fleet ( error |
* pending-fulfillment | pending-termination | fulfilled).
*
*
* -
*
* excess-capacity-termination-policy - Indicates whether to terminate running instances if the target
* capacity is decreased below the current EC2 Fleet size (true | false).
*
*
* -
*
* fleet-state - The state of the EC2 Fleet (submitted | active |
* deleted | failed | deleted-running | deleted-terminating |
* modifying).
*
*
* -
*
* replace-unhealthy-instances - Indicates whether EC2 Fleet should replace unhealthy instances (
* true | false).
*
*
* -
*
* type - The type of request (instant | request | maintain).
*
*
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setFilters(java.util.Collection)} or {@link #withFilters(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param filters
* The filters.
*
* -
*
* activity-status - The progress of the EC2 Fleet ( error |
* pending-fulfillment | pending-termination | fulfilled).
*
*
* -
*
* excess-capacity-termination-policy - Indicates whether to terminate running instances if the
* target capacity is decreased below the current EC2 Fleet size (true | false).
*
*
* -
*
* fleet-state - The state of the EC2 Fleet (submitted | active |
* deleted | failed | deleted-running |
* deleted-terminating | modifying).
*
*
* -
*
* replace-unhealthy-instances - Indicates whether EC2 Fleet should replace unhealthy instances
* (true | false).
*
*
* -
*
* type - The type of request (instant | request |
* maintain).
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeFleetsRequest withFilters(Filter... filters) {
if (this.filters == null) {
setFilters(new com.amazonaws.internal.SdkInternalList(filters.length));
}
for (Filter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
*
* The filters.
*
*
* -
*
* activity-status - The progress of the EC2 Fleet ( error |
* pending-fulfillment | pending-termination | fulfilled).
*
*
* -
*
* excess-capacity-termination-policy - Indicates whether to terminate running instances if the target
* capacity is decreased below the current EC2 Fleet size (true | false).
*
*
* -
*
* fleet-state - The state of the EC2 Fleet (submitted | active |
* deleted | failed | deleted-running | deleted-terminating |
* modifying).
*
*
* -
*
* replace-unhealthy-instances - Indicates whether EC2 Fleet should replace unhealthy instances (
* true | false).
*
*
* -
*
* type - The type of request (instant | request | maintain).
*
*
*
*
* @param filters
* The filters.
*
* -
*
* activity-status - The progress of the EC2 Fleet ( error |
* pending-fulfillment | pending-termination | fulfilled).
*
*
* -
*
* excess-capacity-termination-policy - Indicates whether to terminate running instances if the
* target capacity is decreased below the current EC2 Fleet size (true | false).
*
*
* -
*
* fleet-state - The state of the EC2 Fleet (submitted | active |
* deleted | failed | deleted-running |
* deleted-terminating | modifying).
*
*
* -
*
* replace-unhealthy-instances - Indicates whether EC2 Fleet should replace unhealthy instances
* (true | false).
*
*
* -
*
* type - The type of request (instant | request |
* maintain).
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeFleetsRequest withFilters(java.util.Collection filters) {
setFilters(filters);
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 DescribeFleetsRequestMarshaller().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 (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getFleetIds() != null)
sb.append("FleetIds: ").append(getFleetIds()).append(",");
if (getFilters() != null)
sb.append("Filters: ").append(getFilters());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeFleetsRequest == false)
return false;
DescribeFleetsRequest other = (DescribeFleetsRequest) obj;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getFleetIds() == null ^ this.getFleetIds() == null)
return false;
if (other.getFleetIds() != null && other.getFleetIds().equals(this.getFleetIds()) == false)
return false;
if (other.getFilters() == null ^ this.getFilters() == null)
return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getFleetIds() == null) ? 0 : getFleetIds().hashCode());
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
return hashCode;
}
@Override
public DescribeFleetsRequest clone() {
return (DescribeFleetsRequest) super.clone();
}
}