software.amazon.awssdk.services.outposts.model

Class ListSitesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.outposts.model.OutpostsRequest

software.amazon.awssdk.services.outposts.model.ListSitesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListSitesRequest.Builder,ListSitesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListSitesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListSitesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasOperatingAddressCityFilter() For responses, this returns true if the service returned a value for the OperatingAddressCityFilter property.
boolean	hasOperatingAddressCountryCodeFilter() For responses, this returns true if the service returned a value for the OperatingAddressCountryCodeFilter property.
boolean	hasOperatingAddressStateOrRegionFilter() For responses, this returns true if the service returned a value for the OperatingAddressStateOrRegionFilter property.
Integer	maxResults() Returns the value of the MaxResults property for this object.
String	nextToken() Returns the value of the NextToken property for this object.
List<String>	operatingAddressCityFilter() A filter for the city of the Outpost site.
List<String>	operatingAddressCountryCodeFilter() A filter for the country code of the Outpost site.
List<String>	operatingAddressStateOrRegionFilter() A filter for the state/region of the Outpost site.
List<SdkField<?>>	sdkFields()
static Class<? extends ListSitesRequest.Builder>	serializableBuilderClass()
ListSitesRequest.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

nextToken

public final String nextToken()

Returns the value of the NextToken property for this object.

Returns:

The value of the NextToken property for this object.

maxResults

public final Integer maxResults()

Returns the value of the MaxResults property for this object.

Returns:

The value of the MaxResults property for this object.

hasOperatingAddressCountryCodeFilter

public final boolean hasOperatingAddressCountryCodeFilter()

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

operatingAddressCountryCodeFilter

public final List<String> operatingAddressCountryCodeFilter()

A filter for the country code of the Outpost site.

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

Returns:

A filter for the country code of the Outpost site.

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.

hasOperatingAddressStateOrRegionFilter

public final boolean hasOperatingAddressStateOrRegionFilter()

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

operatingAddressStateOrRegionFilter

public final List<String> operatingAddressStateOrRegionFilter()

A filter for the state/region of the Outpost site.

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

Returns:

A filter for the state/region of the Outpost site.

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.

hasOperatingAddressCityFilter

public final boolean hasOperatingAddressCityFilter()

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

operatingAddressCityFilter

public final List<String> operatingAddressCityFilter()

A filter for the city of the Outpost site.

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

Returns:

A filter for the city of the Outpost site.

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.

toBuilder

public ListSitesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListSitesRequest.Builder,ListSitesRequest>

Specified by:

toBuilder in class OutpostsRequest

builder

public static ListSitesRequest.Builder builder()

serializableBuilderClass

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