Package software.amazon.awssdk.services.applicationdiscovery.model

Class ListServerNeighborsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.applicationdiscovery.model.ApplicationDiscoveryRequest

software.amazon.awssdk.services.applicationdiscovery.model.ListServerNeighborsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListServerNeighborsRequest.Builder,ListServerNeighborsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListServerNeighborsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListServerNeighborsRequest.Builder	builder()
String	configurationId()	Configuration ID of the server for which neighbors are being listed.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasNeighborConfigurationIds()	For responses, this returns true if the service returned a value for the NeighborConfigurationIds property.
Integer	maxResults()	Maximum number of results to return in a single page of output.
List<String>	neighborConfigurationIds()	List of configuration IDs to test for one-hop-away.
String	nextToken()	Token to retrieve the next set of results.
Boolean	portInformationNeeded()	Flag to indicate if port and protocol information is needed as part of the response.
List<SdkField<?>>	sdkFields()
static Class<? extends ListServerNeighborsRequest.Builder>	serializableBuilderClass()
ListServerNeighborsRequest.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

configurationId

public final String configurationId()

Configuration ID of the server for which neighbors are being listed.

Returns:

Configuration ID of the server for which neighbors are being listed.

portInformationNeeded

public final Boolean portInformationNeeded()

Flag to indicate if port and protocol information is needed as part of the response.

Returns:

Flag to indicate if port and protocol information is needed as part of the response.

hasNeighborConfigurationIds

public final boolean hasNeighborConfigurationIds()

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

neighborConfigurationIds

public final List<String> neighborConfigurationIds()

List of configuration IDs to test for one-hop-away.

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

Returns:

List of configuration IDs to test for one-hop-away.

maxResults

public final Integer maxResults()

Maximum number of results to return in a single page of output.

Returns:

Maximum number of results to return in a single page of output.

nextToken

public final String nextToken()

Token to retrieve the next set of results. For example, if you previously specified 100 IDs for ListServerNeighborsRequest$neighborConfigurationIds but set ListServerNeighborsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.

Returns:

Token to retrieve the next set of results. For example, if you previously specified 100 IDs for ListServerNeighborsRequest$neighborConfigurationIds but set ListServerNeighborsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.

toBuilder

public ListServerNeighborsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListServerNeighborsRequest.Builder,ListServerNeighborsRequest>

Specified by:

toBuilder in class ApplicationDiscoveryRequest

builder

public static ListServerNeighborsRequest.Builder builder()

serializableBuilderClass

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