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

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeTransitGatewaysRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DescribeTransitGatewaysRequest.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`	`hasTransitGatewayIds()` For responses, this returns true if the service returned a value for the TransitGatewayIds property.
`Integer`	`maxResults()` The maximum number of results to return with a single call.
`String`	`nextToken()` The token for the next page of results.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeTransitGatewaysRequest.Builder>`	`serializableBuilderClass()`
`DescribeTransitGatewaysRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`List<String>`	`transitGatewayIds()` The IDs of the transit gateways.

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
  - hasTransitGatewayIds
```
public final boolean hasTransitGatewayIds()
```
    For responses, this returns true if the service returned a value for the TransitGatewayIds 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.
  - transitGatewayIds
```
public final List<String> transitGatewayIds()
```
    The IDs of the transit gateways.
    
    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 hasTransitGatewayIds() method.
    
    Returns:
    
    The IDs of the transit gateways.
  - 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. The possible values are:
    - options.propagation-default-route-table-id - The ID of the default propagation route table.
    - options.amazon-side-asn - The private ASN for the Amazon side of a BGP session.
    - options.association-default-route-table-id - The ID of the default association route table.
    - options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).
    - options.default-route-table-association - Indicates whether resource attachments are automatically associated with the default association route table (enable | disable).
    - options.default-route-table-propagation - Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable | disable).
    - options.dns-support - Indicates whether DNS support is enabled (enable | disable).
    - options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled ( enable | disable).
    - owner-id - The ID of the Amazon Web Services account that owns the transit gateway.
    - state - The state of the transit gateway (available | deleted | deleting | modifying | pending).
    - transit-gateway-id - The ID of the transit gateway.
    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. The possible values are:
    
    options.propagation-default-route-table-id - The ID of the default propagation route table.
    
    options.amazon-side-asn - The private ASN for the Amazon side of a BGP session.
    
    options.association-default-route-table-id - The ID of the default association route table.
    
    options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).
    
    options.default-route-table-association - Indicates whether resource attachments are automatically associated with the default association route table (enable | disable).
    
    options.default-route-table-propagation - Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable | disable).
    
    options.dns-support - Indicates whether DNS support is enabled (enable | disable).
    
    options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).
    
    owner-id - The ID of the Amazon Web Services account that owns the transit gateway.
    
    state - The state of the transit gateway (available | deleted | deleting | modifying | pending).
    
    transit-gateway-id - The ID of the transit gateway.
  - 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.
  - toBuilder
```
public DescribeTransitGatewaysRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeTransitGatewaysRequest.Builder,DescribeTransitGatewaysRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static DescribeTransitGatewaysRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeTransitGatewaysRequest.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 DescribeTransitGatewaysRequest

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

hasTransitGatewayIds

transitGatewayIds

hasFilters

filters

maxResults

nextToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields