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

Class ConnectDirectoryRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ConnectDirectoryRequest.Builder,ConnectDirectoryRequest>

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

Contains the inputs for the ConnectDirectory operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ConnectDirectoryRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ConnectDirectoryRequest.Builder	builder()
DirectoryConnectSettings	connectSettings()	A DirectoryConnectSettings object that contains additional information for the operation.
String	description()	A description for the directory.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	name()	The fully qualified name of your self-managed directory, such as corp.example.com.
String	password()	The password for your self-managed user account.
List<SdkField<?>>	sdkFields()
static Class<? extends ConnectDirectoryRequest.Builder>	serializableBuilderClass()
String	shortName()	The NetBIOS name of your self-managed directory, such as CORP.
DirectorySize	size()	The size of the directory.
String	sizeAsString()	The size of the directory.
List<Tag>	tags()	The tags to be assigned to AD Connector.
ConnectDirectoryRequest.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

name

public final String name()

The fully qualified name of your self-managed directory, such as corp.example.com.

Returns:

The fully qualified name of your self-managed directory, such as corp.example.com.

shortName

public final String shortName()

The NetBIOS name of your self-managed directory, such as CORP.

Returns:

The NetBIOS name of your self-managed directory, such as CORP.

password

public final String password()

The password for your self-managed user account.

Returns:

The password for your self-managed user account.

description

public final String description()

A description for the directory.

Returns:

A description for the directory.

size

public final DirectorySize size()

The size of the directory.

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

Returns:

The size of the directory.

See Also:

DirectorySize

sizeAsString

public final String sizeAsString()

The size of the directory.

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

Returns:

The size of the directory.

See Also:

DirectorySize

connectSettings

public final DirectoryConnectSettings connectSettings()

A DirectoryConnectSettings object that contains additional information for the operation.

Returns:

A DirectoryConnectSettings object that contains additional information for the operation.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags 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.

tags

public final List<Tag> tags()

The tags to be assigned to AD Connector.

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 hasTags() method.

Returns:

The tags to be assigned to AD Connector.

toBuilder

public ConnectDirectoryRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ConnectDirectoryRequest.Builder,ConnectDirectoryRequest>

Specified by:

toBuilder in class DirectoryRequest

builder

public static ConnectDirectoryRequest.Builder builder()

serializableBuilderClass

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