Class BatchCreateUserRequestItem

java.lang.Object
software.amazon.awssdk.services.wickr.model.BatchCreateUserRequestItem
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<BatchCreateUserRequestItem.Builder,BatchCreateUserRequestItem>
@Generated("software.amazon.awssdk:codegen") public final class BatchCreateUserRequestItem extends Object implements SdkPojo, Serializable, ToCopyableBuilder<BatchCreateUserRequestItem.Builder,BatchCreateUserRequestItem>

Contains the details for a single user to be created in a batch user creation request.

A user can only be assigned to a single security group. Attempting to add a user to multiple security groups is not supported and will result in an error.

codeValidation, inviteCode, and inviteCodeTtl are restricted to networks under preview only.

See Also:

  • Method Details

    • firstName

      public final String firstName()

      The first name of the user.

      Returns:
      The first name of the user.

    • lastName

      public final String lastName()

      The last name of the user.

      Returns:
      The last name of the user.

    • hasSecurityGroupIds

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

    • securityGroupIds

      public final List<String> securityGroupIds()

      A list of security group IDs to which the user should be assigned.

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

      Returns:
      A list of security group IDs to which the user should be assigned.

    • username

      public final String username()

      The email address or username for the user. Must be unique within the network.

      Returns:
      The email address or username for the user. Must be unique within the network.

    • inviteCode

      public final String inviteCode()

      A custom invite code for the user. If not provided, one will be generated automatically.

      Returns:
      A custom invite code for the user. If not provided, one will be generated automatically.

    • inviteCodeTtl

      public final Integer inviteCodeTtl()

      The time-to-live for the invite code in days. After this period, the invite code will expire.

      Returns:
      The time-to-live for the invite code in days. After this period, the invite code will expire.

    • codeValidation

      public final Boolean codeValidation()

      Indicates whether the user can be verified through a custom invite code.

      Returns:
      Indicates whether the user can be verified through a custom invite code.

    • toBuilder

      public BatchCreateUserRequestItem.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<BatchCreateUserRequestItem.Builder,BatchCreateUserRequestItem>
      Returns:
      a builder for type T

    • builder

      public static BatchCreateUserRequestItem.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.