DescribeAgentResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.datasync.model.DescribeAgentResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeAgentResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

DescribeAgentResponse

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeAgentResult()

Constructors
Constructor and Description
`DescribeAgentResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeAgentResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAgentArn()` The Amazon Resource Name (ARN) of the agent.
`Date`	`getCreationTime()` The time that the agent was activated (that is, created in your account).
`String`	`getEndpointType()` The type of endpoint that your agent is connected to.
`Date`	`getLastConnectionTime()` The time that the agent last connected to DataSync.
`String`	`getName()` The name of the agent.
`PrivateLinkConfig`	`getPrivateLinkConfig()` The subnet and the security group that DataSync used to access a VPC endpoint.
`String`	`getStatus()` The status of the agent.
`int`	`hashCode()`
`void`	`setAgentArn(String agentArn)` The Amazon Resource Name (ARN) of the agent.
`void`	`setCreationTime(Date creationTime)` The time that the agent was activated (that is, created in your account).
`void`	`setEndpointType(String endpointType)` The type of endpoint that your agent is connected to.
`void`	`setLastConnectionTime(Date lastConnectionTime)` The time that the agent last connected to DataSync.
`void`	`setName(String name)` The name of the agent.
`void`	`setPrivateLinkConfig(PrivateLinkConfig privateLinkConfig)` The subnet and the security group that DataSync used to access a VPC endpoint.
`void`	`setStatus(String status)` The status of the agent.
`String`	`toString()` Returns a string representation of this object.
`DescribeAgentResult`	`withAgentArn(String agentArn)` The Amazon Resource Name (ARN) of the agent.
`DescribeAgentResult`	`withCreationTime(Date creationTime)` The time that the agent was activated (that is, created in your account).
`DescribeAgentResult`	`withEndpointType(EndpointType endpointType)` The type of endpoint that your agent is connected to.
`DescribeAgentResult`	`withEndpointType(String endpointType)` The type of endpoint that your agent is connected to.
`DescribeAgentResult`	`withLastConnectionTime(Date lastConnectionTime)` The time that the agent last connected to DataSync.
`DescribeAgentResult`	`withName(String name)` The name of the agent.
`DescribeAgentResult`	`withPrivateLinkConfig(PrivateLinkConfig privateLinkConfig)` The subnet and the security group that DataSync used to access a VPC endpoint.
`DescribeAgentResult`	`withStatus(AgentStatus status)` The status of the agent.
`DescribeAgentResult`	`withStatus(String status)` The status of the agent.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribeAgentResult
```
public DescribeAgentResult()
```
- Method Detail
  - setAgentArn
```
public void setAgentArn(String agentArn)
```
    The Amazon Resource Name (ARN) of the agent.
    
    Parameters:
    
    agentArn - The Amazon Resource Name (ARN) of the agent.
  - getAgentArn
```
public String getAgentArn()
```
    The Amazon Resource Name (ARN) of the agent.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the agent.
  - withAgentArn
```
public DescribeAgentResult withAgentArn(String agentArn)
```
    The Amazon Resource Name (ARN) of the agent.
    
    Parameters:
    
    agentArn - The Amazon Resource Name (ARN) of the agent.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the agent.
    
    Parameters:
    
    name - The name of the agent.
  - getName
```
public String getName()
```
    The name of the agent.
    
    Returns:
    
    The name of the agent.
  - withName
```
public DescribeAgentResult withName(String name)
```
    The name of the agent.
    
    Parameters:
    
    name - The name of the agent.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The status of the agent. If the status is ONLINE, then the agent is configured properly and is available to use. The Running status is the normal running status for an agent. If the status is OFFLINE, the agent's VM is turned off or the agent is in an unhealthy state. When the issue that caused the unhealthy state is resolved, the agent returns to ONLINE status.
    
    Parameters:
    
    status - The status of the agent. If the status is ONLINE, then the agent is configured properly and is available to use. The Running status is the normal running status for an agent. If the status is OFFLINE, the agent's VM is turned off or the agent is in an unhealthy state. When the issue that caused the unhealthy state is resolved, the agent returns to ONLINE status.
    
    See Also:
    
    AgentStatus
  - getStatus
```
public String getStatus()
```
    The status of the agent. If the status is ONLINE, then the agent is configured properly and is available to use. The Running status is the normal running status for an agent. If the status is OFFLINE, the agent's VM is turned off or the agent is in an unhealthy state. When the issue that caused the unhealthy state is resolved, the agent returns to ONLINE status.
    
    Returns:
    
    The status of the agent. If the status is ONLINE, then the agent is configured properly and is available to use. The Running status is the normal running status for an agent. If the status is OFFLINE, the agent's VM is turned off or the agent is in an unhealthy state. When the issue that caused the unhealthy state is resolved, the agent returns to ONLINE status.
    
    See Also:
    
    AgentStatus
  - withStatus
```
public DescribeAgentResult withStatus(String status)
```
    The status of the agent. If the status is ONLINE, then the agent is configured properly and is available to use. The Running status is the normal running status for an agent. If the status is OFFLINE, the agent's VM is turned off or the agent is in an unhealthy state. When the issue that caused the unhealthy state is resolved, the agent returns to ONLINE status.
    
    Parameters:
    
    status - The status of the agent. If the status is ONLINE, then the agent is configured properly and is available to use. The Running status is the normal running status for an agent. If the status is OFFLINE, the agent's VM is turned off or the agent is in an unhealthy state. When the issue that caused the unhealthy state is resolved, the agent returns to ONLINE status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AgentStatus
  - withStatus
