Interface DescribeAgentResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeAgentResponse.Builder,DescribeAgentResponse>, DataSyncResponse.Builder, SdkBuilder<DescribeAgentResponse.Builder,DescribeAgentResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeAgentResponse

@Mutable
@NotThreadSafe
public static interface DescribeAgentResponse.Builder
extends DataSyncResponse.Builder, SdkPojo, CopyableBuilder<DescribeAgentResponse.Builder,DescribeAgentResponse>

Method Summary

Modifier and Type	Method	Description
DescribeAgentResponse.Builder	agentArn(String agentArn)	The ARN of the agent.
DescribeAgentResponse.Builder	creationTime(Instant creationTime)	The time that the agent was activated.
DescribeAgentResponse.Builder	endpointType(String endpointType)	The type of service endpoint that your agent is connected to.
DescribeAgentResponse.Builder	endpointType(EndpointType endpointType)	The type of service endpoint that your agent is connected to.
DescribeAgentResponse.Builder	lastConnectionTime(Instant lastConnectionTime)	The last time that the agent was communicating with the DataSync service.
DescribeAgentResponse.Builder	name(String name)	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.
DescribeAgentResponse.Builder	platform(Platform platform)	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.
DescribeAgentResponse.Builder	privateLinkConfig(PrivateLinkConfig privateLinkConfig)	The network configuration that the agent uses when connecting to a VPC service endpoint.
DescribeAgentResponse.Builder	status(String status)	The status of the agent.
DescribeAgentResponse.Builder	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, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Details

agentArn

DescribeAgentResponse.Builder agentArn(String 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

DescribeAgentResponse.Builder name(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.

status

DescribeAgentResponse.Builder status(String 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:

• AgentStatus
• AgentStatus

status

DescribeAgentResponse.Builder status(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?

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:

• AgentStatus
• AgentStatus

lastConnectionTime

DescribeAgentResponse.Builder lastConnectionTime(Instant 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

DescribeAgentResponse.Builder creationTime(Instant 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

DescribeAgentResponse.Builder endpointType(String 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
• EndpointType

endpointType

DescribeAgentResponse.Builder endpointType(EndpointType 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
• EndpointType

privateLinkConfig

DescribeAgentResponse.Builder privateLinkConfig(PrivateLinkConfig 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 the PrivateLinkConfig.Builder avoiding the need to create one manually via PrivateLinkConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to privateLinkConfig(PrivateLinkConfig).

Parameters:

privateLinkConfig - a consumer that will call methods on PrivateLinkConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• privateLinkConfig(PrivateLinkConfig)

platform

DescribeAgentResponse.Builder platform(Platform 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

default DescribeAgentResponse.Builder platform(Consumer<Platform.Builder> platform)

The platform-related details about the agent, such as the version number.

This is a convenience method that creates an instance of the Platform.Builder avoiding the need to create one manually via Platform.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to platform(Platform).

Parameters:

platform - a consumer that will call methods on Platform.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• platform(Platform)