Package software.amazon.awssdk.services.privatenetworks.model

Class ListNetworkSitesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.privatenetworks.model.PrivateNetworksRequest

software.amazon.awssdk.services.privatenetworks.model.ListNetworkSitesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListNetworkSitesRequest.Builder,ListNetworkSitesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListNetworkSitesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListNetworkSitesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Map<NetworkSiteFilterKeys,List<String>>	filters()	The filters.
Map<String,List<String>>	filtersAsStrings()	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()
Integer	maxResults()	The maximum number of results to return.
String	networkArn()	The Amazon Resource Name (ARN) of the network.
List<SdkField<?>>	sdkFields()
static Class<? extends ListNetworkSitesRequest.Builder>	serializableBuilderClass()
String	startToken()	The token for the next page of results.
ListNetworkSitesRequest.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

filters

public final Map<NetworkSiteFilterKeys,List<String>> filters()

The filters. Add filters to your request to return a more specific list of results. Use filters to match the status of the network sites.

• STATUS - The status (AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING).

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

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. Add filters to your request to return a more specific list of results. Use filters to match the status of the network sites.

• STATUS - The status (AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING).

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

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.

filtersAsStrings

public final Map<String,List<String>> filtersAsStrings()

The filters. Add filters to your request to return a more specific list of results. Use filters to match the status of the network sites.

• STATUS - The status (AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING).

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

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. Add filters to your request to return a more specific list of results. Use filters to match the status of the network sites.

• STATUS - The status (AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING).

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

maxResults

public final Integer maxResults()

The maximum number of results to return.

Returns:

The maximum number of results to return.

networkArn

public final String networkArn()

The Amazon Resource Name (ARN) of the network.

Returns:

The Amazon Resource Name (ARN) of the network.

startToken

public final String startToken()

The token for the next page of results.

Returns:

The token for the next page of results.

toBuilder

public ListNetworkSitesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListNetworkSitesRequest.Builder,ListNetworkSitesRequest>

Specified by:

toBuilder in class PrivateNetworksRequest

builder

public static ListNetworkSitesRequest.Builder builder()

serializableBuilderClass

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