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

Class DescribeSecondaryNetworksRequest

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

  • Method Details

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

    • 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. The following are the possible values:

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

      • ipv4-cidr-block-association.cidr-block - An IPv4 CIDR block associated with the secondary network.

      • ipv4-cidr-block-association.state - The state of an IPv4 CIDR block associated with the secondary network.

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

      • secondary-network-id - The ID of the secondary network.

      • secondary-network-arn - The ARN of the secondary network.

      • state - The state of the secondary network (create-in-progress | create-complete | create-failed | delete-in-progress | delete-complete | delete-failed).

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

      • type - The type of the secondary network (rdma).

      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. The following are the possible values:

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

      • ipv4-cidr-block-association.cidr-block - An IPv4 CIDR block associated with the secondary network.

      • ipv4-cidr-block-association.state - The state of an IPv4 CIDR block associated with the secondary network.

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

      • secondary-network-id - The ID of the secondary network.

      • secondary-network-arn - The ARN of the secondary network.

      • state - The state of the secondary network (create-in-progress | create-complete | create-failed | delete-in-progress | delete-complete | delete-failed).

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

      • type - The type of the secondary network (rdma).

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

      Returns:
      The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    • nextToken

      public final String nextToken()

      The token for the next page of results.

      Returns:
      The token for the next page of results.

    • hasSecondaryNetworkIds

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

    • secondaryNetworkIds

      public final List<String> secondaryNetworkIds()

      The IDs of the secondary networks.

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

      Returns:
      The IDs of the secondary networks.

    • toBuilder

      public DescribeSecondaryNetworksRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<DescribeSecondaryNetworksRequest.Builder,DescribeSecondaryNetworksRequest>
      Specified by:
      toBuilder in class Ec2Request

    • builder

      public static DescribeSecondaryNetworksRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo