com.amazonaws.services.opsworks.model

Class DescribeElasticIpsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.opsworks.model.DescribeElasticIpsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeElasticIpsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeElasticIps operation.

Describes Elastic IP addresses .

NOTE: You must specify at least one of the parameters.

Required Permissions : To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .

See Also:

AWSOpsWorks.describeElasticIps(DescribeElasticIpsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeElasticIpsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeElasticIpsRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getInstanceId() The instance ID.
List<String>	getIps() An array of Elastic IP addresses to be described.
String	getStackId() A stack ID.
int	hashCode()
void	setInstanceId(String instanceId) The instance ID.
void	setIps(Collection<String> ips) An array of Elastic IP addresses to be described.
void	setStackId(String stackId) A stack ID.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeElasticIpsRequest	withInstanceId(String instanceId) The instance ID.
DescribeElasticIpsRequest	withIps(Collection<String> ips) An array of Elastic IP addresses to be described.
DescribeElasticIpsRequest	withIps(String... ips) An array of Elastic IP addresses to be described.
DescribeElasticIpsRequest	withStackId(String stackId) A stack ID.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeElasticIpsRequest

public DescribeElasticIpsRequest()

Method Detail

getInstanceId

public String getInstanceId()

The instance ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses associated with the specified instance.

Returns:

The instance ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses associated with the specified instance.

setInstanceId

public void setInstanceId(String instanceId)

The instance ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses associated with the specified instance.

Parameters:

instanceId - The instance ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses associated with the specified instance.

withInstanceId

public DescribeElasticIpsRequest withInstanceId(String instanceId)

The instance ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses associated with the specified instance.

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

Parameters:

instanceId - The instance ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses associated with the specified instance.

Returns:

A reference to this updated object so that method calls can be chained together.

getStackId

public String getStackId()

A stack ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses that are registered with the specified stack.

Returns:

A stack ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses that are registered with the specified stack.

setStackId

public void setStackId(String stackId)

A stack ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses that are registered with the specified stack.

Parameters:

stackId - A stack ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses that are registered with the specified stack.

withStackId

public DescribeElasticIpsRequest withStackId(String stackId)

A stack ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses that are registered with the specified stack.

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

Parameters:

stackId - A stack ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses that are registered with the specified stack.

Returns:

A reference to this updated object so that method calls can be chained together.

getIps

public List<String> getIps()

An array of Elastic IP addresses to be described. If you include this parameter, DescribeElasticIps returns a description of the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic IP address.

Returns:

An array of Elastic IP addresses to be described. If you include this parameter, DescribeElasticIps returns a description of the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic IP address.

setIps

public void setIps(Collection<String> ips)

An array of Elastic IP addresses to be described. If you include this parameter, DescribeElasticIps returns a description of the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic IP address.

Parameters:

ips - An array of Elastic IP addresses to be described. If you include this parameter, DescribeElasticIps returns a description of the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic IP address.

withIps

public DescribeElasticIpsRequest withIps(String... ips)

An array of Elastic IP addresses to be described. If you include this parameter, DescribeElasticIps returns a description of the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic IP address.

NOTE: This method appends the values to the existing list (if any). Use setIps(java.util.Collection) or withIps(java.util.Collection) if you want to override the existing values.

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

Parameters:

ips - An array of Elastic IP addresses to be described. If you include this parameter, DescribeElasticIps returns a description of the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic IP address.

Returns:

A reference to this updated object so that method calls can be chained together.

withIps

public DescribeElasticIpsRequest withIps(Collection<String> ips)

An array of Elastic IP addresses to be described. If you include this parameter, DescribeElasticIps returns a description of the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic IP address.

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

Parameters:

ips - An array of Elastic IP addresses to be described. If you include this parameter, DescribeElasticIps returns a description of the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic IP address.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public DescribeElasticIpsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()