software.amazon.awssdk.services.appstream.model.CreateUserRequest Maven / Gradle / Ivy
Show all versions of appstream Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.appstream.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateUserRequest extends AppStreamRequest implements
ToCopyableBuilder {
private static final SdkField USER_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("UserName").getter(getter(CreateUserRequest::userName)).setter(setter(Builder::userName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UserName").build()).build();
private static final SdkField MESSAGE_ACTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("MessageAction").getter(getter(CreateUserRequest::messageActionAsString))
.setter(setter(Builder::messageAction))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MessageAction").build()).build();
private static final SdkField FIRST_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("FirstName").getter(getter(CreateUserRequest::firstName)).setter(setter(Builder::firstName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("FirstName").build()).build();
private static final SdkField LAST_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("LastName").getter(getter(CreateUserRequest::lastName)).setter(setter(Builder::lastName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LastName").build()).build();
private static final SdkField AUTHENTICATION_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AuthenticationType").getter(getter(CreateUserRequest::authenticationTypeAsString))
.setter(setter(Builder::authenticationType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AuthenticationType").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(USER_NAME_FIELD,
MESSAGE_ACTION_FIELD, FIRST_NAME_FIELD, LAST_NAME_FIELD, AUTHENTICATION_TYPE_FIELD));
private final String userName;
private final String messageAction;
private final String firstName;
private final String lastName;
private final String authenticationType;
private CreateUserRequest(BuilderImpl builder) {
super(builder);
this.userName = builder.userName;
this.messageAction = builder.messageAction;
this.firstName = builder.firstName;
this.lastName = builder.lastName;
this.authenticationType = builder.authenticationType;
}
/**
*
* The email address of the user.
*
*
*
* Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the
* same capitalization as the email address specified when their user pool account was created, a
* "user does not exist" error message displays.
*
*
*
* @return The email address of the user.
*
* Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't
* use the same capitalization as the email address specified when their user pool account was created, a
* "user does not exist" error message displays.
*
*/
public final String userName() {
return userName;
}
/**
*
* The action to take for the welcome email that is sent to a user after the user is created in the user pool. If
* you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the
* user. If the value is null, the email is sent.
*
*
*
* The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7
* days, you must send them a new welcome email.
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #messageAction}
* will return {@link MessageAction#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #messageActionAsString}.
*
*
* @return The action to take for the welcome email that is sent to a user after the user is created in the user
* pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or
* last name of the user. If the value is null, the email is sent.
*
* The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords
* within 7 days, you must send them a new welcome email.
*
* @see MessageAction
*/
public final MessageAction messageAction() {
return MessageAction.fromValue(messageAction);
}
/**
*
* The action to take for the welcome email that is sent to a user after the user is created in the user pool. If
* you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the
* user. If the value is null, the email is sent.
*
*
*
* The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7
* days, you must send them a new welcome email.
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #messageAction}
* will return {@link MessageAction#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #messageActionAsString}.
*
*
* @return The action to take for the welcome email that is sent to a user after the user is created in the user
* pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or
* last name of the user. If the value is null, the email is sent.
*
* The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords
* within 7 days, you must send them a new welcome email.
*
* @see MessageAction
*/
public final String messageActionAsString() {
return messageAction;
}
/**
*
* The first name, or given name, of the user.
*
*
* @return The first name, or given name, of the user.
*/
public final String firstName() {
return firstName;
}
/**
*
* The last name, or surname, of the user.
*
*
* @return The last name, or surname, of the user.
*/
public final String lastName() {
return lastName;
}
/**
*
* The authentication type for the user. You must specify USERPOOL.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #authenticationType} will return {@link AuthenticationType#UNKNOWN_TO_SDK_VERSION}. The raw value returned
* by the service is available from {@link #authenticationTypeAsString}.
*
*
* @return The authentication type for the user. You must specify USERPOOL.
* @see AuthenticationType
*/
public final AuthenticationType authenticationType() {
return AuthenticationType.fromValue(authenticationType);
}
/**
*
* The authentication type for the user. You must specify USERPOOL.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #authenticationType} will return {@link AuthenticationType#UNKNOWN_TO_SDK_VERSION}. The raw value returned
* by the service is available from {@link #authenticationTypeAsString}.
*
*
* @return The authentication type for the user. You must specify USERPOOL.
* @see AuthenticationType
*/
public final String authenticationTypeAsString() {
return authenticationType;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(userName());
hashCode = 31 * hashCode + Objects.hashCode(messageActionAsString());
hashCode = 31 * hashCode + Objects.hashCode(firstName());
hashCode = 31 * hashCode + Objects.hashCode(lastName());
hashCode = 31 * hashCode + Objects.hashCode(authenticationTypeAsString());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreateUserRequest)) {
return false;
}
CreateUserRequest other = (CreateUserRequest) obj;
return Objects.equals(userName(), other.userName())
&& Objects.equals(messageActionAsString(), other.messageActionAsString())
&& Objects.equals(firstName(), other.firstName()) && Objects.equals(lastName(), other.lastName())
&& Objects.equals(authenticationTypeAsString(), other.authenticationTypeAsString());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("CreateUserRequest")
.add("UserName", userName() == null ? null : "*** Sensitive Data Redacted ***")
.add("MessageAction", messageActionAsString())
.add("FirstName", firstName() == null ? null : "*** Sensitive Data Redacted ***")
.add("LastName", lastName() == null ? null : "*** Sensitive Data Redacted ***")
.add("AuthenticationType", authenticationTypeAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "UserName":
return Optional.ofNullable(clazz.cast(userName()));
case "MessageAction":
return Optional.ofNullable(clazz.cast(messageActionAsString()));
case "FirstName":
return Optional.ofNullable(clazz.cast(firstName()));
case "LastName":
return Optional.ofNullable(clazz.cast(lastName()));
case "AuthenticationType":
return Optional.ofNullable(clazz.cast(authenticationTypeAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateUserRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends AppStreamRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The email address of the user.
*
*
*
* Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use
* the same capitalization as the email address specified when their user pool account was created, a
* "user does not exist" error message displays.
*
*
*
* @param userName
* The email address of the user.
*
* Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't
* use the same capitalization as the email address specified when their user pool account was created, a
* "user does not exist" error message displays.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder userName(String userName);
/**
*
* The action to take for the welcome email that is sent to a user after the user is created in the user pool.
* If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name
* of the user. If the value is null, the email is sent.
*
*
*
* The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords
* within 7 days, you must send them a new welcome email.
*
*
*
* @param messageAction
* The action to take for the welcome email that is sent to a user after the user is created in the user
* pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name
* or last name of the user. If the value is null, the email is sent.
*
* The temporary password in the welcome email is valid for only 7 days. If users don’t set their
* passwords within 7 days, you must send them a new welcome email.
*
* @see MessageAction
* @return Returns a reference to this object so that method calls can be chained together.
* @see MessageAction
*/
Builder messageAction(String messageAction);
/**
*
* The action to take for the welcome email that is sent to a user after the user is created in the user pool.
* If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name
* of the user. If the value is null, the email is sent.
*
*
*
* The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords
* within 7 days, you must send them a new welcome email.
*
*
*
* @param messageAction
* The action to take for the welcome email that is sent to a user after the user is created in the user
* pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name
* or last name of the user. If the value is null, the email is sent.
*
* The temporary password in the welcome email is valid for only 7 days. If users don’t set their
* passwords within 7 days, you must send them a new welcome email.
*
* @see MessageAction
* @return Returns a reference to this object so that method calls can be chained together.
* @see MessageAction
*/
Builder messageAction(MessageAction messageAction);
/**
*
* The first name, or given name, of the user.
*
*
* @param firstName
* The first name, or given name, of the user.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder firstName(String firstName);
/**
*
* The last name, or surname, of the user.
*
*
* @param lastName
* The last name, or surname, of the user.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lastName(String lastName);
/**
*
* The authentication type for the user. You must specify USERPOOL.
*
*
* @param authenticationType
* The authentication type for the user. You must specify USERPOOL.
* @see AuthenticationType
* @return Returns a reference to this object so that method calls can be chained together.
* @see AuthenticationType
*/
Builder authenticationType(String authenticationType);
/**
*
* The authentication type for the user. You must specify USERPOOL.
*
*
* @param authenticationType
* The authentication type for the user. You must specify USERPOOL.
* @see AuthenticationType
* @return Returns a reference to this object so that method calls can be chained together.
* @see AuthenticationType
*/
Builder authenticationType(AuthenticationType authenticationType);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends AppStreamRequest.BuilderImpl implements Builder {
private String userName;
private String messageAction;
private String firstName;
private String lastName;
private String authenticationType;
private BuilderImpl() {
}
private BuilderImpl(CreateUserRequest model) {
super(model);
userName(model.userName);
messageAction(model.messageAction);
firstName(model.firstName);
lastName(model.lastName);
authenticationType(model.authenticationType);
}
public final String getUserName() {
return userName;
}
@Override
public final Builder userName(String userName) {
this.userName = userName;
return this;
}
public final void setUserName(String userName) {
this.userName = userName;
}
public final String getMessageAction() {
return messageAction;
}
@Override
public final Builder messageAction(String messageAction) {
this.messageAction = messageAction;
return this;
}
@Override
public final Builder messageAction(MessageAction messageAction) {
this.messageAction(messageAction == null ? null : messageAction.toString());
return this;
}
public final void setMessageAction(String messageAction) {
this.messageAction = messageAction;
}
public final String getFirstName() {
return firstName;
}
@Override
public final Builder firstName(String firstName) {
this.firstName = firstName;
return this;
}
public final void setFirstName(String firstName) {
this.firstName = firstName;
}
public final String getLastName() {
return lastName;
}
@Override
public final Builder lastName(String lastName) {
this.lastName = lastName;
return this;
}
public final void setLastName(String lastName) {
this.lastName = lastName;
}
public final String getAuthenticationType() {
return authenticationType;
}
@Override
public final Builder authenticationType(String authenticationType) {
this.authenticationType = authenticationType;
return this;
}
@Override
public final Builder authenticationType(AuthenticationType authenticationType) {
this.authenticationType(authenticationType == null ? null : authenticationType.toString());
return this;
}
public final void setAuthenticationType(String authenticationType) {
this.authenticationType = authenticationType;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateUserRequest build() {
return new CreateUserRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}