software.amazon.awssdk.services.applicationdiscovery.model

Class AgentInfo

java.lang.Object

software.amazon.awssdk.services.applicationdiscovery.model.AgentInfo

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AgentInfo.Builder,AgentInfo>

@Generated(value="software.amazon.awssdk:codegen")
public final class AgentInfo
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AgentInfo.Builder,AgentInfo>

Information about agents associated with the user’s Amazon Web Services account. Information includes agent IDs, IP addresses, media access control (MAC) addresses, agent or collector status, hostname where the agent resides, and agent version for each agent.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AgentInfo.Builder

Method Summary

Modifier and Type	Method and Description
String	agentId() The agent or collector ID.
List<AgentNetworkInfo>	agentNetworkInfoList() Network details about the host where the agent or collector resides.
String	agentType() Type of agent.
static AgentInfo.Builder	builder()
String	collectionStatus() Status of the collection process for an agent.
String	connectorId() The ID of the connector.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAgentNetworkInfoList() For responses, this returns true if the service returned a value for the AgentNetworkInfoList property.
int	hashCode()
AgentStatus	health() The health of the agent.
String	healthAsString() The health of the agent.
String	hostName() The name of the host where the agent or collector resides.
String	lastHealthPingTime() Time since agent health was reported.
String	registeredTime() Agent's first registration timestamp in UTC.
List<SdkField<?>>	sdkFields()
static Class<? extends AgentInfo.Builder>	serializableBuilderClass()
AgentInfo.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	version() The agent or collector version.

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

agentId

public final String agentId()

The agent or collector ID.

Returns:

The agent or collector ID.

hostName

public final String hostName()

The name of the host where the agent or collector resides. The host can be a server or virtual machine.

Returns:

The name of the host where the agent or collector resides. The host can be a server or virtual machine.

hasAgentNetworkInfoList

public final boolean hasAgentNetworkInfoList()

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

agentNetworkInfoList

public final List<AgentNetworkInfo> agentNetworkInfoList()

Network details about the host where the agent or collector resides.

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

Returns:

Network details about the host where the agent or collector resides.

connectorId

public final String connectorId()

The ID of the connector.

Returns:

The ID of the connector.

version

public final String version()

The agent or collector version.

Returns:

The agent or collector version.

health

public final AgentStatus health()

The health of the agent.

If the service returns an enum value that is not available in the current SDK version, health will return AgentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from healthAsString().

Returns:

The health of the agent.

See Also:

AgentStatus

healthAsString

public final String healthAsString()

The health of the agent.

If the service returns an enum value that is not available in the current SDK version, health will return AgentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from healthAsString().

Returns:

The health of the agent.

See Also:

AgentStatus

lastHealthPingTime

public final String lastHealthPingTime()

Time since agent health was reported.

Returns:

Time since agent health was reported.

collectionStatus

public final String collectionStatus()

Status of the collection process for an agent.

Returns:

Status of the collection process for an agent.

agentType

public final String agentType()

Type of agent.

Returns:

Type of agent.

registeredTime

public final String registeredTime()

Agent's first registration timestamp in UTC.

Returns:

Agent's first registration timestamp in UTC.

toBuilder

public AgentInfo.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AgentInfo.Builder,AgentInfo>

builder

public static AgentInfo.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo