com.amazonaws.services.ec2.model

Class DescribeInstanceTopologyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeInstanceTopologyRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<DescribeInstanceTopologyRequest>, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeInstanceTopologyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<DescribeInstanceTopologyRequest>

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeInstanceTopologyRequest()

Method Summary

Modifier and Type	Method and Description
DescribeInstanceTopologyRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Request<DescribeInstanceTopologyRequest>	getDryRunRequest() This method is intended for internal use only.
List<Filter>	getFilters() The filters.
List<String>	getGroupNames() The name of the placement group that each instance is in.
List<String>	getInstanceIds() The instance IDs.
Integer	getMaxResults() The maximum number of items to return for this request.
String	getNextToken() The token returned from a previous paginated request.
int	hashCode()
void	setFilters(Collection<Filter> filters) The filters.
void	setGroupNames(Collection<String> groupNames) The name of the placement group that each instance is in.
void	setInstanceIds(Collection<String> instanceIds) The instance IDs.
void	setMaxResults(Integer maxResults) The maximum number of items to return for this request.
void	setNextToken(String nextToken) The token returned from a previous paginated request.
String	toString() Returns a string representation of this object.
DescribeInstanceTopologyRequest	withFilters(Collection<Filter> filters) The filters.
DescribeInstanceTopologyRequest	withFilters(Filter... filters) The filters.
DescribeInstanceTopologyRequest	withGroupNames(Collection<String> groupNames) The name of the placement group that each instance is in.
DescribeInstanceTopologyRequest	withGroupNames(String... groupNames) The name of the placement group that each instance is in.
DescribeInstanceTopologyRequest	withInstanceIds(Collection<String> instanceIds) The instance IDs.
DescribeInstanceTopologyRequest	withInstanceIds(String... instanceIds) The instance IDs.
DescribeInstanceTopologyRequest	withMaxResults(Integer maxResults) The maximum number of items to return for this request.
DescribeInstanceTopologyRequest	withNextToken(String nextToken) The token returned from a previous paginated request.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeInstanceTopologyRequest

public DescribeInstanceTopologyRequest()

Method Detail

setNextToken

public void setNextToken(String nextToken)

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Parameters:

nextToken - The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

getNextToken

public String getNextToken()

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Returns:

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

withNextToken

public DescribeInstanceTopologyRequest withNextToken(String nextToken)

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Parameters:

nextToken - The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxResults

public void setMaxResults(Integer 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

Parameters:

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

getMaxResults

public Integer getMaxResults()

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

Returns:

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

withMaxResults

public DescribeInstanceTopologyRequest withMaxResults(Integer 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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getInstanceIds

public List<String> getInstanceIds()

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

Returns:

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

setInstanceIds

public void setInstanceIds(Collection<String> instanceIds)

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

Parameters:

instanceIds - The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

withInstanceIds

public DescribeInstanceTopologyRequest withInstanceIds(String... 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 setInstanceIds(java.util.Collection) or withInstanceIds(java.util.Collection) if you want to override the existing values.

Parameters:

instanceIds - The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

Returns:

Returns a reference to this object so that method calls can be chained together.

withInstanceIds

public DescribeInstanceTopologyRequest withInstanceIds(Collection<String> instanceIds)

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

Parameters:

instanceIds - The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

Returns:

Returns a reference to this object so that method calls can be chained together.

getGroupNames

public List<String> getGroupNames()

The name of the placement group that each instance is in.

Constraints: Maximum 100 explicitly specified placement group names.

Returns:

The name of the placement group that each instance is in.

Constraints: Maximum 100 explicitly specified placement group names.

setGroupNames

public void setGroupNames(Collection<String> groupNames)

The name of the placement group that each instance is in.

Constraints: Maximum 100 explicitly specified placement group names.

Parameters:

groupNames - The name of the placement group that each instance is in.

Constraints: Maximum 100 explicitly specified placement group names.

withGroupNames

public DescribeInstanceTopologyRequest withGroupNames(String... 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 setGroupNames(java.util.Collection) or withGroupNames(java.util.Collection) if you want to override the existing values.

Parameters:

groupNames - The name of the placement group that each instance is in.

Constraints: Maximum 100 explicitly specified placement group names.

Returns:

Returns a reference to this object so that method calls can be chained together.

withGroupNames

public DescribeInstanceTopologyRequest withGroupNames(Collection<String> groupNames)

The name of the placement group that each instance is in.

Constraints: Maximum 100 explicitly specified placement group names.

Parameters:

groupNames - The name of the placement group that each instance is in.

Constraints: Maximum 100 explicitly specified placement group names.

Returns:

Returns a reference to this object so that method calls can be chained together.

getFilters

public List<Filter> getFilters()

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.

Returns:

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.

setFilters

public void setFilters(Collection<Filter> 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.

Parameters:

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.

withFilters

public DescribeInstanceTopologyRequest withFilters(Filter... 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 setFilters(java.util.Collection) or withFilters(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withFilters

public DescribeInstanceTopologyRequest withFilters(Collection<Filter> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getDryRunRequest

public Request<DescribeInstanceTopologyRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<DescribeInstanceTopologyRequest>

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeInstanceTopologyRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()