software.amazon.awssdk.services.transfer.model

Class TestIdentityProviderRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.transfer.model.TransferRequest

software.amazon.awssdk.services.transfer.model.TestIdentityProviderRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<TestIdentityProviderRequest.Builder,TestIdentityProviderRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TestIdentityProviderRequest.Builder

Method Summary

Modifier and Type	Method and Description
static TestIdentityProviderRequest.Builder	builder()
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 TestIdentityProviderRequest.Builder>	serializableBuilderClass()
String	serverId() A system-assigned identifier for a specific server.
Protocol	serverProtocol() The type of file transfer protocol to be tested.
String	serverProtocolAsString() The type of file transfer protocol to be tested.
String	sourceIp() The source IP address of the user account to be tested.
TestIdentityProviderRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	userName() The name of the user account to be tested.
String	userPassword() The password of the user account to be tested.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

serverId

public String serverId()

A system-assigned identifier for a specific server. That server's user authentication method is tested with a user name and password.

Returns:

A system-assigned identifier for a specific server. That server's user authentication method is tested with a user name and password.

serverProtocol

public Protocol serverProtocol()

The type of file transfer protocol to be tested.

The available protocols are:

• Secure Shell (SSH) File Transfer Protocol (SFTP)

• File Transfer Protocol Secure (FTPS)

• File Transfer Protocol (FTP)

If the service returns an enum value that is not available in the current SDK version, serverProtocol will return Protocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serverProtocolAsString().

Returns:

The type of file transfer protocol to be tested.

The available protocols are:

• Secure Shell (SSH) File Transfer Protocol (SFTP)

• File Transfer Protocol Secure (FTPS)

• File Transfer Protocol (FTP)

See Also:

Protocol

serverProtocolAsString

public String serverProtocolAsString()

The type of file transfer protocol to be tested.

The available protocols are:

• Secure Shell (SSH) File Transfer Protocol (SFTP)

• File Transfer Protocol Secure (FTPS)

• File Transfer Protocol (FTP)

If the service returns an enum value that is not available in the current SDK version, serverProtocol will return Protocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serverProtocolAsString().

Returns:

The type of file transfer protocol to be tested.

The available protocols are:

• Secure Shell (SSH) File Transfer Protocol (SFTP)

• File Transfer Protocol Secure (FTPS)

• File Transfer Protocol (FTP)

See Also:

Protocol

sourceIp

public String sourceIp()

The source IP address of the user account to be tested.

Returns:

The source IP address of the user account to be tested.

userName

public String userName()

The name of the user account to be tested.

Returns:

The name of the user account to be tested.

userPassword

public String userPassword()

The password of the user account to be tested.

Returns:

The password of the user account to be tested.

toBuilder

public TestIdentityProviderRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TestIdentityProviderRequest.Builder,TestIdentityProviderRequest>

Specified by:

toBuilder in class TransferRequest

builder

public static TestIdentityProviderRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo