software.amazon.awssdk.services.ec2.model.ClientVpnAuthentication Maven / Gradle / Ivy
/*
* 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.ec2.model;
import java.io.Serializable;
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.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;
/**
*
* Describes the authentication methods used by a Client VPN endpoint. For more information, see Authentication in the AWS Client VPN Administrator Guide.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ClientVpnAuthentication implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField TYPE_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("Type")
.getter(getter(ClientVpnAuthentication::typeAsString))
.setter(setter(Builder::type))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Type")
.unmarshallLocationName("type").build()).build();
private static final SdkField ACTIVE_DIRECTORY_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.memberName("ActiveDirectory")
.getter(getter(ClientVpnAuthentication::activeDirectory))
.setter(setter(Builder::activeDirectory))
.constructor(DirectoryServiceAuthentication::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ActiveDirectory")
.unmarshallLocationName("activeDirectory").build()).build();
private static final SdkField MUTUAL_AUTHENTICATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.memberName("MutualAuthentication")
.getter(getter(ClientVpnAuthentication::mutualAuthentication))
.setter(setter(Builder::mutualAuthentication))
.constructor(CertificateAuthentication::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MutualAuthentication")
.unmarshallLocationName("mutualAuthentication").build()).build();
private static final SdkField FEDERATED_AUTHENTICATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.memberName("FederatedAuthentication")
.getter(getter(ClientVpnAuthentication::federatedAuthentication))
.setter(setter(Builder::federatedAuthentication))
.constructor(FederatedAuthentication::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("FederatedAuthentication")
.unmarshallLocationName("federatedAuthentication").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TYPE_FIELD,
ACTIVE_DIRECTORY_FIELD, MUTUAL_AUTHENTICATION_FIELD, FEDERATED_AUTHENTICATION_FIELD));
private static final long serialVersionUID = 1L;
private final String type;
private final DirectoryServiceAuthentication activeDirectory;
private final CertificateAuthentication mutualAuthentication;
private final FederatedAuthentication federatedAuthentication;
private ClientVpnAuthentication(BuilderImpl builder) {
this.type = builder.type;
this.activeDirectory = builder.activeDirectory;
this.mutualAuthentication = builder.mutualAuthentication;
this.federatedAuthentication = builder.federatedAuthentication;
}
/**
*
* The authentication type used.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link ClientVpnAuthenticationType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #typeAsString}.
*
*
* @return The authentication type used.
* @see ClientVpnAuthenticationType
*/
public ClientVpnAuthenticationType type() {
return ClientVpnAuthenticationType.fromValue(type);
}
/**
*
* The authentication type used.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link ClientVpnAuthenticationType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #typeAsString}.
*
*
* @return The authentication type used.
* @see ClientVpnAuthenticationType
*/
public String typeAsString() {
return type;
}
/**
*
* Information about the Active Directory, if applicable.
*
*
* @return Information about the Active Directory, if applicable.
*/
public DirectoryServiceAuthentication activeDirectory() {
return activeDirectory;
}
/**
*
* Information about the authentication certificates, if applicable.
*
*
* @return Information about the authentication certificates, if applicable.
*/
public CertificateAuthentication mutualAuthentication() {
return mutualAuthentication;
}
/**
*
* Information about the IAM SAML identity provider, if applicable.
*
*
* @return Information about the IAM SAML identity provider, if applicable.
*/
public FederatedAuthentication federatedAuthentication() {
return federatedAuthentication;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(typeAsString());
hashCode = 31 * hashCode + Objects.hashCode(activeDirectory());
hashCode = 31 * hashCode + Objects.hashCode(mutualAuthentication());
hashCode = 31 * hashCode + Objects.hashCode(federatedAuthentication());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ClientVpnAuthentication)) {
return false;
}
ClientVpnAuthentication other = (ClientVpnAuthentication) obj;
return Objects.equals(typeAsString(), other.typeAsString()) && Objects.equals(activeDirectory(), other.activeDirectory())
&& Objects.equals(mutualAuthentication(), other.mutualAuthentication())
&& Objects.equals(federatedAuthentication(), other.federatedAuthentication());
}
/**
* 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 String toString() {
return ToString.builder("ClientVpnAuthentication").add("Type", typeAsString()).add("ActiveDirectory", activeDirectory())
.add("MutualAuthentication", mutualAuthentication()).add("FederatedAuthentication", federatedAuthentication())
.build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Type":
return Optional.ofNullable(clazz.cast(typeAsString()));
case "ActiveDirectory":
return Optional.ofNullable(clazz.cast(activeDirectory()));
case "MutualAuthentication":
return Optional.ofNullable(clazz.cast(mutualAuthentication()));
case "FederatedAuthentication":
return Optional.ofNullable(clazz.cast(federatedAuthentication()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ClientVpnAuthentication) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The authentication type used.
*
*
* @param type
* The authentication type used.
* @see ClientVpnAuthenticationType
* @return Returns a reference to this object so that method calls can be chained together.
* @see ClientVpnAuthenticationType
*/
Builder type(String type);
/**
*
* The authentication type used.
*
*
* @param type
* The authentication type used.
* @see ClientVpnAuthenticationType
* @return Returns a reference to this object so that method calls can be chained together.
* @see ClientVpnAuthenticationType
*/
Builder type(ClientVpnAuthenticationType type);
/**
*
* Information about the Active Directory, if applicable.
*
*
* @param activeDirectory
* Information about the Active Directory, if applicable.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder activeDirectory(DirectoryServiceAuthentication activeDirectory);
/**
*
* Information about the Active Directory, if applicable.
*
* This is a convenience that creates an instance of the {@link DirectoryServiceAuthentication.Builder} avoiding
* the need to create one manually via {@link DirectoryServiceAuthentication#builder()}.
*
* When the {@link Consumer} completes, {@link DirectoryServiceAuthentication.Builder#build()} is called
* immediately and its result is passed to {@link #activeDirectory(DirectoryServiceAuthentication)}.
*
* @param activeDirectory
* a consumer that will call methods on {@link DirectoryServiceAuthentication.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #activeDirectory(DirectoryServiceAuthentication)
*/
default Builder activeDirectory(Consumer activeDirectory) {
return activeDirectory(DirectoryServiceAuthentication.builder().applyMutation(activeDirectory).build());
}
/**
*
* Information about the authentication certificates, if applicable.
*
*
* @param mutualAuthentication
* Information about the authentication certificates, if applicable.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder mutualAuthentication(CertificateAuthentication mutualAuthentication);
/**
*
* Information about the authentication certificates, if applicable.
*
* This is a convenience that creates an instance of the {@link CertificateAuthentication.Builder} avoiding the
* need to create one manually via {@link CertificateAuthentication#builder()}.
*
* When the {@link Consumer} completes, {@link CertificateAuthentication.Builder#build()} is called immediately
* and its result is passed to {@link #mutualAuthentication(CertificateAuthentication)}.
*
* @param mutualAuthentication
* a consumer that will call methods on {@link CertificateAuthentication.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #mutualAuthentication(CertificateAuthentication)
*/
default Builder mutualAuthentication(Consumer mutualAuthentication) {
return mutualAuthentication(CertificateAuthentication.builder().applyMutation(mutualAuthentication).build());
}
/**
*
* Information about the IAM SAML identity provider, if applicable.
*
*
* @param federatedAuthentication
* Information about the IAM SAML identity provider, if applicable.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder federatedAuthentication(FederatedAuthentication federatedAuthentication);
/**
*
* Information about the IAM SAML identity provider, if applicable.
*
* This is a convenience that creates an instance of the {@link FederatedAuthentication.Builder} avoiding the
* need to create one manually via {@link FederatedAuthentication#builder()}.
*
* When the {@link Consumer} completes, {@link FederatedAuthentication.Builder#build()} is called immediately
* and its result is passed to {@link #federatedAuthentication(FederatedAuthentication)}.
*
* @param federatedAuthentication
* a consumer that will call methods on {@link FederatedAuthentication.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #federatedAuthentication(FederatedAuthentication)
*/
default Builder federatedAuthentication(Consumer federatedAuthentication) {
return federatedAuthentication(FederatedAuthentication.builder().applyMutation(federatedAuthentication).build());
}
}
static final class BuilderImpl implements Builder {
private String type;
private DirectoryServiceAuthentication activeDirectory;
private CertificateAuthentication mutualAuthentication;
private FederatedAuthentication federatedAuthentication;
private BuilderImpl() {
}
private BuilderImpl(ClientVpnAuthentication model) {
type(model.type);
activeDirectory(model.activeDirectory);
mutualAuthentication(model.mutualAuthentication);
federatedAuthentication(model.federatedAuthentication);
}
public final String getType() {
return type;
}
@Override
public final Builder type(String type) {
this.type = type;
return this;
}
@Override
public final Builder type(ClientVpnAuthenticationType type) {
this.type(type == null ? null : type.toString());
return this;
}
public final void setType(String type) {
this.type = type;
}
public final DirectoryServiceAuthentication.Builder getActiveDirectory() {
return activeDirectory != null ? activeDirectory.toBuilder() : null;
}
@Override
public final Builder activeDirectory(DirectoryServiceAuthentication activeDirectory) {
this.activeDirectory = activeDirectory;
return this;
}
public final void setActiveDirectory(DirectoryServiceAuthentication.BuilderImpl activeDirectory) {
this.activeDirectory = activeDirectory != null ? activeDirectory.build() : null;
}
public final CertificateAuthentication.Builder getMutualAuthentication() {
return mutualAuthentication != null ? mutualAuthentication.toBuilder() : null;
}
@Override
public final Builder mutualAuthentication(CertificateAuthentication mutualAuthentication) {
this.mutualAuthentication = mutualAuthentication;
return this;
}
public final void setMutualAuthentication(CertificateAuthentication.BuilderImpl mutualAuthentication) {
this.mutualAuthentication = mutualAuthentication != null ? mutualAuthentication.build() : null;
}
public final FederatedAuthentication.Builder getFederatedAuthentication() {
return federatedAuthentication != null ? federatedAuthentication.toBuilder() : null;
}
@Override
public final Builder federatedAuthentication(FederatedAuthentication federatedAuthentication) {
this.federatedAuthentication = federatedAuthentication;
return this;
}
public final void setFederatedAuthentication(FederatedAuthentication.BuilderImpl federatedAuthentication) {
this.federatedAuthentication = federatedAuthentication != null ? federatedAuthentication.build() : null;
}
@Override
public ClientVpnAuthentication build() {
return new ClientVpnAuthentication(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy