software.amazon.awssdk.services.directory.model

Class DescribeLdapsSettingsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.directory.model.DirectoryRequest

software.amazon.awssdk.services.directory.model.DescribeLdapsSettingsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeLdapsSettingsRequest.Builder,DescribeLdapsSettingsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeLdapsSettingsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeLdapsSettingsRequest.Builder	builder()
String	directoryId() The identifier of the directory.
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) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Integer	limit() Specifies the number of items that should be displayed on one page.
String	nextToken() The type of next token used for pagination.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeLdapsSettingsRequest.Builder>	serializableBuilderClass()
DescribeLdapsSettingsRequest.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.
LDAPSType	type() The type of LDAP security to enable.
String	typeAsString() The type of LDAP security to enable.

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

overrideConfiguration

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

directoryId

public String directoryId()

The identifier of the directory.

Returns:

The identifier of the directory.

type

public LDAPSType type()

The type of LDAP security to enable. Currently only the value Client is supported.

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

Returns:

The type of LDAP security to enable. Currently only the value Client is supported.

See Also:

LDAPSType

typeAsString

public String typeAsString()

The type of LDAP security to enable. Currently only the value Client is supported.

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

Returns:

The type of LDAP security to enable. Currently only the value Client is supported.

See Also:

LDAPSType

nextToken

public String nextToken()

The type of next token used for pagination.

Returns:

The type of next token used for pagination.

limit

public Integer limit()

Specifies the number of items that should be displayed on one page.

Returns:

Specifies the number of items that should be displayed on one page.

toBuilder

public DescribeLdapsSettingsRequest.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<DescribeLdapsSettingsRequest.Builder,DescribeLdapsSettingsRequest>

Specified by:

toBuilder in class DirectoryRequest

Returns:

a builder for type T

builder

public static DescribeLdapsSettingsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeLdapsSettingsRequest.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)

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 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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

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

public 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.