Interface DescribeAgentResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<DescribeAgentResponse.Builder,
,DescribeAgentResponse> DataSyncResponse.Builder
,SdkBuilder<DescribeAgentResponse.Builder,
,DescribeAgentResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
DescribeAgentResponse
-
Method Summary
Modifier and TypeMethodDescriptionThe ARN of the agent.creationTime
(Instant creationTime) The time that the agent was activated.endpointType
(String endpointType) The type of service endpoint that your agent is connected to.endpointType
(EndpointType endpointType) The type of service endpoint that your agent is connected to.lastConnectionTime
(Instant lastConnectionTime) The last time that the agent was communicating with the DataSync service.The name of the agent.default DescribeAgentResponse.Builder
platform
(Consumer<Platform.Builder> platform) The platform-related details about the agent, such as the version number.The platform-related details about the agent, such as the version number.default DescribeAgentResponse.Builder
privateLinkConfig
(Consumer<PrivateLinkConfig.Builder> privateLinkConfig) The network configuration that the agent uses when connecting to a VPC service endpoint.privateLinkConfig
(PrivateLinkConfig privateLinkConfig) The network configuration that the agent uses when connecting to a VPC service endpoint.The status of the agent.status
(AgentStatus status) The status of the agent.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.datasync.model.DataSyncResponse.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
agentArn
The ARN of the agent.
- Parameters:
agentArn
- The ARN of the agent.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
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?
- Parameters:
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?
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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?
- Parameters:
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?
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
lastConnectionTime
The last time that the agent was communicating with the DataSync service.
- Parameters:
lastConnectionTime
- The last time that the agent was communicating with the DataSync service.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
creationTime
The time that the agent was activated.
- Parameters:
creationTime
- The time that the agent was activated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endpointType
The type of service endpoint that your agent is connected to.
- Parameters:
endpointType
- The type of service endpoint that your agent is connected to.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
endpointType
The type of service endpoint that your agent is connected to.
- Parameters:
endpointType
- The type of service endpoint that your agent is connected to.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
privateLinkConfig
The network configuration that the agent uses when connecting to a VPC service endpoint.
- Parameters:
privateLinkConfig
- The network configuration that the agent uses when connecting to a VPC service endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
privateLinkConfig
default DescribeAgentResponse.Builder privateLinkConfig(Consumer<PrivateLinkConfig.Builder> privateLinkConfig) The network configuration that the agent uses when connecting to a VPC service endpoint.
This is a convenience method that creates an instance of thePrivateLinkConfig.Builder
avoiding the need to create one manually viaPrivateLinkConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toprivateLinkConfig(PrivateLinkConfig)
.- Parameters:
privateLinkConfig
- a consumer that will call methods onPrivateLinkConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
platform
The platform-related details about the agent, such as the version number.
- Parameters:
platform
- The platform-related details about the agent, such as the version number.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
platform
The platform-related details about the agent, such as the version number.
This is a convenience method that creates an instance of thePlatform.Builder
avoiding the need to create one manually viaPlatform.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toplatform(Platform)
.- Parameters:
platform
- a consumer that will call methods onPlatform.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-