software.amazon.awssdk.services.datasync.model

Class AgentListEntry

java.lang.Object

software.amazon.awssdk.services.datasync.model.AgentListEntry

All Implemented Interfaces:

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

@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AgentListEntry.Builder

Method Summary

Modifier and Type	Method and Description
String	agentArn() The Amazon Resource Name (ARN) of a DataSync agent.
static AgentListEntry.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name() The name of an agent.
Platform	platform() The platform-related details about the agent, such as the version number.
List<SdkField<?>>	sdkFields()
static Class<? extends AgentListEntry.Builder>	serializableBuilderClass()
AgentStatus	status() The status of an agent.
String	statusAsString() The status of an agent.
AgentListEntry.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

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:

AgentStatus

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:

AgentStatus

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()

Specified by:

toBuilder in interface ToCopyableBuilder<AgentListEntry.Builder,AgentListEntry>

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)

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