Package software.amazon.awssdk.services.directoryservicedata.model

Class UpdateUserRequest

    • Method Detail

      • clientToken

        public final String clientToken()

        A unique and case-sensitive identifier that you provide to make sure the idempotency of the request, so multiple identical calls have the same effect as one single call.

        A client token is valid for 8 hours after the first request that uses it completes. After 8 hours, any request with the same client token is treated as a new request. If the request succeeds, any future uses of that token will be idempotent for another 8 hours.

        If you submit a request with the same client token but change one of the other parameters within the 8-hour idempotency window, Directory Service Data returns an ConflictException.

        This parameter is optional when using the CLI or SDK.

        Returns:
        A unique and case-sensitive identifier that you provide to make sure the idempotency of the request, so multiple identical calls have the same effect as one single call.

        A client token is valid for 8 hours after the first request that uses it completes. After 8 hours, any request with the same client token is treated as a new request. If the request succeeds, any future uses of that token will be idempotent for another 8 hours.

        If you submit a request with the same client token but change one of the other parameters within the 8-hour idempotency window, Directory Service Data returns an ConflictException.

        This parameter is optional when using the CLI or SDK.

      • directoryId

        public final String directoryId()

        The identifier (ID) of the directory that's associated with the user.

        Returns:
        The identifier (ID) of the directory that's associated with the user.

      • emailAddress

        public final String emailAddress()

        The email address of the user.

        Returns:
        The email address of the user.

      • givenName

        public final String givenName()

        The first name of the user.

        Returns:
        The first name of the user.

      • hasOtherAttributes

        public final boolean hasOtherAttributes()
        For responses, this returns true if the service returned a value for the OtherAttributes 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.

      • otherAttributes

        public final Map<String,​AttributeValue> otherAttributes()

        An expression that defines one or more attribute names with the data type and value of each attribute. A key is an attribute name, and the value is a list of maps. For a list of supported attributes, see Directory Service Data Attributes.

        Attribute names are case insensitive.

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

        Returns:
        An expression that defines one or more attribute names with the data type and value of each attribute. A key is an attribute name, and the value is a list of maps. For a list of supported attributes, see Directory Service Data Attributes.

        Attribute names are case insensitive.

      • samAccountName

        public final String samAccountName()

        The name of the user.

        Returns:
        The name of the user.

      • surname

        public final String surname()

        The last name of the user.

        Returns:
        The last name of the user.

      • updateType

        public final UpdateType updateType()

        The type of update to be performed. If no value exists for the attribute, use ADD. Otherwise, use REPLACE to change an attribute value or REMOVE to clear the attribute value.

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

        Returns:
        The type of update to be performed. If no value exists for the attribute, use ADD. Otherwise, use REPLACE to change an attribute value or REMOVE to clear the attribute value.
        See Also:
        UpdateType

      • updateTypeAsString

        public final String updateTypeAsString()

        The type of update to be performed. If no value exists for the attribute, use ADD. Otherwise, use REPLACE to change an attribute value or REMOVE to clear the attribute value.

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

        Returns:
        The type of update to be performed. If no value exists for the attribute, use ADD. Otherwise, use REPLACE to change an attribute value or REMOVE to clear the attribute value.
        See Also:
        UpdateType

      • 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