Package software.amazon.awssdk.services.directory.model

Class DescribeSettingsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeSettingsRequest.Builder,DescribeSettingsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeSettingsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeSettingsRequest.Builder	builder()
String	directoryId()	The identifier of the directory for which to retrieve information.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	nextToken()	The DescribeSettingsResult.NextToken value from a previous call to DescribeSettings.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeSettingsRequest.Builder>	serializableBuilderClass()
DirectoryConfigurationStatus	status()	The status of the directory settings for which to retrieve information.
String	statusAsString()	The status of the directory settings for which to retrieve information.
DescribeSettingsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

directoryId

public final String directoryId()

The identifier of the directory for which to retrieve information.

Returns:

The identifier of the directory for which to retrieve information.

status

public final DirectoryConfigurationStatus status()

The status of the directory settings for which to retrieve information.

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

Returns:

The status of the directory settings for which to retrieve information.

See Also:

DirectoryConfigurationStatus

statusAsString

public final String statusAsString()

The status of the directory settings for which to retrieve information.

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

Returns:

The status of the directory settings for which to retrieve information.

See Also:

DirectoryConfigurationStatus

nextToken

public final String nextToken()

The DescribeSettingsResult.NextToken value from a previous call to DescribeSettings. Pass null if this is the first call.

Returns:

The DescribeSettingsResult.NextToken value from a previous call to DescribeSettings. Pass null if this is the first call.

toBuilder

public DescribeSettingsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeSettingsRequest.Builder,DescribeSettingsRequest>

Specified by:

toBuilder in class DirectoryRequest

builder

public static DescribeSettingsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo