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

  • Method Details

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

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

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

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

    • 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()
      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<DescribeAgentResponse.Builder,DescribeAgentResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • 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)
      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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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