Class DescribeRouteTablesRequest
- 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.DescribeRouteTablesRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeRouteTablesRequest.Builder,DescribeRouteTablesRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeRouteTablesRequest extends Ec2Request implements ToCopyableBuilder<DescribeRouteTablesRequest.Builder,DescribeRouteTablesRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
DescribeRouteTablesRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DescribeRouteTablesRequest.Builder
builder()
Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
List<Filter>
filters()
The 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
hasRouteTableIds()
For responses, this returns true if the service returned a value for the RouteTableIds property.Integer
maxResults()
The maximum number of items to return for this request.String
nextToken()
The token returned from a previous paginated request.List<String>
routeTableIds()
The IDs of the route tables.List<SdkField<?>>
sdkFields()
static Class<? extends DescribeRouteTablesRequest.Builder>
serializableBuilderClass()
DescribeRouteTablesRequest.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
-
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.
-
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 isUnauthorizedOperation
.- 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 isUnauthorizedOperation
.
-
hasRouteTableIds
public final boolean hasRouteTableIds()
For responses, this returns true if the service returned a value for the RouteTableIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
routeTableIds
public final List<String> routeTableIds()
The IDs of the route tables.
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
hasRouteTableIds()
method.- Returns:
- The IDs of the route tables.
-
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 theisEmpty()
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.
-
association.gateway-id
- The ID of the gateway involved in the association. -
association.route-table-association-id
- The ID of an association ID for the route table. -
association.route-table-id
- The ID of the route table involved in the association. -
association.subnet-id
- The ID of the subnet involved in the association. -
association.main
- Indicates whether the route table is the main route table for the VPC (true
|false
). Route tables that do not have an association ID are not returned in the response. -
owner-id
- The ID of the Amazon Web Services account that owns the route table. -
route-table-id
- The ID of the route table. -
route.destination-cidr-block
- The IPv4 CIDR range specified in a route in the table. -
route.destination-ipv6-cidr-block
- The IPv6 CIDR range specified in a route in the route table. -
route.destination-prefix-list-id
- The ID (prefix) of the Amazon Web Services service specified in a route in the table. -
route.egress-only-internet-gateway-id
- The ID of an egress-only Internet gateway specified in a route in the route table. -
route.gateway-id
- The ID of a gateway specified in a route in the table. -
route.instance-id
- The ID of an instance specified in a route in the table. -
route.nat-gateway-id
- The ID of a NAT gateway. -
route.transit-gateway-id
- The ID of a transit gateway. -
route.origin
- Describes how the route was created.CreateRouteTable
indicates that the route was automatically created when the route table was created;CreateRoute
indicates that the route was manually added to the route table;EnableVgwRoutePropagation
indicates that the route was propagated by route propagation. -
route.state
- The state of a route in the route table (active
|blackhole
). The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, the specified NAT instance has been terminated, and so on). -
route.vpc-peering-connection-id
- The ID of a VPC peering connection specified in a route in the table. -
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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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 route table.
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.
-
association.gateway-id
- The ID of the gateway involved in the association. -
association.route-table-association-id
- The ID of an association ID for the route table. -
association.route-table-id
- The ID of the route table involved in the association. -
association.subnet-id
- The ID of the subnet involved in the association. -
association.main
- Indicates whether the route table is the main route table for the VPC (true
|false
). Route tables that do not have an association ID are not returned in the response. -
owner-id
- The ID of the Amazon Web Services account that owns the route table. -
route-table-id
- The ID of the route table. -
route.destination-cidr-block
- The IPv4 CIDR range specified in a route in the table. -
route.destination-ipv6-cidr-block
- The IPv6 CIDR range specified in a route in the route table. -
route.destination-prefix-list-id
- The ID (prefix) of the Amazon Web Services service specified in a route in the table. -
route.egress-only-internet-gateway-id
- The ID of an egress-only Internet gateway specified in a route in the route table. -
route.gateway-id
- The ID of a gateway specified in a route in the table. -
route.instance-id
- The ID of an instance specified in a route in the table. -
route.nat-gateway-id
- The ID of a NAT gateway. -
route.transit-gateway-id
- The ID of a transit gateway. -
route.origin
- Describes how the route was created.CreateRouteTable
indicates that the route was automatically created when the route table was created;CreateRoute
indicates that the route was manually added to the route table;EnableVgwRoutePropagation
indicates that the route was propagated by route propagation. -
route.state
- The state of a route in the route table (active
|blackhole
). The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, the specified NAT instance has been terminated, and so on). -
route.vpc-peering-connection-id
- The ID of a VPC peering connection specified in a route in the table. -
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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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 route table.
-
-
-
toBuilder
public DescribeRouteTablesRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeRouteTablesRequest.Builder,DescribeRouteTablesRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static DescribeRouteTablesRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeRouteTablesRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-