com.amazonaws.services.ec2.model.DescribeInstanceTopologyRequest 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.DescribeInstanceTopologyRequestMarshaller;
/**
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeInstanceTopologyRequest extends AmazonWebServiceRequest implements Serializable, Cloneable,
DryRunSupportedRequest {
/**
*
* 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 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.
*
*
* You can't specify this parameter and the instance IDs parameter in the same request.
*
*
* Default: 20
*
*/
private Integer maxResults;
/**
*
* The instance IDs.
*
*
* Default: Describes all your instances.
*
*
* Constraints: Maximum 100 explicitly specified instance IDs.
*
*/
private com.amazonaws.internal.SdkInternalList instanceIds;
/**
*
* The name of the placement group that each instance is in.
*
*
* Constraints: Maximum 100 explicitly specified placement group names.
*
*/
private com.amazonaws.internal.SdkInternalList groupNames;
/**
*
* The filters.
*
*
* -
*
* availability-zone - The name of the Availability Zone (for example, us-west-2a) or
* Local Zone (for example, us-west-2-lax-1b) that the instance is in.
*
*
* -
*
* instance-type - The instance type (for example, p4d.24xlarge) or instance family (for
* example, p4d*). You can use the * wildcard to match zero or more characters, or the
* ? wildcard to match zero or one character.
*
*
* -
*
* zone-id - The ID of the Availability Zone (for example, usw2-az2) or Local Zone (for
* example, usw2-lax1-az1) that the instance is in.
*
*
*
*/
private com.amazonaws.internal.SdkInternalList filters;
/**
*
* 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 DescribeInstanceTopologyRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* 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.
*
*
* You can't specify this parameter and the instance IDs parameter in the same request.
*
*
* Default: 20
*
*
* @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.
*
* You can't specify this parameter and the instance IDs parameter in the same request.
*
*
* Default: 20
*/
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.
*
*
* You can't specify this parameter and the instance IDs parameter in the same request.
*
*
* Default: 20
*
*
* @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.
*
* You can't specify this parameter and the instance IDs parameter in the same request.
*
*
* Default: 20
*/
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.
*
*
* You can't specify this parameter and the instance IDs parameter in the same request.
*
*
* Default: 20
*
*
* @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.
*
* You can't specify this parameter and the instance IDs parameter in the same request.
*
*
* Default: 20
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeInstanceTopologyRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* The instance IDs.
*
*
* Default: Describes all your instances.
*
*
* Constraints: Maximum 100 explicitly specified instance IDs.
*
*
* @return The instance IDs.
*
* Default: Describes all your instances.
*
*
* Constraints: Maximum 100 explicitly specified instance IDs.
*/
public java.util.List getInstanceIds() {
if (instanceIds == null) {
instanceIds = new com.amazonaws.internal.SdkInternalList();
}
return instanceIds;
}
/**
*
* The instance IDs.
*
*
* Default: Describes all your instances.
*
*
* Constraints: Maximum 100 explicitly specified instance IDs.
*
*
* @param instanceIds
* The instance IDs.
*
* Default: Describes all your instances.
*
*
* Constraints: Maximum 100 explicitly specified instance IDs.
*/
public void setInstanceIds(java.util.Collection instanceIds) {
if (instanceIds == null) {
this.instanceIds = null;
return;
}
this.instanceIds = new com.amazonaws.internal.SdkInternalList(instanceIds);
}
/**
*
* The instance IDs.
*
*
* Default: Describes all your instances.
*
*
* Constraints: Maximum 100 explicitly specified instance IDs.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setInstanceIds(java.util.Collection)} or {@link #withInstanceIds(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param instanceIds
* The instance IDs.
*
* Default: Describes all your instances.
*
*
* Constraints: Maximum 100 explicitly specified instance IDs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeInstanceTopologyRequest withInstanceIds(String... instanceIds) {
if (this.instanceIds == null) {
setInstanceIds(new com.amazonaws.internal.SdkInternalList(instanceIds.length));
}
for (String ele : instanceIds) {
this.instanceIds.add(ele);
}
return this;
}
/**
*
* The instance IDs.
*
*
* Default: Describes all your instances.
*
*
* Constraints: Maximum 100 explicitly specified instance IDs.
*
*
* @param instanceIds
* The instance IDs.
*
* Default: Describes all your instances.
*
*
* Constraints: Maximum 100 explicitly specified instance IDs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeInstanceTopologyRequest withInstanceIds(java.util.Collection instanceIds) {
setInstanceIds(instanceIds);
return this;
}
/**
*
* The name of the placement group that each instance is in.
*
*
* Constraints: Maximum 100 explicitly specified placement group names.
*
*
* @return The name of the placement group that each instance is in.
*
* Constraints: Maximum 100 explicitly specified placement group names.
*/
public java.util.List getGroupNames() {
if (groupNames == null) {
groupNames = new com.amazonaws.internal.SdkInternalList();
}
return groupNames;
}
/**
*
* The name of the placement group that each instance is in.
*
*
* Constraints: Maximum 100 explicitly specified placement group names.
*
*
* @param groupNames
* The name of the placement group that each instance is in.
*
* Constraints: Maximum 100 explicitly specified placement group names.
*/
public void setGroupNames(java.util.Collection groupNames) {
if (groupNames == null) {
this.groupNames = null;
return;
}
this.groupNames = new com.amazonaws.internal.SdkInternalList(groupNames);
}
/**
*
* The name of the placement group that each instance is in.
*
*
* Constraints: Maximum 100 explicitly specified placement group names.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setGroupNames(java.util.Collection)} or {@link #withGroupNames(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param groupNames
* The name of the placement group that each instance is in.
*
* Constraints: Maximum 100 explicitly specified placement group names.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeInstanceTopologyRequest withGroupNames(String... groupNames) {
if (this.groupNames == null) {
setGroupNames(new com.amazonaws.internal.SdkInternalList(groupNames.length));
}
for (String ele : groupNames) {
this.groupNames.add(ele);
}
return this;
}
/**
*
* The name of the placement group that each instance is in.
*
*
* Constraints: Maximum 100 explicitly specified placement group names.
*
*
* @param groupNames
* The name of the placement group that each instance is in.
*
* Constraints: Maximum 100 explicitly specified placement group names.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeInstanceTopologyRequest withGroupNames(java.util.Collection groupNames) {
setGroupNames(groupNames);
return this;
}
/**
*
* The filters.
*
*
* -
*
* availability-zone - The name of the Availability Zone (for example, us-west-2a) or
* Local Zone (for example, us-west-2-lax-1b) that the instance is in.
*
*
* -
*
* instance-type - The instance type (for example, p4d.24xlarge) or instance family (for
* example, p4d*). You can use the * wildcard to match zero or more characters, or the
* ? wildcard to match zero or one character.
*
*
* -
*
* zone-id - The ID of the Availability Zone (for example, usw2-az2) or Local Zone (for
* example, usw2-lax1-az1) that the instance is in.
*
*
*
*
* @return The filters.
*
* -
*
* availability-zone - The name of the Availability Zone (for example, us-west-2a)
* or Local Zone (for example, us-west-2-lax-1b) that the instance is in.
*
*
* -
*
* instance-type - The instance type (for example, p4d.24xlarge) or instance
* family (for example, p4d*). You can use the * wildcard to match zero or more
* characters, or the ? wildcard to match zero or one character.
*
*
* -
*
* zone-id - The ID of the Availability Zone (for example, usw2-az2) or Local Zone
* (for example, usw2-lax1-az1) that the instance is in.
*
*
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.SdkInternalList();
}
return filters;
}
/**
*
* The filters.
*
*
* -
*
* availability-zone - The name of the Availability Zone (for example, us-west-2a) or
* Local Zone (for example, us-west-2-lax-1b) that the instance is in.
*
*
* -
*
* instance-type - The instance type (for example, p4d.24xlarge) or instance family (for
* example, p4d*). You can use the * wildcard to match zero or more characters, or the
* ? wildcard to match zero or one character.
*
*
* -
*
* zone-id - The ID of the Availability Zone (for example, usw2-az2) or Local Zone (for
* example, usw2-lax1-az1) that the instance is in.
*
*
*
*
* @param filters
* The filters.
*
* -
*
* availability-zone - The name of the Availability Zone (for example, us-west-2a)
* or Local Zone (for example, us-west-2-lax-1b) that the instance is in.
*
*
* -
*
* instance-type - The instance type (for example, p4d.24xlarge) or instance family
* (for example, p4d*). You can use the * wildcard to match zero or more
* characters, or the ? wildcard to match zero or one character.
*
*
* -
*
* zone-id - The ID of the Availability Zone (for example, usw2-az2) or Local Zone
* (for example, usw2-lax1-az1) that the instance is in.
*
*
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new com.amazonaws.internal.SdkInternalList(filters);
}
/**
*
* The filters.
*
*
* -
*
* availability-zone - The name of the Availability Zone (for example, us-west-2a) or
* Local Zone (for example, us-west-2-lax-1b) that the instance is in.
*
*
* -
*
* instance-type - The instance type (for example, p4d.24xlarge) or instance family (for
* example, p4d*). You can use the * wildcard to match zero or more characters, or the
* ? wildcard to match zero or one character.
*
*
* -
*
* zone-id - The ID of the Availability Zone (for example, usw2-az2) or Local Zone (for
* example, usw2-lax1-az1) that the instance is in.
*
*
*
*
* 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.
*
* -
*
* availability-zone - The name of the Availability Zone (for example, us-west-2a)
* or Local Zone (for example, us-west-2-lax-1b) that the instance is in.
*
*
* -
*
* instance-type - The instance type (for example, p4d.24xlarge) or instance family
* (for example, p4d*). You can use the * wildcard to match zero or more
* characters, or the ? wildcard to match zero or one character.
*
*
* -
*
* zone-id - The ID of the Availability Zone (for example, usw2-az2) or Local Zone
* (for example, usw2-lax1-az1) that the instance is in.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeInstanceTopologyRequest 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.
*
*
* -
*
* availability-zone - The name of the Availability Zone (for example, us-west-2a) or
* Local Zone (for example, us-west-2-lax-1b) that the instance is in.
*
*
* -
*
* instance-type - The instance type (for example, p4d.24xlarge) or instance family (for
* example, p4d*). You can use the * wildcard to match zero or more characters, or the
* ? wildcard to match zero or one character.
*
*
* -
*
* zone-id - The ID of the Availability Zone (for example, usw2-az2) or Local Zone (for
* example, usw2-lax1-az1) that the instance is in.
*
*
*
*
* @param filters
* The filters.
*
* -
*
* availability-zone - The name of the Availability Zone (for example, us-west-2a)
* or Local Zone (for example, us-west-2-lax-1b) that the instance is in.
*
*
* -
*
* instance-type - The instance type (for example, p4d.24xlarge) or instance family
* (for example, p4d*). You can use the * wildcard to match zero or more
* characters, or the ? wildcard to match zero or one character.
*
*
* -
*
* zone-id - The ID of the Availability Zone (for example, usw2-az2) or Local Zone
* (for example, usw2-lax1-az1) that the instance is in.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeInstanceTopologyRequest 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 DescribeInstanceTopologyRequestMarshaller().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 (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getInstanceIds() != null)
sb.append("InstanceIds: ").append(getInstanceIds()).append(",");
if (getGroupNames() != null)
sb.append("GroupNames: ").append(getGroupNames()).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 DescribeInstanceTopologyRequest == false)
return false;
DescribeInstanceTopologyRequest other = (DescribeInstanceTopologyRequest) obj;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
if (other.getInstanceIds() == null ^ this.getInstanceIds() == null)
return false;
if (other.getInstanceIds() != null && other.getInstanceIds().equals(this.getInstanceIds()) == false)
return false;
if (other.getGroupNames() == null ^ this.getGroupNames() == null)
return false;
if (other.getGroupNames() != null && other.getGroupNames().equals(this.getGroupNames()) == 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 + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getInstanceIds() == null) ? 0 : getInstanceIds().hashCode());
hashCode = prime * hashCode + ((getGroupNames() == null) ? 0 : getGroupNames().hashCode());
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
return hashCode;
}
@Override
public DescribeInstanceTopologyRequest clone() {
return (DescribeInstanceTopologyRequest) super.clone();
}
}