Package software.amazon.awssdk.services.ec2.model

Class DescribeNetworkInterfacesRequest

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("software.amazon.awssdk:codegen") public final class DescribeNetworkInterfacesRequest extends Ec2Request implements ToCopyableBuilder<DescribeNetworkInterfacesRequest.Builder,DescribeNetworkInterfacesRequest>

Contains the parameters for DescribeNetworkInterfaces.

  • Method Details

    • 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.

      • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.

      • association.association-id - The association ID returned when the network interface was associated with an IPv4 address.

      • addresses.association.owner-id - The owner ID of the addresses 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.primary - Whether the private IPv4 address is the primary IP address associated with the network interface.

      • addresses.private-ip-address - The private IPv4 addresses associated with the 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.attach-time - The time that the network interface was attached to an instance.

      • attachment.attachment-id - The ID of the interface attachment.

      • 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.

      • ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.

      • interface-type - The type of network interface (api_gateway_managed | aws_codestar_connections_managed | branch | ec2_instance_connect_endpoint | efa | efs | gateway_load_balancer | gateway_load_balancer_endpoint | global_accelerator_managed | interface | iot_rules_managed | lambda | load_balancer | nat_gateway | network_load_balancer | quicksight | transit_gateway | trunk | vpc_endpoint).

      • 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-dns-name - The private DNS name of the network interface (IPv4).

      • private-ip-address - The private IPv4 address or addresses of the network interface.

      • 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 Services 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.

      • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.

      • association.association-id - The association ID returned when the network interface was associated with an IPv4 address.

      • addresses.association.owner-id - The owner ID of the addresses 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.primary - Whether the private IPv4 address is the primary IP address associated with the network interface.

      • addresses.private-ip-address - The private IPv4 addresses associated with the 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.attach-time - The time that the network interface was attached to an instance.

      • attachment.attachment-id - The ID of the interface attachment.

      • 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.

      • ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.

      • interface-type - The type of network interface (api_gateway_managed | aws_codestar_connections_managed | branch | ec2_instance_connect_endpoint | efa | efs | gateway_load_balancer | gateway_load_balancer_endpoint | global_accelerator_managed | interface | iot_rules_managed | lambda | load_balancer | nat_gateway | network_load_balancer | quicksight | transit_gateway | trunk | vpc_endpoint).

      • 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-dns-name - The private DNS name of the network interface (IPv4).

      • private-ip-address - The private IPv4 address or addresses of the network interface.

      • 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 Services 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.

    • dryRun

      public final Boolean dryRun()

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

      Returns:
      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • 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()

      The 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:
      The network interface IDs.

      Default: Describes all your network interfaces.

    • nextToken

      public final String nextToken()

      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.

    • maxResults

      public final 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. You cannot specify this parameter and the network interface IDs parameter in the same request. For more information, see Pagination.

      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. You cannot specify this parameter and the network interface IDs parameter in the same request. For more information, see Pagination.

    • toBuilder

      public DescribeNetworkInterfacesRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DescribeNetworkInterfacesRequest.Builder,DescribeNetworkInterfacesRequest>
      Specified by:
      toBuilder in class Ec2Request
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.