Package software.amazon.awssdk.services.datasync.model

Class DescribeAgentResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.datasync.model.DataSyncResponse

software.amazon.awssdk.services.datasync.model.DescribeAgentResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeAgentResponse.Builder,DescribeAgentResponse>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeAgentResponse
extends DataSyncResponse
implements ToCopyableBuilder<DescribeAgentResponse.Builder,DescribeAgentResponse>

DescribeAgentResponse

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeAgentResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	agentArn()	The ARN of the agent.
static DescribeAgentResponse.Builder	builder()
Instant	creationTime()	The time that the agent was activated.
EndpointType	endpointType()	The type of service endpoint that your agent is connected to.
String	endpointTypeAsString()	The type of service endpoint that your agent is connected to.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastConnectionTime()	The last time that the agent was communicating with the DataSync service.
String	name()	The name of the agent.
Platform	platform()	The platform-related details about the agent, such as the version number.
PrivateLinkConfig	privateLinkConfig()	The network configuration that the agent uses when connecting to a VPC service endpoint.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeAgentResponse.Builder>	serializableBuilderClass()
AgentStatus	status()	The status of the agent.
String	statusAsString()	The status of the agent.
DescribeAgentResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.datasync.model.DataSyncResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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 ARN of the agent.

Returns:

The ARN of the agent.

name

public final String name()

The name of the agent.

Returns:

The name of the agent.

status

public final AgentStatus status()

The status of the 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 the 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 the 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 the 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

lastConnectionTime

public final Instant lastConnectionTime()

The last time that the agent was communicating with the DataSync service.

Returns:

The last time that the agent was communicating with the DataSync service.

creationTime

public final Instant creationTime()

The time that the agent was activated.

Returns:

The time that the agent was activated.

endpointType

public final EndpointType endpointType()

The type of service endpoint that your agent is connected to.

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

Returns:

The type of service endpoint that your agent is connected to.

See Also:

EndpointType

endpointTypeAsString

public final String endpointTypeAsString()

The type of service endpoint that your agent is connected to.

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

Returns:

The type of service endpoint that your agent is connected to.

See Also:

EndpointType

privateLinkConfig

public final PrivateLinkConfig privateLinkConfig()

The network configuration that the agent uses when connecting to a VPC service endpoint.

Returns:

The network configuration that the agent uses when connecting to a VPC service endpoint.

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 DescribeAgentResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeAgentResponse.Builder,DescribeAgentResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeAgentResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo