Package software.amazon.awssdk.services.networkmanager.model

Class GetSitesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.networkmanager.model.NetworkManagerRequest

software.amazon.awssdk.services.networkmanager.model.GetSitesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetSitesRequest.Builder,GetSitesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetSitesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static GetSitesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	globalNetworkId()	The ID of the global network.
int	hashCode()
boolean	hasSiteIds()	For responses, this returns true if the service returned a value for the SiteIds property.
Integer	maxResults()	The maximum number of results to return.
String	nextToken()	The token for the next page of results.
List<SdkField<?>>	sdkFields()
static Class<? extends GetSitesRequest.Builder>	serializableBuilderClass()
List<String>	siteIds()	One or more site IDs.
GetSitesRequest.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

globalNetworkId

public final String globalNetworkId()

The ID of the global network.

Returns:

The ID of the global network.

hasSiteIds

public final boolean hasSiteIds()

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

siteIds

public final List<String> siteIds()

One or more site IDs. The maximum is 10.

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

Returns:

One or more site IDs. The maximum is 10.

maxResults

public final Integer maxResults()

The maximum number of results to return.

Returns:

The maximum number of results to return.

nextToken

public final String nextToken()

The token for the next page of results.

Returns:

The token for the next page of results.

toBuilder

public GetSitesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetSitesRequest.Builder,GetSitesRequest>

Specified by:

toBuilder in class NetworkManagerRequest

builder

public static GetSitesRequest.Builder builder()

serializableBuilderClass

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