software.amazon.awssdk.services.directory.model

Class RadiusSettings

java.lang.Object

software.amazon.awssdk.services.directory.model.RadiusSettings

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RadiusSettings.Builder,RadiusSettings>

@Generated(value="software.amazon.awssdk:codegen")
public final class RadiusSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RadiusSettings.Builder,RadiusSettings>

Contains information about a Remote Authentication Dial In User Service (RADIUS) server.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RadiusSettings.Builder

Method Summary

Modifier and Type	Method and Description
RadiusAuthenticationProtocol	authenticationProtocol() The protocol specified for your RADIUS endpoints.
String	authenticationProtocolAsString() The protocol specified for your RADIUS endpoints.
static RadiusSettings.Builder	builder()
String	displayLabel() Not currently used.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRadiusServers() For responses, this returns true if the service returned a value for the RadiusServers property.
Integer	radiusPort() The port that your RADIUS server is using for communications.
Integer	radiusRetries() The maximum number of times that communication with the RADIUS server is attempted.
List<String>	radiusServers() An array of strings that contains the fully qualified domain name (FQDN) or IP addresses of the RADIUS server endpoints, or the FQDN or IP addresses of your RADIUS server load balancer.
Integer	radiusTimeout() The amount of time, in seconds, to wait for the RADIUS server to respond.
List<SdkField<?>>	sdkFields()
static Class<? extends RadiusSettings.Builder>	serializableBuilderClass()
String	sharedSecret() Required for enabling RADIUS on the directory.
RadiusSettings.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
Boolean	useSameUsername() Not currently used.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

hasRadiusServers

public final boolean hasRadiusServers()

For responses, this returns true if the service returned a value for the RadiusServers property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

radiusServers

public final List<String> radiusServers()

An array of strings that contains the fully qualified domain name (FQDN) or IP addresses of the RADIUS server endpoints, or the FQDN or IP addresses of your RADIUS server load balancer.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRadiusServers() method.

Returns:

An array of strings that contains the fully qualified domain name (FQDN) or IP addresses of the RADIUS server endpoints, or the FQDN or IP addresses of your RADIUS server load balancer.

radiusPort

public final Integer radiusPort()

The port that your RADIUS server is using for communications. Your self-managed network must allow inbound traffic over this port from the Directory Service servers.

Returns:

The port that your RADIUS server is using for communications. Your self-managed network must allow inbound traffic over this port from the Directory Service servers.

radiusTimeout

public final Integer radiusTimeout()

The amount of time, in seconds, to wait for the RADIUS server to respond.

Returns:

The amount of time, in seconds, to wait for the RADIUS server to respond.

radiusRetries

public final Integer radiusRetries()

The maximum number of times that communication with the RADIUS server is attempted.

Returns:

The maximum number of times that communication with the RADIUS server is attempted.

sharedSecret

public final String sharedSecret()

Required for enabling RADIUS on the directory.

Returns:

Required for enabling RADIUS on the directory.

authenticationProtocol

public final RadiusAuthenticationProtocol authenticationProtocol()

The protocol specified for your RADIUS endpoints.

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

Returns:

The protocol specified for your RADIUS endpoints.

See Also:

RadiusAuthenticationProtocol

authenticationProtocolAsString

public final String authenticationProtocolAsString()

The protocol specified for your RADIUS endpoints.

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

Returns:

The protocol specified for your RADIUS endpoints.

See Also:

RadiusAuthenticationProtocol

displayLabel

public final String displayLabel()

Not currently used.

Returns:

Not currently used.

useSameUsername

public final Boolean useSameUsername()

Not currently used.

Returns:

Not currently used.

toBuilder

public RadiusSettings.Builder 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 interface ToCopyableBuilder<RadiusSettings.Builder,RadiusSettings>

Returns:

a builder for type T

builder

public static RadiusSettings.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

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 an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.