software.amazon.awssdk.services.transfer.model

Class TestConnectionResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.transfer.model.TransferResponse

software.amazon.awssdk.services.transfer.model.TestConnectionResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<TestConnectionResponse.Builder,TestConnectionResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class TestConnectionResponse
extends TransferResponse
implements ToCopyableBuilder<TestConnectionResponse.Builder,TestConnectionResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TestConnectionResponse.Builder

Method Summary

Modifier and Type	Method and Description
static TestConnectionResponse.Builder	builder()
String	connectorId() Returns the identifier of the connector object that you are testing.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends TestConnectionResponse.Builder>	serializableBuilderClass()
String	status() Returns OK for successful test, or ERROR if the test fails.
String	statusMessage() Returns Connection succeeded if the test is successful.
TestConnectionResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.transfer.model.TransferResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

connectorId

public final String connectorId()

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

Returns:

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

status

public final String status()

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

Returns:

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

statusMessage

public final String statusMessage()

Returns Connection succeeded if the test is successful. Or, returns a descriptive error message if the test fails. The following list provides the details for some error messages and troubleshooting steps for each.

• Unable to access secrets manager: Verify that your secret name aligns with the one in Transfer Role permissions.

• Unknown Host/Connection failed: Verify the server URL in the connector configuration , and verify that the login credentials work successfully outside of the connector.

• Private key not found: Verify that the secret exists and is formatted correctly.

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

Returns:

Returns Connection succeeded if the test is successful. Or, returns a descriptive error message if the test fails. The following list provides the details for some error messages and troubleshooting steps for each.

• Unable to access secrets manager: Verify that your secret name aligns with the one in Transfer Role permissions.

• Unknown Host/Connection failed: Verify the server URL in the connector configuration , and verify that the login credentials work successfully outside of the connector.

• Private key not found: Verify that the secret exists and is formatted correctly.

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

toBuilder

public TestConnectionResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TestConnectionResponse.Builder,TestConnectionResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static TestConnectionResponse.Builder builder()

serializableBuilderClass

public static Class<? extends TestConnectionResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo