DescribeSecurityGroupsRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.ec2.model.Ec2Request
    - - software.amazon.awssdk.services.ec2.model.DescribeSecurityGroupsRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeSecurityGroupsRequest.Builder,DescribeSecurityGroupsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeSecurityGroupsRequest
extends Ec2Request
implements ToCopyableBuilder<DescribeSecurityGroupsRequest.Builder,DescribeSecurityGroupsRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeSecurityGroupsRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeSecurityGroupsRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DescribeSecurityGroupsRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<Filter>`	`filters()` The filters.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`List<String>`	`groupIds()` The IDs of the security groups.
`List<String>`	`groupNames()` [EC2-Classic and default VPC only] The names of the security groups.
`boolean`	`hasFilters()` For responses, this returns true if the service returned a value for the Filters property.
`boolean`	`hasGroupIds()` For responses, this returns true if the service returned a value for the GroupIds property.
`boolean`	`hasGroupNames()` For responses, this returns true if the service returned a value for the GroupNames property.
`int`	`hashCode()`
`Integer`	`maxResults()` The maximum number of results to return in a single call.
`String`	`nextToken()` The token to request the next page of results.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeSecurityGroupsRequest.Builder>`	`serializableBuilderClass()`
`DescribeSecurityGroupsRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - hasFilters
```
public final boolean hasFilters()
```
    For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - filters
```
public final List<Filter> filters()
```
    The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.
    - description - The description of the security group.
    - egress.ip-permission.cidr - An IPv4 CIDR block for an outbound security group rule.
    - egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.
    - egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound security group rule.
    - egress.ip-permission.group-name - The name of a security group that is referenced in an outbound security group rule.
    - egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.
    - egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows outbound access.
    - egress.ip-permission.protocol - The IP protocol for an outbound security group rule ( tcp | udp | icmp, a protocol number, or -1 for all protocols).
    - egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.
    - egress.ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in an outbound security group rule.
    - group-id - The ID of the security group.
    - group-name - The name of the security group.
    - ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.
    - ip-permission.from-port - For an inbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.
    - ip-permission.group-id - The ID of a security group that has been referenced in an inbound security group rule.
    - ip-permission.group-name - The name of a security group that is referenced in an inbound security group rule.
    - ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.
    - ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows inbound access.
    - ip-permission.protocol - The IP protocol for an inbound security group rule (tcp | udp | icmp, a protocol number, or -1 for all protocols).
    - ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.
    - ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in an inbound security group rule.
    - owner-id - The Amazon Web Services account ID of the owner of the security group.
    - tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
    - tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
    - vpc-id - The ID of the VPC specified when the security group was created.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilters() method.
    Returns:
    The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.
    
    description - The description of the security group.
    
    egress.ip-permission.cidr - An IPv4 CIDR block for an outbound security group rule.
    
    egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.
    
    egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound security group rule.
    
    egress.ip-permission.group-name - The name of a security group that is referenced in an outbound security group rule.
    
    egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.
    
    egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows outbound access.
    
    egress.ip-permission.protocol - The IP protocol for an outbound security group rule ( tcp | udp | icmp, a protocol number, or -1 for all protocols).
    
    egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.
    
    egress.ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in an outbound security group rule.
    
    group-id - The ID of the security group.
    
    group-name - The name of the security group.
    
    ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.
    
    ip-permission.from-port - For an inbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.
    
    ip-permission.group-id - The ID of a security group that has been referenced in an inbound security group rule.
    
    ip-permission.group-name - The name of a security group that is referenced in an inbound security group rule.
    
    ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.
    
    ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows inbound access.
    
    ip-permission.protocol - The IP protocol for an inbound security group rule ( tcp | udp | icmp, a protocol number, or -1 for all protocols).
    
    ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.
    
    ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in an inbound security group rule.
    
    owner-id - The Amazon Web Services account ID of the owner of the security group.
    
    tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
    
    tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
    
    vpc-id - The ID of the VPC specified when the security group was created.
  - hasGroupIds
```
public final boolean hasGroupIds()
```
    For responses, this returns true if the service returned a value for the GroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - groupIds
```
public final List<String> groupIds()
```
    The IDs of the security groups. Required for security groups in a nondefault VPC.
    
    Default: Describes all of your security groups.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGroupIds() method.
    
    Returns:
    
    The IDs of the security groups. Required for security groups in a nondefault VPC.
    
    Default: Describes all of your security groups.
  - hasGroupNames
```
public final boolean hasGroupNames()
```
    For responses, this returns true if the service returned a value for the GroupNames property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - groupNames
```
public final List<String> groupNames()
```
    [EC2-Classic and default VPC only] The names of the security groups. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.
    
    Default: Describes all of your security groups.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGroupNames() method.
    
    Returns:
    
    [EC2-Classic and default VPC only] The names of the security groups. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.
    
    Default: Describes all of your security groups.
  - nextToken
```
public final String nextToken()
```
    The token to request the next page of results.
    
    Returns:
    
    The token to request the next page of results.
  - maxResults
```
public final Integer maxResults()
```
    The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value. This value can be between 5 and 1000. If this parameter is not specified, then all results are returned.
    
    Returns:
    
    The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value. This value can be between 5 and 1000. If this parameter is not specified, then all results are returned.
  - toBuilder
```
public DescribeSecurityGroupsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeSecurityGroupsRequest.Builder,DescribeSecurityGroupsRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static DescribeSecurityGroupsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeSecurityGroupsRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeSecurityGroupsRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasFilters

filters

hasGroupIds

groupIds

hasGroupNames

groupNames

nextToken

maxResults

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields