Package software.amazon.awssdk.services.storagegateway.model

Class JoinDomainRequest

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

  • Method Details

    • 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()
      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<JoinDomainRequest.Builder,JoinDomainRequest>
      Specified by:
      toBuilder in class StorageGatewayRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      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 final 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.