Class AgentInfo

java.lang.Object
software.amazon.awssdk.services.applicationdiscovery.model.AgentInfo
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AgentInfo.Builder,AgentInfo>
@Generated("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:

  • Method Details

    • 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:

    • 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:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<AgentInfo.Builder,AgentInfo>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.