```
public DescribeAgentResult withStatus(AgentStatus status)
```
    The status of the agent. If the status is ONLINE, then the agent is configured properly and is available to use. The Running status is the normal running status for an agent. If the status is OFFLINE, the agent's VM is turned off or the agent is in an unhealthy state. When the issue that caused the unhealthy state is resolved, the agent returns to ONLINE status.
    
    Parameters:
    
    status - The status of the agent. If the status is ONLINE, then the agent is configured properly and is available to use. The Running status is the normal running status for an agent. If the status is OFFLINE, the agent's VM is turned off or the agent is in an unhealthy state. When the issue that caused the unhealthy state is resolved, the agent returns to ONLINE status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AgentStatus
  - setLastConnectionTime
```
public void setLastConnectionTime(Date lastConnectionTime)
```
    The time that the agent last connected to DataSync.
    
    Parameters:
    
    lastConnectionTime - The time that the agent last connected to DataSync.
  - getLastConnectionTime
```
public Date getLastConnectionTime()
```
    The time that the agent last connected to DataSync.
    
    Returns:
    
    The time that the agent last connected to DataSync.
  - withLastConnectionTime
```
public DescribeAgentResult withLastConnectionTime(Date lastConnectionTime)
```
    The time that the agent last connected to DataSync.
    
    Parameters:
    
    lastConnectionTime - The time that the agent last connected to DataSync.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    The time that the agent was activated (that is, created in your account).
    
    Parameters:
    
    creationTime - The time that the agent was activated (that is, created in your account).
  - getCreationTime
```
public Date getCreationTime()
```
    The time that the agent was activated (that is, created in your account).
    
    Returns:
    
    The time that the agent was activated (that is, created in your account).
  - withCreationTime
```
public DescribeAgentResult withCreationTime(Date creationTime)
```
    The time that the agent was activated (that is, created in your account).
    
    Parameters:
    
    creationTime - The time that the agent was activated (that is, created in your account).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndpointType
```
public void setEndpointType(String endpointType)
```
    The type of endpoint that your agent is connected to. If the endpoint is a VPC endpoint, the agent is not accessible over the public internet.
    
    Parameters:
    
    endpointType - The type of endpoint that your agent is connected to. If the endpoint is a VPC endpoint, the agent is not accessible over the public internet.
    
    See Also:
    
    EndpointType
  - getEndpointType
```
public String getEndpointType()
```
    The type of endpoint that your agent is connected to. If the endpoint is a VPC endpoint, the agent is not accessible over the public internet.
    
    Returns:
    
    The type of endpoint that your agent is connected to. If the endpoint is a VPC endpoint, the agent is not accessible over the public internet.
    
    See Also:
    
    EndpointType
  - withEndpointType
```
public DescribeAgentResult withEndpointType(String endpointType)
```
    The type of endpoint that your agent is connected to. If the endpoint is a VPC endpoint, the agent is not accessible over the public internet.
    
    Parameters:
    
    endpointType - The type of endpoint that your agent is connected to. If the endpoint is a VPC endpoint, the agent is not accessible over the public internet.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EndpointType
  - withEndpointType
```
public DescribeAgentResult withEndpointType(EndpointType endpointType)
```
    The type of endpoint that your agent is connected to. If the endpoint is a VPC endpoint, the agent is not accessible over the public internet.
    
    Parameters:
    
    endpointType - The type of endpoint that your agent is connected to. If the endpoint is a VPC endpoint, the agent is not accessible over the public internet.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EndpointType
  - setPrivateLinkConfig
```
public void setPrivateLinkConfig(PrivateLinkConfig privateLinkConfig)
```
    The subnet and the security group that DataSync used to access a VPC endpoint.
    
    Parameters:
    
    privateLinkConfig - The subnet and the security group that DataSync used to access a VPC endpoint.
  - getPrivateLinkConfig
```
public PrivateLinkConfig getPrivateLinkConfig()
```
    The subnet and the security group that DataSync used to access a VPC endpoint.
    
    Returns:
    
    The subnet and the security group that DataSync used to access a VPC endpoint.
  - withPrivateLinkConfig
```
public DescribeAgentResult withPrivateLinkConfig(PrivateLinkConfig privateLinkConfig)
```
    The subnet and the security group that DataSync used to access a VPC endpoint.
    
    Parameters:
    
    privateLinkConfig - The subnet and the security group that DataSync used to access a VPC endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DescribeAgentResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class DescribeAgentResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeAgentResult

Method Detail

setAgentArn

getAgentArn

withAgentArn

setName

getName

withName

setStatus

getStatus

withStatus

withStatus

setLastConnectionTime

getLastConnectionTime

withLastConnectionTime

setCreationTime

getCreationTime

withCreationTime

setEndpointType

getEndpointType

withEndpointType

withEndpointType

setPrivateLinkConfig

getPrivateLinkConfig

withPrivateLinkConfig

toString

equals

hashCode

clone