Package software.amazon.awssdk.services.networkfirewall.model

Class ListFirewallsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.networkfirewall.model.NetworkFirewallRequest

software.amazon.awssdk.services.networkfirewall.model.ListFirewallsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListFirewallsRequest.Builder,ListFirewallsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListFirewallsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListFirewallsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasVpcIds()	For responses, this returns true if the service returned a value for the VpcIds property.
Integer	maxResults()	The maximum number of objects that you want Network Firewall to return for this request.
String	nextToken()	When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ListFirewallsRequest.Builder>	serializableBuilderClass()
ListFirewallsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	vpcIds()	The unique identifiers of the VPCs that you want Network Firewall to retrieve the firewalls for.

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()

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

Returns:

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

hasVpcIds

public final boolean hasVpcIds()

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

vpcIds

public final List<String> vpcIds()

The unique identifiers of the VPCs that you want Network Firewall to retrieve the firewalls for. Leave this blank to retrieve all firewalls that you have defined.

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

Returns:

The unique identifiers of the VPCs that you want Network Firewall to retrieve the firewalls for. Leave this blank to retrieve all firewalls that you have defined.

maxResults

public final Integer maxResults()

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

Returns:

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

toBuilder

public ListFirewallsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListFirewallsRequest.Builder,ListFirewallsRequest>

Specified by:

toBuilder in class NetworkFirewallRequest

builder

public static ListFirewallsRequest.Builder builder()

serializableBuilderClass

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