DescribeNetworkInterfacesRequest (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.DescribeNetworkInterfacesRequest

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

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

Contains the parameters for DescribeNetworkInterfaces.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeNetworkInterfacesRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DescribeNetworkInterfacesRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<Filter>`	`filters()` One or more filters.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasFilters()` For responses, this returns true if the service returned a value for the Filters property.
`int`	`hashCode()`
`boolean`	`hasNetworkInterfaceIds()` For responses, this returns true if the service returned a value for the NetworkInterfaceIds property.
`Integer`	`maxResults()` The maximum number of items to return for this request.
`List<String>`	`networkInterfaceIds()` One or more network interface IDs.
`String`	`nextToken()` The token to retrieve the next page of results.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeNetworkInterfacesRequest.Builder>`	`serializableBuilderClass()`
`DescribeNetworkInterfacesRequest.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()
```
    One or more filters.
    - addresses.private-ip-address - The private IPv4 addresses associated with the network interface.
    - addresses.primary - Whether the private IPv4 address is the primary IP address associated with the network interface.
    - addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address (IPv4).
    - addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
    - association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
    - association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
    - association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
    - association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
    - association.public-dns-name - The public DNS name for the network interface (IPv4).
    - attachment.attachment-id - The ID of the interface attachment.
    - attachment.attach-time - The time that the network interface was attached to an instance.
    - attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
    - attachment.device-index - The device index to which the network interface is attached.
    - attachment.instance-id - The ID of the instance to which the network interface is attached.
    - attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
    - attachment.status - The status of the attachment (attaching | attached | detaching | detached).
    - availability-zone - The Availability Zone of the network interface.
    - description - The description of the network interface.
    - group-id - The ID of a security group associated with the network interface.
    - group-name - The name of a security group associated with the network interface.
    - ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.
    - mac-address - The MAC address of the network interface.
    - network-interface-id - The ID of the network interface.
    - owner-id - The Amazon Web Services account ID of the network interface owner.
    - private-ip-address - The private IPv4 address or addresses of the network interface.
    - private-dns-name - The private DNS name of the network interface (IPv4).
    - requester-id - The alias or Amazon Web Services account ID of the principal or service that created the network interface.
    - requester-managed - Indicates whether the network interface is being managed by an Amazon Web Service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
    - source-dest-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
    - status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.
    - subnet-id - The ID of the subnet for the network interface.
    - 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 for the network interface.
    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:
    One or more filters.
    
    addresses.private-ip-address - The private IPv4 addresses associated with the network interface.
    
    addresses.primary - Whether the private IPv4 address is the primary IP address associated with the network interface.
    
    addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address (IPv4).
    
    addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
    
    association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
    
    association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
    
    association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
    
    association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
    
    association.public-dns-name - The public DNS name for the network interface (IPv4).
    
    attachment.attachment-id - The ID of the interface attachment.
    
    attachment.attach-time - The time that the network interface was attached to an instance.
    
    attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
    
    attachment.device-index - The device index to which the network interface is attached.
    
    attachment.instance-id - The ID of the instance to which the network interface is attached.
    
    attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
    
    attachment.status - The status of the attachment (attaching | attached | detaching | detached).
    
    availability-zone - The Availability Zone of the network interface.
    
    description - The description of the network interface.
    
    group-id - The ID of a security group associated with the network interface.
    
    group-name - The name of a security group associated with the network interface.
    
    ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.
    
    mac-address - The MAC address of the network interface.
    
    network-interface-id - The ID of the network interface.
    
    owner-id - The Amazon Web Services account ID of the network interface owner.
    
    private-ip-address - The private IPv4 address or addresses of the network interface.
    
    private-dns-name - The private DNS name of the network interface (IPv4).
    
    requester-id - The alias or Amazon Web Services account ID of the principal or service that created the network interface.
    
    requester-managed - Indicates whether the network interface is being managed by an Amazon Web Service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
    
    source-dest-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
    
    status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.
    
    subnet-id - The ID of the subnet for the network interface.
    
    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 for the network interface.
  - hasNetworkInterfaceIds
```
public final boolean hasNetworkInterfaceIds()
```
    For responses, this returns true if the service returned a value for the NetworkInterfaceIds 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.
  - networkInterfaceIds
```
public final List<String> networkInterfaceIds()
```
    One or more network interface IDs.
    
    Default: Describes all your network interfaces.
    
    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 hasNetworkInterfaceIds() method.
    
    Returns:
    
    One or more network interface IDs.
    
    Default: Describes all your network interfaces.
  - nextToken
```
public final String nextToken()
```
    The token to retrieve the next page of results.
    
    Returns:
    
    The token to retrieve the next page of results.
  - maxResults
```
public final Integer maxResults()
```
    The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. You cannot specify this parameter and the network interface IDs parameter in the same request.
    
    Returns:
    
    The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. You cannot specify this parameter and the network interface IDs parameter in the same request.
  - toBuilder
```
public DescribeNetworkInterfacesRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeNetworkInterfacesRequest.Builder,DescribeNetworkInterfacesRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static DescribeNetworkInterfacesRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeNetworkInterfacesRequest.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 DescribeNetworkInterfacesRequest

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

hasNetworkInterfaceIds

networkInterfaceIds

nextToken

maxResults

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields