AWS SDK for C++  1.8.100
AWS SDK for C++
Public Member Functions | List of all members
Aws::DataSync::Model::DescribeAgentResult Class Reference

#include <DescribeAgentResult.h>

Public Member Functions

 DescribeAgentResult ()
 
 DescribeAgentResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
DescribeAgentResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::StringGetAgentArn () const
 
void SetAgentArn (const Aws::String &value)
 
void SetAgentArn (Aws::String &&value)
 
void SetAgentArn (const char *value)
 
DescribeAgentResultWithAgentArn (const Aws::String &value)
 
DescribeAgentResultWithAgentArn (Aws::String &&value)
 
DescribeAgentResultWithAgentArn (const char *value)
 
const Aws::StringGetName () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
DescribeAgentResultWithName (const Aws::String &value)
 
DescribeAgentResultWithName (Aws::String &&value)
 
DescribeAgentResultWithName (const char *value)
 
const AgentStatusGetStatus () const
 
void SetStatus (const AgentStatus &value)
 
void SetStatus (AgentStatus &&value)
 
DescribeAgentResultWithStatus (const AgentStatus &value)
 
DescribeAgentResultWithStatus (AgentStatus &&value)
 
const Aws::Utils::DateTimeGetLastConnectionTime () const
 
void SetLastConnectionTime (const Aws::Utils::DateTime &value)
 
void SetLastConnectionTime (Aws::Utils::DateTime &&value)
 
DescribeAgentResultWithLastConnectionTime (const Aws::Utils::DateTime &value)
 
DescribeAgentResultWithLastConnectionTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetCreationTime () const
 
void SetCreationTime (const Aws::Utils::DateTime &value)
 
void SetCreationTime (Aws::Utils::DateTime &&value)
 
DescribeAgentResultWithCreationTime (const Aws::Utils::DateTime &value)
 
DescribeAgentResultWithCreationTime (Aws::Utils::DateTime &&value)
 
const EndpointTypeGetEndpointType () const
 
void SetEndpointType (const EndpointType &value)
 
void SetEndpointType (EndpointType &&value)
 
DescribeAgentResultWithEndpointType (const EndpointType &value)
 
DescribeAgentResultWithEndpointType (EndpointType &&value)
 
const PrivateLinkConfigGetPrivateLinkConfig () const
 
void SetPrivateLinkConfig (const PrivateLinkConfig &value)
 
void SetPrivateLinkConfig (PrivateLinkConfig &&value)
 
DescribeAgentResultWithPrivateLinkConfig (const PrivateLinkConfig &value)
 
DescribeAgentResultWithPrivateLinkConfig (PrivateLinkConfig &&value)
 

Detailed Description

DescribeAgentResponse

See Also:

AWS API Reference

Definition at line 36 of file DescribeAgentResult.h.

Constructor & Destructor Documentation

◆ DescribeAgentResult() [1/2]

Aws::DataSync::Model::DescribeAgentResult::DescribeAgentResult ( )

◆ DescribeAgentResult() [2/2]

Aws::DataSync::Model::DescribeAgentResult::DescribeAgentResult ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

Member Function Documentation

◆ GetAgentArn()

const Aws::String& Aws::DataSync::Model::DescribeAgentResult::GetAgentArn ( ) const
inline

The Amazon Resource Name (ARN) of the agent.

Definition at line 47 of file DescribeAgentResult.h.

◆ GetCreationTime()

const Aws::Utils::DateTime& Aws::DataSync::Model::DescribeAgentResult::GetCreationTime ( ) const
inline

The time that the agent was activated (that is, created in your account).

Definition at line 191 of file DescribeAgentResult.h.

◆ GetEndpointType()

const EndpointType& Aws::DataSync::Model::DescribeAgentResult::GetEndpointType ( ) const
inline

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.

Definition at line 218 of file DescribeAgentResult.h.

◆ GetLastConnectionTime()

const Aws::Utils::DateTime& Aws::DataSync::Model::DescribeAgentResult::GetLastConnectionTime ( ) const
inline

The time that the agent last connected to DataSyc.

Definition at line 165 of file DescribeAgentResult.h.

◆ GetName()

const Aws::String& Aws::DataSync::Model::DescribeAgentResult::GetName ( ) const
inline

The name of the agent.

Definition at line 83 of file DescribeAgentResult.h.

◆ GetPrivateLinkConfig()

const PrivateLinkConfig& Aws::DataSync::Model::DescribeAgentResult::GetPrivateLinkConfig ( ) const
inline

The subnet and the security group that DataSync used to access a VPC endpoint.

Definition at line 249 of file DescribeAgentResult.h.

◆ GetStatus()

const AgentStatus& Aws::DataSync::Model::DescribeAgentResult::GetStatus ( ) const
inline

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.

Definition at line 123 of file DescribeAgentResult.h.

◆ operator=()

DescribeAgentResult& Aws::DataSync::Model::DescribeAgentResult::operator= ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

◆ SetAgentArn() [1/3]

void Aws::DataSync::Model::DescribeAgentResult::SetAgentArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the agent.

Definition at line 52 of file DescribeAgentResult.h.

◆ SetAgentArn() [2/3]

void Aws::DataSync::Model::DescribeAgentResult::SetAgentArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the agent.

Definition at line 57 of file DescribeAgentResult.h.

◆ SetAgentArn() [3/3]

void Aws::DataSync::Model::DescribeAgentResult::SetAgentArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the agent.

Definition at line 62 of file DescribeAgentResult.h.

◆ SetCreationTime() [1/2]

void Aws::DataSync::Model::DescribeAgentResult::SetCreationTime ( const Aws::Utils::DateTime value)
inline

The time that the agent was activated (that is, created in your account).

Definition at line 196 of file DescribeAgentResult.h.

◆ SetCreationTime() [2/2]

void Aws::DataSync::Model::DescribeAgentResult::SetCreationTime ( Aws::Utils::DateTime &&  value)
inline

The time that the agent was activated (that is, created in your account).

Definition at line 201 of file DescribeAgentResult.h.

◆ SetEndpointType() [1/2]

void Aws::DataSync::Model::DescribeAgentResult::SetEndpointType ( const EndpointType value)
inline

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.

Definition at line 224 of file DescribeAgentResult.h.

◆ SetEndpointType() [2/2]

void Aws::DataSync::Model::DescribeAgentResult::SetEndpointType ( EndpointType &&  value)
inline

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.

Definition at line 230 of file DescribeAgentResult.h.

◆ SetLastConnectionTime() [1/2]

void Aws::DataSync::Model::DescribeAgentResult::SetLastConnectionTime ( const Aws::Utils::DateTime value)
inline

The time that the agent last connected to DataSyc.

Definition at line 170 of file DescribeAgentResult.h.

◆ SetLastConnectionTime() [2/2]

void Aws::DataSync::Model::DescribeAgentResult::SetLastConnectionTime ( Aws::Utils::DateTime &&  value)
inline

The time that the agent last connected to DataSyc.

Definition at line 175 of file DescribeAgentResult.h.

◆ SetName() [1/3]

void Aws::DataSync::Model::DescribeAgentResult::SetName ( const Aws::String value)
inline

The name of the agent.

Definition at line 88 of file DescribeAgentResult.h.

◆ SetName() [2/3]

void Aws::DataSync::Model::DescribeAgentResult::SetName ( Aws::String &&  value)
inline

The name of the agent.

Definition at line 93 of file DescribeAgentResult.h.

◆ SetName() [3/3]

void Aws::DataSync::Model::DescribeAgentResult::SetName ( const char *  value)
inline

The name of the agent.

Definition at line 98 of file DescribeAgentResult.h.

◆ SetPrivateLinkConfig() [1/2]

void Aws::DataSync::Model::DescribeAgentResult::SetPrivateLinkConfig ( const PrivateLinkConfig value)
inline

The subnet and the security group that DataSync used to access a VPC endpoint.

Definition at line 255 of file DescribeAgentResult.h.

◆ SetPrivateLinkConfig() [2/2]

void Aws::DataSync::Model::DescribeAgentResult::SetPrivateLinkConfig ( PrivateLinkConfig &&  value)
inline

The subnet and the security group that DataSync used to access a VPC endpoint.

Definition at line 261 of file DescribeAgentResult.h.

◆ SetStatus() [1/2]

void Aws::DataSync::Model::DescribeAgentResult::SetStatus ( const AgentStatus value)
inline

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.

Definition at line 132 of file DescribeAgentResult.h.

◆ SetStatus() [2/2]

void Aws::DataSync::Model::DescribeAgentResult::SetStatus ( AgentStatus &&  value)
inline

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.

Definition at line 141 of file DescribeAgentResult.h.

◆ WithAgentArn() [1/3]

DescribeAgentResult& Aws::DataSync::Model::DescribeAgentResult::WithAgentArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the agent.

Definition at line 67 of file DescribeAgentResult.h.

◆ WithAgentArn() [2/3]

DescribeAgentResult& Aws::DataSync::Model::DescribeAgentResult::WithAgentArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the agent.

Definition at line 72 of file DescribeAgentResult.h.

◆ WithAgentArn() [3/3]

DescribeAgentResult& Aws::DataSync::Model::DescribeAgentResult::WithAgentArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the agent.

Definition at line 77 of file DescribeAgentResult.h.

◆ WithCreationTime() [1/2]

DescribeAgentResult& Aws::DataSync::Model::DescribeAgentResult::WithCreationTime ( const Aws::Utils::DateTime value)
inline

The time that the agent was activated (that is, created in your account).

Definition at line 206 of file DescribeAgentResult.h.

◆ WithCreationTime() [2/2]

DescribeAgentResult& Aws::DataSync::Model::DescribeAgentResult::WithCreationTime ( Aws::Utils::DateTime &&  value)
inline

The time that the agent was activated (that is, created in your account).

Definition at line 211 of file DescribeAgentResult.h.

◆ WithEndpointType() [1/2]

DescribeAgentResult& Aws::DataSync::Model::DescribeAgentResult::WithEndpointType ( const EndpointType value)
inline

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.

Definition at line 236 of file DescribeAgentResult.h.

◆ WithEndpointType() [2/2]

DescribeAgentResult& Aws::DataSync::Model::DescribeAgentResult::WithEndpointType ( EndpointType &&  value)
inline

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.

Definition at line 242 of file DescribeAgentResult.h.

◆ WithLastConnectionTime() [1/2]

DescribeAgentResult& Aws::DataSync::Model::DescribeAgentResult::WithLastConnectionTime ( const Aws::Utils::DateTime value)
inline

The time that the agent last connected to DataSyc.

Definition at line 180 of file DescribeAgentResult.h.

◆ WithLastConnectionTime() [2/2]

DescribeAgentResult& Aws::DataSync::Model::DescribeAgentResult::WithLastConnectionTime ( Aws::Utils::DateTime &&  value)
inline

The time that the agent last connected to DataSyc.

Definition at line 185 of file DescribeAgentResult.h.

◆ WithName() [1/3]

DescribeAgentResult& Aws::DataSync::Model::DescribeAgentResult::WithName ( const Aws::String value)
inline

The name of the agent.

Definition at line 103 of file DescribeAgentResult.h.

◆ WithName() [2/3]

DescribeAgentResult& Aws::DataSync::Model::DescribeAgentResult::WithName ( Aws::String &&  value)
inline

The name of the agent.

Definition at line 108 of file DescribeAgentResult.h.

◆ WithName() [3/3]

DescribeAgentResult& Aws::DataSync::Model::DescribeAgentResult::WithName ( const char *  value)
inline

The name of the agent.

Definition at line 113 of file DescribeAgentResult.h.

◆ WithPrivateLinkConfig() [1/2]

DescribeAgentResult& Aws::DataSync::Model::DescribeAgentResult::WithPrivateLinkConfig ( const PrivateLinkConfig value)
inline

The subnet and the security group that DataSync used to access a VPC endpoint.

Definition at line 267 of file DescribeAgentResult.h.

◆ WithPrivateLinkConfig() [2/2]

DescribeAgentResult& Aws::DataSync::Model::DescribeAgentResult::WithPrivateLinkConfig ( PrivateLinkConfig &&  value)
inline

The subnet and the security group that DataSync used to access a VPC endpoint.

Definition at line 273 of file DescribeAgentResult.h.

◆ WithStatus() [1/2]

DescribeAgentResult& Aws::DataSync::Model::DescribeAgentResult::WithStatus ( const AgentStatus value)
inline

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.

Definition at line 150 of file DescribeAgentResult.h.

◆ WithStatus() [2/2]

DescribeAgentResult& Aws::DataSync::Model::DescribeAgentResult::WithStatus ( AgentStatus &&  value)
inline

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.

Definition at line 159 of file DescribeAgentResult.h.


The documentation for this class was generated from the following file: