software.amazon.awssdk.services.ec2.model

Class DescribeLocalGatewaysRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeLocalGatewaysRequest.Builder,DescribeLocalGatewaysRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeLocalGatewaysRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeLocalGatewaysRequest.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() 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	hasLocalGatewayIds() For responses, this returns true if the service returned a value for the LocalGatewayIds property.
List<String>	localGatewayIds() The IDs of the local gateways.
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 DescribeLocalGatewaysRequest.Builder>	serializableBuilderClass()
DescribeLocalGatewaysRequest.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

hasLocalGatewayIds

public final boolean hasLocalGatewayIds()

For responses, this returns true if the service returned a value for the LocalGatewayIds 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.

localGatewayIds

public final List<String> localGatewayIds()

The IDs of the local 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 hasLocalGatewayIds() method.

Returns:

The IDs of the local 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.

• local-gateway-id - The ID of a local gateway.

• outpost-arn - The Amazon Resource Name (ARN) of the Outpost.

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

• state - The state of the association.

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.

• local-gateway-id - The ID of a local gateway.

• outpost-arn - The Amazon Resource Name (ARN) of the Outpost.

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

• state - The state of the association.

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 DescribeLocalGatewaysRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeLocalGatewaysRequest.Builder,DescribeLocalGatewaysRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static DescribeLocalGatewaysRequest.Builder builder()

serializableBuilderClass

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