Class TestConnectionResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<TestConnectionResponse.Builder,
TestConnectionResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
Returns the identifier of the connector object that you are testing.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
static Class
<? extends TestConnectionResponse.Builder> final String
status()
ReturnsOK
for successful test, orERROR
if the test fails.final String
ReturnsConnection succeeded
if the test is successful.Take this object and create a builder that contains all of the current property values of this object.final 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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
Returns
OK
for successful test, orERROR
if the test fails.- Returns:
- Returns
OK
for successful test, orERROR
if the test fails.
-
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
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.
-
-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<TestConnectionResponse.Builder,
TestConnectionResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-