Class DescribeAgentResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeAgentResponse.Builder,
DescribeAgentResponse>
DescribeAgentResponse
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
agentArn()
The ARN of the agent.builder()
final Instant
The time that the agent was activated.final EndpointType
The type of service endpoint that your agent is connected to.final String
The type of service endpoint that your agent is connected to.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final Instant
The last time that the agent was communicating with the DataSync service.final String
name()
The name of the agent.final Platform
platform()
The platform-related details about the agent, such as the version number.final PrivateLinkConfig
The network configuration that the agent uses when connecting to a VPC service endpoint.static Class
<? extends DescribeAgentResponse.Builder> final AgentStatus
status()
The status of the agent.final String
The status of the agent.Take this object and create a builder that contains all of the current property values of this object.final 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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
agentArn
The ARN of the agent.
- Returns:
- The ARN of the agent.
-
name
The name of the agent.
- Returns:
- The name of the agent.
-
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 returnAgentStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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
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 returnAgentStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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
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
The time that the agent was activated.
- Returns:
- The time that the agent was activated.
-
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 returnEndpointType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromendpointTypeAsString()
.- Returns:
- The type of service endpoint that your agent is connected to.
- See Also:
-
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 returnEndpointType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromendpointTypeAsString()
.- Returns:
- The type of service endpoint that your agent is connected to.
- See Also:
-
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
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
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 interfaceToCopyableBuilder<DescribeAgentResponse.Builder,
DescribeAgentResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-