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

Class DescribeVpcsRequest

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.DescribeVpcsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeVpcsRequest.Builder,DescribeVpcsRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeVpcsRequest extends Ec2Request implements ToCopyableBuilder<DescribeVpcsRequest.Builder,DescribeVpcsRequest>

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

      The filters.

      • cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).

      • cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC.

      • cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with the VPC.

      • cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC.

      • dhcp-options-id - The ID of a set of DHCP options.

      • ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC.

      • ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.

      • ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated with the VPC.

      • ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC.

      • is-default - Indicates whether the VPC is the default VPC.

      • owner-id - The ID of the Amazon Web Services account that owns the VPC.

      • state - The state of the VPC (pending | available).

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

      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.

      • cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).

      • cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC.

      • cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with the VPC.

      • cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC.

      • dhcp-options-id - The ID of a set of DHCP options.

      • ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC.

      • ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.

      • ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated with the VPC.

      • ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC.

      • is-default - Indicates whether the VPC is the default VPC.

      • owner-id - The ID of the Amazon Web Services account that owns the VPC.

      • state - The state of the VPC (pending | available).

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

    • hasVpcIds

      public final boolean hasVpcIds()
      For responses, this returns true if the service returned a value for the VpcIds 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.

    • vpcIds

      public final List<String> vpcIds()

      The IDs of the VPCs.

      Default: Describes all your VPCs.

      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 hasVpcIds() method.

      Returns:
      The IDs of the VPCs.

      Default: Describes all your VPCs.

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

    • 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. 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. For more information, see Pagination.

    • toBuilder

      public DescribeVpcsRequest.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<DescribeVpcsRequest.Builder,DescribeVpcsRequest>
      Specified by:
      toBuilder in class Ec2Request
      Returns:
      a builder for type T

    • builder

      public static DescribeVpcsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeVpcsRequest.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.