Class AgentInfo
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
agentId()
The agent or collector ID.final List
<AgentNetworkInfo> Network details about the host where the agent or collector resides.final String
Type of agent.static AgentInfo.Builder
builder()
final String
Status of the collection process for an agent.final String
The ID of the connector.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AgentNetworkInfoList property.final int
hashCode()
final AgentStatus
health()
The health of the agent.final String
The health of the agent.final String
hostName()
The name of the host where the agent or collector resides.final String
Time since agent health was reported.final String
Agent's first registration timestamp in UTC.static Class
<? extends AgentInfo.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
version()
The agent or collector version.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
agentId
The agent or collector ID.
- Returns:
- The agent or collector ID.
-
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 theisEmpty()
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
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
The ID of the connector.
- Returns:
- The ID of the connector.
-
version
The agent or collector version.
- Returns:
- The agent or collector version.
-
health
The health of the agent.
If the service returns an enum value that is not available in the current SDK version,
health
will returnAgentStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhealthAsString()
.- Returns:
- The health of the agent.
- See Also:
-
healthAsString
The health of the agent.
If the service returns an enum value that is not available in the current SDK version,
health
will returnAgentStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhealthAsString()
.- Returns:
- The health of the agent.
- See Also:
-
lastHealthPingTime
Time since agent health was reported.
- Returns:
- Time since agent health was reported.
-
collectionStatus
Status of the collection process for an agent.
- Returns:
- Status of the collection process for an agent.
-
agentType
Type of agent.
- Returns:
- Type of agent.
-
registeredTime
Agent's first registration timestamp in UTC.
- Returns:
- Agent's first registration timestamp in UTC.
-
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 interfaceToCopyableBuilder<AgentInfo.Builder,
AgentInfo> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-