Class AgentListEntry

java.lang.Object
software.amazon.awssdk.services.datasync.model.AgentListEntry
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AgentListEntry.Builder,AgentListEntry>

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

Represents a single entry in a list (or array) of DataSync agents when you call the ListAgents operation.

See Also:
  • Method Details

    • agentArn

      public final String agentArn()

      The Amazon Resource Name (ARN) of a DataSync agent.

      Returns:
      The Amazon Resource Name (ARN) of a DataSync agent.
    • name

      public final String name()

      The name of an agent.

      Returns:
      The name of an agent.
    • status

      public final AgentStatus status()

      The status of an agent.

      • If the status is ONLINE, the agent is configured properly and ready to use.

      • If the status is OFFLINE, the agent has been out of contact with DataSync for five minutes or longer. This can happen for a few reasons. For more information, see What do I do if my agent is offline?

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

      Returns:
      The status of an agent.

      • If the status is ONLINE, the agent is configured properly and ready to use.

      • If the status is OFFLINE, the agent has been out of contact with DataSync for five minutes or longer. This can happen for a few reasons. For more information, see What do I do if my agent is offline?

      See Also:
    • statusAsString

      public final String statusAsString()

      The status of an agent.

      • If the status is ONLINE, the agent is configured properly and ready to use.

      • If the status is OFFLINE, the agent has been out of contact with DataSync for five minutes or longer. This can happen for a few reasons. For more information, see What do I do if my agent is offline?

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

      Returns:
      The status of an agent.

      • If the status is ONLINE, the agent is configured properly and ready to use.

      • If the status is OFFLINE, the agent has been out of contact with DataSync for five minutes or longer. This can happen for a few reasons. For more information, see What do I do if my agent is offline?

      See Also:
    • platform

      public final Platform platform()

      The platform-related details about the agent, such as the version number.

      Returns:
      The platform-related details about the agent, such as the version number.
    • toBuilder

      public AgentListEntry.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<AgentListEntry.Builder,AgentListEntry>
      Returns:
      a builder for type T
    • builder

      public static AgentListEntry.Builder builder()
    • serializableBuilderClass

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