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

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DescribeCarrierGatewaysRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DescribeCarrierGatewaysRequest.Builder`	`builder()`
`List<String>`	`carrierGatewayIds()`	One or more carrier gateway IDs.
`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()`	One or more filters.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasCarrierGatewayIds()`	For responses, this returns true if the service returned a value for the CarrierGatewayIds property.
`boolean`	`hasFilters()`	For responses, this returns true if the service returned a value for the Filters property.
`int`	`hashCode()`
`Integer`	`maxResults()`	The maximum number of results to return with a single call.
`String`	`nextToken()`	The token for the next page of results.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeCarrierGatewaysRequest.Builder>`	`serializableBuilderClass()`
`DescribeCarrierGatewaysRequest.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
  - hasCarrierGatewayIds
```
public final boolean hasCarrierGatewayIds()
```
    For responses, this returns true if the service returned a value for the CarrierGatewayIds 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.
  - carrierGatewayIds
```
public final List<String> carrierGatewayIds()
```
    One or more carrier gateway IDs.
    
    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 hasCarrierGatewayIds() method.
    
    Returns:
    
    One or more carrier gateway IDs.
  - 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.
    
    carrier-gateway-id - The ID of the carrier gateway.
    
    state - The state of the carrier gateway (pending | failed | available | deleting | deleted).
    
    owner-id - The Amazon Web Services account ID of the owner of the carrier gateway.
    
    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 associated with the carrier 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.
    
    carrier-gateway-id - The ID of the carrier gateway.
    
    state - The state of the carrier gateway (pending | failed | available | deleting | deleted).
    
    owner-id - The Amazon Web Services account ID of the owner of the carrier gateway.
    
    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 associated with the carrier 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.
  - 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.
  - toBuilder
```
public DescribeCarrierGatewaysRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeCarrierGatewaysRequest.Builder,DescribeCarrierGatewaysRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static DescribeCarrierGatewaysRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeCarrierGatewaysRequest.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

Class DescribeCarrierGatewaysRequest

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

hasCarrierGatewayIds

carrierGatewayIds

hasFilters

filters

maxResults

nextToken

dryRun

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField