software.amazon.awssdk.services.transfer.model.TestIdentityProviderRequest Maven / Gradle / Ivy
Show all versions of transfer Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.transfer.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class TestIdentityProviderRequest extends TransferRequest implements
ToCopyableBuilder {
private static final SdkField SERVER_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ServerId").getter(getter(TestIdentityProviderRequest::serverId)).setter(setter(Builder::serverId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ServerId").build()).build();
private static final SdkField SERVER_PROTOCOL_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ServerProtocol").getter(getter(TestIdentityProviderRequest::serverProtocolAsString))
.setter(setter(Builder::serverProtocol))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ServerProtocol").build()).build();
private static final SdkField SOURCE_IP_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SourceIp").getter(getter(TestIdentityProviderRequest::sourceIp)).setter(setter(Builder::sourceIp))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SourceIp").build()).build();
private static final SdkField USER_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("UserName").getter(getter(TestIdentityProviderRequest::userName)).setter(setter(Builder::userName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UserName").build()).build();
private static final SdkField USER_PASSWORD_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("UserPassword").getter(getter(TestIdentityProviderRequest::userPassword))
.setter(setter(Builder::userPassword))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UserPassword").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(SERVER_ID_FIELD,
SERVER_PROTOCOL_FIELD, SOURCE_IP_FIELD, USER_NAME_FIELD, USER_PASSWORD_FIELD));
private final String serverId;
private final String serverProtocol;
private final String sourceIp;
private final String userName;
private final String userPassword;
private TestIdentityProviderRequest(BuilderImpl builder) {
super(builder);
this.serverId = builder.serverId;
this.serverProtocol = builder.serverProtocol;
this.sourceIp = builder.sourceIp;
this.userName = builder.userName;
this.userPassword = builder.userPassword;
}
/**
*
* A system-assigned identifier for a specific server. That server's user authentication method is tested with a
* user name and password.
*
*
* @return A system-assigned identifier for a specific server. That server's user authentication method is tested
* with a user name and password.
*/
public final String serverId() {
return serverId;
}
/**
*
* 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, {@link #serverProtocol}
* will return {@link Protocol#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #serverProtocolAsString}.
*
*
* @return 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 Protocol
*/
public final Protocol serverProtocol() {
return Protocol.fromValue(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, {@link #serverProtocol}
* will return {@link Protocol#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #serverProtocolAsString}.
*
*
* @return 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 Protocol
*/
public final String serverProtocolAsString() {
return serverProtocol;
}
/**
*
* The source IP address of the user account to be tested.
*
*
* @return The source IP address of the user account to be tested.
*/
public final String sourceIp() {
return sourceIp;
}
/**
*
* The name of the user account to be tested.
*
*
* @return The name of the user account to be tested.
*/
public final String userName() {
return userName;
}
/**
*
* The password of the user account to be tested.
*
*
* @return The password of the user account to be tested.
*/
public final String userPassword() {
return userPassword;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(serverId());
hashCode = 31 * hashCode + Objects.hashCode(serverProtocolAsString());
hashCode = 31 * hashCode + Objects.hashCode(sourceIp());
hashCode = 31 * hashCode + Objects.hashCode(userName());
hashCode = 31 * hashCode + Objects.hashCode(userPassword());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof TestIdentityProviderRequest)) {
return false;
}
TestIdentityProviderRequest other = (TestIdentityProviderRequest) obj;
return Objects.equals(serverId(), other.serverId())
&& Objects.equals(serverProtocolAsString(), other.serverProtocolAsString())
&& Objects.equals(sourceIp(), other.sourceIp()) && Objects.equals(userName(), other.userName())
&& Objects.equals(userPassword(), other.userPassword());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("TestIdentityProviderRequest").add("ServerId", serverId())
.add("ServerProtocol", serverProtocolAsString()).add("SourceIp", sourceIp()).add("UserName", userName())
.add("UserPassword", userPassword() == null ? null : "*** Sensitive Data Redacted ***").build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ServerId":
return Optional.ofNullable(clazz.cast(serverId()));
case "ServerProtocol":
return Optional.ofNullable(clazz.cast(serverProtocolAsString()));
case "SourceIp":
return Optional.ofNullable(clazz.cast(sourceIp()));
case "UserName":
return Optional.ofNullable(clazz.cast(userName()));
case "UserPassword":
return Optional.ofNullable(clazz.cast(userPassword()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((TestIdentityProviderRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends TransferRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* A system-assigned identifier for a specific server. That server's user authentication method is tested with a
* user name and password.
*
*
* @param serverId
* A system-assigned identifier for a specific server. That server's user authentication method is tested
* with a user name and password.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder serverId(String serverId);
/**
*
* 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)
*
*
*
*
* @param 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)
*
*
* @see Protocol
* @return Returns a reference to this object so that method calls can be chained together.
* @see Protocol
*/
Builder serverProtocol(String 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)
*
*
*
*
* @param 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)
*
*
* @see Protocol
* @return Returns a reference to this object so that method calls can be chained together.
* @see Protocol
*/
Builder serverProtocol(Protocol serverProtocol);
/**
*
* The source IP address of the user account to be tested.
*
*
* @param sourceIp
* The source IP address of the user account to be tested.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sourceIp(String sourceIp);
/**
*
* The name of the user account to be tested.
*
*
* @param userName
* The name of the user account to be tested.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder userName(String userName);
/**
*
* The password of the user account to be tested.
*
*
* @param userPassword
* The password of the user account to be tested.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder userPassword(String userPassword);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends TransferRequest.BuilderImpl implements Builder {
private String serverId;
private String serverProtocol;
private String sourceIp;
private String userName;
private String userPassword;
private BuilderImpl() {
}
private BuilderImpl(TestIdentityProviderRequest model) {
super(model);
serverId(model.serverId);
serverProtocol(model.serverProtocol);
sourceIp(model.sourceIp);
userName(model.userName);
userPassword(model.userPassword);
}
public final String getServerId() {
return serverId;
}
@Override
public final Builder serverId(String serverId) {
this.serverId = serverId;
return this;
}
public final void setServerId(String serverId) {
this.serverId = serverId;
}
public final String getServerProtocol() {
return serverProtocol;
}
@Override
public final Builder serverProtocol(String serverProtocol) {
this.serverProtocol = serverProtocol;
return this;
}
@Override
public final Builder serverProtocol(Protocol serverProtocol) {
this.serverProtocol(serverProtocol == null ? null : serverProtocol.toString());
return this;
}
public final void setServerProtocol(String serverProtocol) {
this.serverProtocol = serverProtocol;
}
public final String getSourceIp() {
return sourceIp;
}
@Override
public final Builder sourceIp(String sourceIp) {
this.sourceIp = sourceIp;
return this;
}
public final void setSourceIp(String sourceIp) {
this.sourceIp = sourceIp;
}
public final String getUserName() {
return userName;
}
@Override
public final Builder userName(String userName) {
this.userName = userName;
return this;
}
public final void setUserName(String userName) {
this.userName = userName;
}
public final String getUserPassword() {
return userPassword;
}
@Override
public final Builder userPassword(String userPassword) {
this.userPassword = userPassword;
return this;
}
public final void setUserPassword(String userPassword) {
this.userPassword = userPassword;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public TestIdentityProviderRequest build() {
return new TestIdentityProviderRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}