ConnectDirectoryRequest (AWS Java SDK for AWS Directory Service 1.10.22 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.directory.model.ConnectDirectoryRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable
```
public class ConnectDirectoryRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable
```
Container for the parameters to the ConnectDirectory operation.
Creates an AD Connector to connect an on-premises directory.

See Also:
AWSDirectoryService.connectDirectory(ConnectDirectoryRequest), Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

ConnectDirectoryRequest()

Constructors
Constructor and Description
`ConnectDirectoryRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`ConnectDirectoryRequest`	`clone()`
`boolean`	`equals(Object obj)`
`DirectoryConnectSettings`	`getConnectSettings()` A DirectoryConnectSettings object that contains additional information for the operation.
`String`	`getDescription()` A textual description for the directory.
`String`	`getName()` The fully-qualified name of the on-premises directory, such as `corp.example.com`.
`String`	`getPassword()` The password for the on-premises user account.
`String`	`getShortName()` The NetBIOS name of the on-premises directory, such as `CORP`.
`String`	`getSize()` The size of the directory.
`int`	`hashCode()`
`void`	`setConnectSettings(DirectoryConnectSettings connectSettings)` A DirectoryConnectSettings object that contains additional information for the operation.
`void`	`setDescription(String description)` A textual description for the directory.
`void`	`setName(String name)` The fully-qualified name of the on-premises directory, such as `corp.example.com`.
`void`	`setPassword(String password)` The password for the on-premises user account.
`void`	`setShortName(String shortName)` The NetBIOS name of the on-premises directory, such as `CORP`.
`void`	`setSize(DirectorySize size)` The size of the directory.
`void`	`setSize(String size)` The size of the directory.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ConnectDirectoryRequest`	`withConnectSettings(DirectoryConnectSettings connectSettings)` A DirectoryConnectSettings object that contains additional information for the operation.
`ConnectDirectoryRequest`	`withDescription(String description)` A textual description for the directory.
`ConnectDirectoryRequest`	`withName(String name)` The fully-qualified name of the on-premises directory, such as `corp.example.com`.
`ConnectDirectoryRequest`	`withPassword(String password)` The password for the on-premises user account.
`ConnectDirectoryRequest`	`withShortName(String shortName)` The NetBIOS name of the on-premises directory, such as `CORP`.
`ConnectDirectoryRequest`	`withSize(DirectorySize size)` The size of the directory.
`ConnectDirectoryRequest`	`withSize(String size)` The size of the directory.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ConnectDirectoryRequest
```
public ConnectDirectoryRequest()
```
- Method Detail
  - getName
```
public String getName()
```
    The fully-qualified name of the on-premises directory, such as corp.example.com.
    Constraints:
    Pattern: ^([a-zA-Z0-9]+[\\.-])+([a-zA-Z0-9])+$
    
    Returns:
    The fully-qualified name of the on-premises directory, such as corp.example.com.
  - setName
```
public void setName(String name)
```
    The fully-qualified name of the on-premises directory, such as corp.example.com.
    Constraints:
    Pattern: ^([a-zA-Z0-9]+[\\.-])+([a-zA-Z0-9])+$
    
    Parameters:
    name - The fully-qualified name of the on-premises directory, such as corp.example.com.
  - withName
```
public ConnectDirectoryRequest withName(String name)
```
    The fully-qualified name of the on-premises directory, such as corp.example.com.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: ^([a-zA-Z0-9]+[\\.-])+([a-zA-Z0-9])+$
    
    Parameters:
    name - The fully-qualified name of the on-premises directory, such as corp.example.com.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getShortName
```
public String getShortName()
```
    The NetBIOS name of the on-premises directory, such as CORP.
    Constraints:
    Pattern: ^[^\\/:*?\"\<\>|.]+[^\\/:*?\"<>|]*$
    
    Returns:
    The NetBIOS name of the on-premises directory, such as CORP.
  - setShortName
```
public void setShortName(String shortName)
```
    The NetBIOS name of the on-premises directory, such as CORP.
    Constraints:
    Pattern: ^[^\\/:*?\"\<\>|.]+[^\\/:*?\"<>|]*$
    
    Parameters:
    shortName - The NetBIOS name of the on-premises directory, such as CORP.
  - withShortName
```
public ConnectDirectoryRequest withShortName(String shortName)
```
    The NetBIOS name of the on-premises directory, such as CORP.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: ^[^\\/:*?\"\<\>|.]+[^\\/:*?\"<>|]*$
    
    Parameters:
    shortName - The NetBIOS name of the on-premises directory, such as CORP.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getPassword
```
public String getPassword()
```
    The password for the on-premises user account.
    Constraints:
    Length: 1 - 128
    
    Returns:
    The password for the on-premises user account.
  - setPassword
```
public void setPassword(String password)
```
    The password for the on-premises user account.
    Constraints:
    Length: 1 - 128
    
    Parameters:
    password - The password for the on-premises user account.
  - withPassword
```
public ConnectDirectoryRequest withPassword(String password)
```
    The password for the on-premises user account.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    
    Parameters:
    password - The password for the on-premises user account.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getDescription
```
public String getDescription()
```
    A textual description for the directory.
    Constraints:
    Length: 0 - 128
    Pattern: ^([a-zA-Z0-9_])[\\a-zA-Z0-9_@#%*+=:?./!\s-]*$
    
    Returns:
    A textual description for the directory.
  - setDescription
```
public void setDescription(String description)
```
    A textual description for the directory.
    Constraints:
    Length: 0 - 128
    Pattern: ^([a-zA-Z0-9_])[\\a-zA-Z0-9_@#%*+=:?./!\s-]*$
    
    Parameters:
    description - A textual description for the directory.
  - withDescription
```
public ConnectDirectoryRequest withDescription(String description)
```
    A textual description for the directory.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 128
    Pattern: ^([a-zA-Z0-9_])[\\a-zA-Z0-9_@#%*+=:?./!\s-]*$
    
    Parameters:
    description - A textual description for the directory.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getSize
```
public String getSize()
```
    The size of the directory.
    Constraints:
    Allowed Values: Small, Large
    
    Returns:
    The size of the directory.
    See Also:
    DirectorySize
  - setSize
```
public void setSize(String size)
```
    The size of the directory.
    Constraints:
    Allowed Values: Small, Large
    
    Parameters:
    size - The size of the directory.
    See Also:
    DirectorySize
  - withSize
```
public ConnectDirectoryRequest withSize(String size)
```
    The size of the directory.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: Small, Large
    
    Parameters:
    size - The size of the directory.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    DirectorySize
  - setSize
```
public void setSize(DirectorySize size)
```
    The size of the directory.
    Constraints:
    Allowed Values: Small, Large
    
    Parameters:
    size - The size of the directory.
    See Also:
    DirectorySize
  - withSize
```
public ConnectDirectoryRequest withSize(DirectorySize size)
```
    The size of the directory.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: Small, Large
    
    Parameters:
    size - The size of the directory.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    DirectorySize
  - getConnectSettings
```
public DirectoryConnectSettings getConnectSettings()
```
    A DirectoryConnectSettings object that contains additional information for the operation.
    
    Returns:
    A DirectoryConnectSettings object that contains additional information for the operation.
  - setConnectSettings
```
public void setConnectSettings(DirectoryConnectSettings connectSettings)
```
    A DirectoryConnectSettings object that contains additional information for the operation.
    
    Parameters:
    connectSettings - A DirectoryConnectSettings object that contains additional information for the operation.
  - withConnectSettings
```
public ConnectDirectoryRequest withConnectSettings(DirectoryConnectSettings connectSettings)
```
    A DirectoryConnectSettings object that contains additional information for the operation.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    connectSettings - A DirectoryConnectSettings object that contains additional information for the operation.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of this object.
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - clone
```
public ConnectDirectoryRequest clone()
```
    Overrides:
    
    clone in class AmazonWebServiceRequest

Class ConnectDirectoryRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

ConnectDirectoryRequest

Method Detail

getName

setName

withName

getShortName

setShortName

withShortName

getPassword

setPassword

withPassword

getDescription

setDescription

withDescription

getSize

setSize

withSize

setSize

withSize

getConnectSettings

setConnectSettings

withConnectSettings

toString

hashCode

equals

clone