java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.storagegateway.model.StorageGatewayRequest
    - - software.amazon.awssdk.services.storagegateway.model.JoinDomainRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<JoinDomainRequest.Builder,JoinDomainRequest>

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

JoinDomainInput

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface JoinDomainRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static JoinDomainRequest.Builder`	`builder()`
`List<String>`	`domainControllers()`	List of IPv4 addresses, NetBIOS names, or host names of your domain server.
`String`	`domainName()`	The name of the domain that you want the gateway to join.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`gatewayARN()`	The Amazon Resource Name (ARN) of the gateway.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasDomainControllers()`	For responses, this returns true if the service returned a value for the DomainControllers property.
`int`	`hashCode()`
`String`	`organizationalUnit()`	The organizational unit (OU) is a container in an Active Directory that can hold users, groups, computers, and other OUs and this parameter specifies the OU that the gateway will join within the AD domain.
`String`	`password()`	Sets the password of the user who has permission to add the gateway to the Active Directory domain.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends JoinDomainRequest.Builder>`	`serializableBuilderClass()`
`Integer`	`timeoutInSeconds()`	Specifies the time in seconds, in which the `JoinDomain` operation must complete.
`JoinDomainRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`userName()`	Sets the user name of user who has permission to add the gateway to the Active Directory domain.

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
  - gatewayARN
```
public final String gatewayARN()
```
    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
  - domainName
```
public final String domainName()
```
    The name of the domain that you want the gateway to join.
    
    Returns:
    
    The name of the domain that you want the gateway to join.
  - organizationalUnit
```
public final String organizationalUnit()
```
    The organizational unit (OU) is a container in an Active Directory that can hold users, groups, computers, and other OUs and this parameter specifies the OU that the gateway will join within the AD domain.
    
    Returns:
    
    The organizational unit (OU) is a container in an Active Directory that can hold users, groups, computers, and other OUs and this parameter specifies the OU that the gateway will join within the AD domain.
  - hasDomainControllers
```
public final boolean hasDomainControllers()
```
    For responses, this returns true if the service returned a value for the DomainControllers 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.
  - domainControllers
```
public final List<String> domainControllers()
```
    List of IPv4 addresses, NetBIOS names, or host names of your domain server. If you need to specify the port number include it after the colon (“:”). For example, mydc.mydomain.com:389.
    
    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 hasDomainControllers() method.
    
    Returns:
    
    List of IPv4 addresses, NetBIOS names, or host names of your domain server. If you need to specify the port number include it after the colon (“:”). For example, mydc.mydomain.com:389.
  - timeoutInSeconds
```
public final Integer timeoutInSeconds()
```
    Specifies the time in seconds, in which the JoinDomain operation must complete. The default is 20 seconds.
    
    Returns:
    
    Specifies the time in seconds, in which the JoinDomain operation must complete. The default is 20 seconds.
  - userName
```
public final String userName()
```
    Sets the user name of user who has permission to add the gateway to the Active Directory domain. The domain user account should be enabled to join computers to the domain. For example, you can use the domain administrator account or an account with delegated permissions to join computers to the domain.
    
    Returns:
    
    Sets the user name of user who has permission to add the gateway to the Active Directory domain. The domain user account should be enabled to join computers to the domain. For example, you can use the domain administrator account or an account with delegated permissions to join computers to the domain.
  - password
```
public final String password()
```
    Sets the password of the user who has permission to add the gateway to the Active Directory domain.
    
    Returns:
    
    Sets the password of the user who has permission to add the gateway to the Active Directory domain.
  - toBuilder
```
public JoinDomainRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<JoinDomainRequest.Builder,JoinDomainRequest>
    
    Specified by:
    
    toBuilder in class StorageGatewayRequest
  - builder
```
public static JoinDomainRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends JoinDomainRequest.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

Class JoinDomainRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

gatewayARN

domainName

organizationalUnit

hasDomainControllers

domainControllers

timeoutInSeconds

userName

password

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields