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

Class DescribeAgentsResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.applicationdiscovery.model.ApplicationDiscoveryResponse

software.amazon.awssdk.services.applicationdiscovery.model.DescribeAgentsResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeAgentsResponse.Builder,DescribeAgentsResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeAgentsResponse.Builder

Method Summary

Modifier and Type	Method	Description
List<AgentInfo>	agentsInfo()	Lists agents or the collector by ID or lists all agents/collectors associated with your user, if you did not specify an agent/collector ID.
static DescribeAgentsResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAgentsInfo()	For responses, this returns true if the service returned a value for the AgentsInfo property.
int	hashCode()
String	nextToken()	Token to retrieve the next set of results.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeAgentsResponse.Builder>	serializableBuilderClass()
DescribeAgentsResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.applicationdiscovery.model.ApplicationDiscoveryResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

hasAgentsInfo

public final boolean hasAgentsInfo()

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

agentsInfo

public final List<AgentInfo> agentsInfo()

Lists agents or the collector by ID or lists all agents/collectors associated with your user, if you did not specify an agent/collector ID. The output includes agent/collector IDs, IP addresses, media access control (MAC) addresses, agent/collector health, host name where the agent/collector resides, and the version number of each agent/collector.

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

Returns:

Lists agents or the collector by ID or lists all agents/collectors associated with your user, if you did not specify an agent/collector ID. The output includes agent/collector IDs, IP addresses, media access control (MAC) addresses, agent/collector health, host name where the agent/collector resides, and the version number of each agent/collector.

nextToken

public final String nextToken()

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

Returns:

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

toBuilder

public DescribeAgentsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeAgentsResponse.Builder,DescribeAgentsResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeAgentsResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeAgentsResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo