software.amazon.awssdk.services.directory.model

Class CreateDirectoryRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDirectoryRequest.Builder,CreateDirectoryRequest>

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

Contains the inputs for the CreateDirectory operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateDirectoryRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateDirectoryRequest.Builder	builder()
String	description() A textual description for the directory.
boolean	equals(Object obj)
<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()
String	name() The fully qualified name for the directory, such as corp.example.com.
String	password() The password for the directory administrator.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDirectoryRequest.Builder>	serializableBuilderClass()
String	shortName() The short name of the directory, such as CORP.
DirectorySize	size() The size of the directory.
String	sizeAsString() The size of the directory.
CreateDirectoryRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
DirectoryVpcSettings	vpcSettings() A DirectoryVpcSettings object that contains additional information for the operation.

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

name

public String name()

The fully qualified name for the directory, such as corp.example.com.

Returns:

The fully qualified name for the directory, such as corp.example.com.

shortName

public String shortName()

The short name of the directory, such as CORP.

Returns:

The short name of the directory, such as CORP.

password

public String password()

The password for the directory administrator. The directory creation process creates a directory administrator account with the user name Administrator and this password.

Returns:

The password for the directory administrator. The directory creation process creates a directory administrator account with the user name Administrator and this password.

description

public String description()

A textual description for the directory.

Returns:

A textual description for the directory.

size

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

vpcSettings

public DirectoryVpcSettings vpcSettings()

A DirectoryVpcSettings object that contains additional information for the operation.

Returns:

A DirectoryVpcSettings object that contains additional information for the operation.

toBuilder

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

Specified by:

toBuilder in class DirectoryRequest

Returns:

a builder for type T

builder

public static CreateDirectoryRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

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.