software.amazon.awssdk.services.datasync.model

Interface DescribeAgentResponse.Builder

All Superinterfaces:

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

Enclosing class:

DescribeAgentResponse

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

Method Summary

Modifier and Type	Method and Description
DescribeAgentResponse.Builder	agentArn(String agentArn) The Amazon Resource Name (ARN) of the agent.
DescribeAgentResponse.Builder	creationTime(Instant creationTime) The time that the agent was activated (that is, created in your account).
DescribeAgentResponse.Builder	endpointType(EndpointType endpointType) The type of endpoint that your agent is connected to.
DescribeAgentResponse.Builder	endpointType(String endpointType) The type of endpoint that your agent is connected to.
DescribeAgentResponse.Builder	lastConnectionTime(Instant lastConnectionTime) The time that the agent last connected to DataSyc.
DescribeAgentResponse.Builder	name(String name) The name of the agent.
default DescribeAgentResponse.Builder	privateLinkConfig(Consumer<PrivateLinkConfig.Builder> privateLinkConfig) The subnet and the security group that DataSync used to access a VPC endpoint.
DescribeAgentResponse.Builder	privateLinkConfig(PrivateLinkConfig privateLinkConfig) The subnet and the security group that DataSync used to access a VPC endpoint.
DescribeAgentResponse.Builder	status(AgentStatus status) The status of the agent.
DescribeAgentResponse.Builder	status(String status) The status of the agent.

Methods inherited from interface software.amazon.awssdk.services.datasync.model.DataSyncResponse.Builder

build, responseMetadata, responseMetadata

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

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

agentArn

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

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, 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, AgentStatus

status

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

lastConnectionTime

DescribeAgentResponse.Builder lastConnectionTime(Instant lastConnectionTime)

The time that the agent last connected to DataSyc.

Parameters:

lastConnectionTime - The time that the agent last connected to DataSyc.

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 (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.

endpointType

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

endpointType

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

privateLinkConfig

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

privateLinkConfig

default DescribeAgentResponse.Builder privateLinkConfig(Consumer<PrivateLinkConfig.Builder> privateLinkConfig)

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

This is a convenience 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)