Interface TestConnectionResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<TestConnectionResponse.Builder,TestConnectionResponse>, SdkBuilder<TestConnectionResponse.Builder,TestConnectionResponse>, SdkPojo, SdkResponse.Builder, TransferResponse.Builder
Enclosing class:
TestConnectionResponse
@Mutable @NotThreadSafe public static interface TestConnectionResponse.Builder extends TransferResponse.Builder, SdkPojo, CopyableBuilder<TestConnectionResponse.Builder,TestConnectionResponse>

  • Method Details

    • connectorId

      TestConnectionResponse.Builder connectorId(String connectorId)

      Returns the identifier of the connector object that you are testing.

      Parameters:
      connectorId - Returns the identifier of the connector object that you are testing.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      TestConnectionResponse.Builder status(String status)

      Returns OK for successful test, or ERROR if the test fails.

      Parameters:
      status - Returns OK for successful test, or ERROR if the test fails.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • statusMessage

      TestConnectionResponse.Builder statusMessage(String statusMessage)

      Returns Connection succeeded if the test is successful. Or, returns a descriptive error message if the test fails. The following list provides troubleshooting details, depending on the error message that you receive.

      • Verify that your secret name aligns with the one in Transfer Role permissions.

      • Verify the server URL in the connector configuration , and verify that the login credentials work successfully outside of the connector.

      • Verify that the secret exists and is formatted correctly.

      • Verify that the trusted host key in the connector configuration matches the ssh-keyscan output.

      Parameters:
      statusMessage - Returns Connection succeeded if the test is successful. Or, returns a descriptive error message if the test fails. The following list provides troubleshooting details, depending on the error message that you receive.

      • Verify that your secret name aligns with the one in Transfer Role permissions.

      • Verify the server URL in the connector configuration , and verify that the login credentials work successfully outside of the connector.

      • Verify that the secret exists and is formatted correctly.

      • Verify that the trusted host key in the connector configuration matches the ssh-keyscan output.

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

    • sftpConnectionDetails

      TestConnectionResponse.Builder sftpConnectionDetails(SftpConnectorConnectionDetails sftpConnectionDetails)

      Structure that contains the SFTP connector host key.

      Parameters:
      sftpConnectionDetails - Structure that contains the SFTP connector host key.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sftpConnectionDetails

      default TestConnectionResponse.Builder sftpConnectionDetails(Consumer<SftpConnectorConnectionDetails.Builder> sftpConnectionDetails)

      Structure that contains the SFTP connector host key.

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

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

      Parameters:
      sftpConnectionDetails - a consumer that will call methods on SftpConnectorConnectionDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: