Did this page help you?

   Yes   No   Tell us about it...

com.amazonaws.services.ec2.model
Class DescribeSecurityGroupsRequest

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceRequest
      extended by com.amazonaws.services.ec2.model.DescribeSecurityGroupsRequest
All Implemented Interfaces:
java.io.Serializable

public class DescribeSecurityGroupsRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Container for the parameters to the DescribeSecurityGroups operation.

The DescribeSecurityGroups operation returns information about security groups that you own.

If you specify security group names, information about those security group is returned. Otherwise, information for all security group is returned. If you specify a group that does not exist, a fault is returned.

See Also:
AmazonEC2.describeSecurityGroups(DescribeSecurityGroupsRequest), Serialized Form

Constructor Summary
DescribeSecurityGroupsRequest()
           
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 java.util.List<Filter> getFilters()
          A list of filters used to match properties for SecurityGroups.
 java.util.List<java.lang.String> getGroupIds()
          Returns the value of the GroupIds property for this object.
 java.util.List<java.lang.String> getGroupNames()
          An optional list of group names that specify the Amazon EC2 security groups to describe.
 int hashCode()
           
 void setFilters(java.util.Collection<Filter> filters)
          A list of filters used to match properties for SecurityGroups.
 void setGroupIds(java.util.Collection<java.lang.String> groupIds)
          Sets the value of the GroupIds property for this object.
 void setGroupNames(java.util.Collection<java.lang.String> groupNames)
          An optional list of group names that specify the Amazon EC2 security groups to describe.
 java.lang.String toString()
          Returns a string representation of this object; useful for testing and debugging.
 DescribeSecurityGroupsRequest withFilters(java.util.Collection<Filter> filters)
          A list of filters used to match properties for SecurityGroups.
 DescribeSecurityGroupsRequest withFilters(Filter... filters)
          A list of filters used to match properties for SecurityGroups.
 DescribeSecurityGroupsRequest withGroupIds(java.util.Collection<java.lang.String> groupIds)
          Sets the value of the GroupIds property for this object.
 DescribeSecurityGroupsRequest withGroupIds(java.lang.String... groupIds)
          Sets the value of the GroupIds property for this object.
 DescribeSecurityGroupsRequest withGroupNames(java.util.Collection<java.lang.String> groupNames)
          An optional list of group names that specify the Amazon EC2 security groups to describe.
 DescribeSecurityGroupsRequest withGroupNames(java.lang.String... groupNames)
          An optional list of group names that specify the Amazon EC2 security groups to describe.
 
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DescribeSecurityGroupsRequest

public DescribeSecurityGroupsRequest()
Method Detail

getGroupNames

public java.util.List<java.lang.String> getGroupNames()
An optional list of group names that specify the Amazon EC2 security groups to describe.

Returns:
An optional list of group names that specify the Amazon EC2 security groups to describe.

setGroupNames

public void setGroupNames(java.util.Collection<java.lang.String> groupNames)
An optional list of group names that specify the Amazon EC2 security groups to describe.

Parameters:
groupNames - An optional list of group names that specify the Amazon EC2 security groups to describe.

withGroupNames

public DescribeSecurityGroupsRequest withGroupNames(java.lang.String... groupNames)
An optional list of group names that specify the Amazon EC2 security groups to describe.

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

Parameters:
groupNames - An optional list of group names that specify the Amazon EC2 security groups to describe.

withGroupNames

public DescribeSecurityGroupsRequest withGroupNames(java.util.Collection<java.lang.String> groupNames)
An optional list of group names that specify the Amazon EC2 security groups to describe.

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

Parameters:
groupNames - An optional list of group names that specify the Amazon EC2 security groups to describe.

getGroupIds

public java.util.List<java.lang.String> getGroupIds()
Returns the value of the GroupIds property for this object.

Returns:
The value of the GroupIds property for this object.

setGroupIds

public void setGroupIds(java.util.Collection<java.lang.String> groupIds)
Sets the value of the GroupIds property for this object.

Parameters:
groupIds - The new value for the GroupIds property for this object.

withGroupIds

public DescribeSecurityGroupsRequest withGroupIds(java.lang.String... groupIds)
Sets the value of the GroupIds property for this object.

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

Parameters:
groupIds - The new value for the GroupIds property for this object.

withGroupIds

public DescribeSecurityGroupsRequest withGroupIds(java.util.Collection<java.lang.String> groupIds)
Sets the value of the GroupIds property for this object.

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

Parameters:
groupIds - The new value for the GroupIds property for this object.

getFilters

public java.util.List<Filter> getFilters()
A list of filters used to match properties for SecurityGroups. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Returns:
A list of filters used to match properties for SecurityGroups. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

setFilters

public void setFilters(java.util.Collection<Filter> filters)
A list of filters used to match properties for SecurityGroups. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Parameters:
filters - A list of filters used to match properties for SecurityGroups. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

withFilters

public DescribeSecurityGroupsRequest withFilters(Filter... filters)
A list of filters used to match properties for SecurityGroups. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

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

Parameters:
filters - A list of filters used to match properties for SecurityGroups. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

withFilters

public DescribeSecurityGroupsRequest withFilters(java.util.Collection<Filter> filters)
A list of filters used to match properties for SecurityGroups. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

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

Parameters:
filters - A list of filters used to match properties for SecurityGroups. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

toString

public java.lang.String toString()
Returns a string representation of this object; useful for testing and debugging.

Overrides:
toString in class java.lang.Object
Returns:
A string representation of this object.
See Also:
Object.toString()

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object


Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.