software.amazon.awssdk.services.workmail.model.User Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of workmail Show documentation
Show all versions of workmail Show documentation
The AWS Java SDK for Amazon WorkMail module holds the client classes that are used for communicating
with Amazon WorkMail Service
/*
* 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.workmail.model;
import java.beans.Transient;
import java.io.Serializable;
import java.time.Instant;
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.Function;
import software.amazon.awssdk.annotations.Generated;
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;
/**
*
* The representation of an Amazon WorkMail user.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class User implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Id")
.getter(getter(User::id)).setter(setter(Builder::id))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Id").build()).build();
private static final SdkField EMAIL_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Email")
.getter(getter(User::email)).setter(setter(Builder::email))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Email").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(User::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField DISPLAY_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DisplayName").getter(getter(User::displayName)).setter(setter(Builder::displayName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DisplayName").build()).build();
private static final SdkField STATE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("State")
.getter(getter(User::stateAsString)).setter(setter(Builder::state))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("State").build()).build();
private static final SdkField USER_ROLE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("UserRole").getter(getter(User::userRoleAsString)).setter(setter(Builder::userRole))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UserRole").build()).build();
private static final SdkField ENABLED_DATE_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("EnabledDate").getter(getter(User::enabledDate)).setter(setter(Builder::enabledDate))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EnabledDate").build()).build();
private static final SdkField DISABLED_DATE_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("DisabledDate").getter(getter(User::disabledDate)).setter(setter(Builder::disabledDate))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DisabledDate").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ID_FIELD, EMAIL_FIELD,
NAME_FIELD, DISPLAY_NAME_FIELD, STATE_FIELD, USER_ROLE_FIELD, ENABLED_DATE_FIELD, DISABLED_DATE_FIELD));
private static final long serialVersionUID = 1L;
private final String id;
private final String email;
private final String name;
private final String displayName;
private final String state;
private final String userRole;
private final Instant enabledDate;
private final Instant disabledDate;
private User(BuilderImpl builder) {
this.id = builder.id;
this.email = builder.email;
this.name = builder.name;
this.displayName = builder.displayName;
this.state = builder.state;
this.userRole = builder.userRole;
this.enabledDate = builder.enabledDate;
this.disabledDate = builder.disabledDate;
}
/**
*
* The identifier of the user.
*
*
* @return The identifier of the user.
*/
public final String id() {
return id;
}
/**
*
* The email of the user.
*
*
* @return The email of the user.
*/
public final String email() {
return email;
}
/**
*
* The name of the user.
*
*
* @return The name of the user.
*/
public final String name() {
return name;
}
/**
*
* The display name of the user.
*
*
* @return The display name of the user.
*/
public final String displayName() {
return displayName;
}
/**
*
* The state of the user, which can be ENABLED, DISABLED, or DELETED.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #state} will return
* {@link EntityState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateAsString}.
*
*
* @return The state of the user, which can be ENABLED, DISABLED, or DELETED.
* @see EntityState
*/
public final EntityState state() {
return EntityState.fromValue(state);
}
/**
*
* The state of the user, which can be ENABLED, DISABLED, or DELETED.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #state} will return
* {@link EntityState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateAsString}.
*
*
* @return The state of the user, which can be ENABLED, DISABLED, or DELETED.
* @see EntityState
*/
public final String stateAsString() {
return state;
}
/**
*
* The role of the user.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #userRole} will
* return {@link UserRole#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #userRoleAsString}.
*
*
* @return The role of the user.
* @see UserRole
*/
public final UserRole userRole() {
return UserRole.fromValue(userRole);
}
/**
*
* The role of the user.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #userRole} will
* return {@link UserRole#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #userRoleAsString}.
*
*
* @return The role of the user.
* @see UserRole
*/
public final String userRoleAsString() {
return userRole;
}
/**
*
* The date indicating when the user was enabled for Amazon WorkMail use.
*
*
* @return The date indicating when the user was enabled for Amazon WorkMail use.
*/
public final Instant enabledDate() {
return enabledDate;
}
/**
*
* The date indicating when the user was disabled from Amazon WorkMail use.
*
*
* @return The date indicating when the user was disabled from Amazon WorkMail use.
*/
public final Instant disabledDate() {
return disabledDate;
}
@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 + Objects.hashCode(id());
hashCode = 31 * hashCode + Objects.hashCode(email());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(displayName());
hashCode = 31 * hashCode + Objects.hashCode(stateAsString());
hashCode = 31 * hashCode + Objects.hashCode(userRoleAsString());
hashCode = 31 * hashCode + Objects.hashCode(enabledDate());
hashCode = 31 * hashCode + Objects.hashCode(disabledDate());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof User)) {
return false;
}
User other = (User) obj;
return Objects.equals(id(), other.id()) && Objects.equals(email(), other.email()) && Objects.equals(name(), other.name())
&& Objects.equals(displayName(), other.displayName()) && Objects.equals(stateAsString(), other.stateAsString())
&& Objects.equals(userRoleAsString(), other.userRoleAsString())
&& Objects.equals(enabledDate(), other.enabledDate()) && Objects.equals(disabledDate(), other.disabledDate());
}
/**
* 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("User").add("Id", id()).add("Email", email()).add("Name", name())
.add("DisplayName", displayName()).add("State", stateAsString()).add("UserRole", userRoleAsString())
.add("EnabledDate", enabledDate()).add("DisabledDate", disabledDate()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Id":
return Optional.ofNullable(clazz.cast(id()));
case "Email":
return Optional.ofNullable(clazz.cast(email()));
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "DisplayName":
return Optional.ofNullable(clazz.cast(displayName()));
case "State":
return Optional.ofNullable(clazz.cast(stateAsString()));
case "UserRole":
return Optional.ofNullable(clazz.cast(userRoleAsString()));
case "EnabledDate":
return Optional.ofNullable(clazz.cast(enabledDate()));
case "DisabledDate":
return Optional.ofNullable(clazz.cast(disabledDate()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((User) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The identifier of the user.
*
*
* @param id
* The identifier of the user.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder id(String id);
/**
*
* The email of the user.
*
*
* @param email
* The email of the user.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder email(String email);
/**
*
* The name of the user.
*
*
* @param name
* The name of the user.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The display name of the user.
*
*
* @param displayName
* The display name of the user.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder displayName(String displayName);
/**
*
* The state of the user, which can be ENABLED, DISABLED, or DELETED.
*
*
* @param state
* The state of the user, which can be ENABLED, DISABLED, or DELETED.
* @see EntityState
* @return Returns a reference to this object so that method calls can be chained together.
* @see EntityState
*/
Builder state(String state);
/**
*
* The state of the user, which can be ENABLED, DISABLED, or DELETED.
*
*
* @param state
* The state of the user, which can be ENABLED, DISABLED, or DELETED.
* @see EntityState
* @return Returns a reference to this object so that method calls can be chained together.
* @see EntityState
*/
Builder state(EntityState state);
/**
*
* The role of the user.
*
*
* @param userRole
* The role of the user.
* @see UserRole
* @return Returns a reference to this object so that method calls can be chained together.
* @see UserRole
*/
Builder userRole(String userRole);
/**
*
* The role of the user.
*
*
* @param userRole
* The role of the user.
* @see UserRole
* @return Returns a reference to this object so that method calls can be chained together.
* @see UserRole
*/
Builder userRole(UserRole userRole);
/**
*
* The date indicating when the user was enabled for Amazon WorkMail use.
*
*
* @param enabledDate
* The date indicating when the user was enabled for Amazon WorkMail use.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder enabledDate(Instant enabledDate);
/**
*
* The date indicating when the user was disabled from Amazon WorkMail use.
*
*
* @param disabledDate
* The date indicating when the user was disabled from Amazon WorkMail use.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder disabledDate(Instant disabledDate);
}
static final class BuilderImpl implements Builder {
private String id;
private String email;
private String name;
private String displayName;
private String state;
private String userRole;
private Instant enabledDate;
private Instant disabledDate;
private BuilderImpl() {
}
private BuilderImpl(User model) {
id(model.id);
email(model.email);
name(model.name);
displayName(model.displayName);
state(model.state);
userRole(model.userRole);
enabledDate(model.enabledDate);
disabledDate(model.disabledDate);
}
public final String getId() {
return id;
}
public final void setId(String id) {
this.id = id;
}
@Override
@Transient
public final Builder id(String id) {
this.id = id;
return this;
}
public final String getEmail() {
return email;
}
public final void setEmail(String email) {
this.email = email;
}
@Override
@Transient
public final Builder email(String email) {
this.email = email;
return this;
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
@Transient
public final Builder name(String name) {
this.name = name;
return this;
}
public final String getDisplayName() {
return displayName;
}
public final void setDisplayName(String displayName) {
this.displayName = displayName;
}
@Override
@Transient
public final Builder displayName(String displayName) {
this.displayName = displayName;
return this;
}
public final String getState() {
return state;
}
public final void setState(String state) {
this.state = state;
}
@Override
@Transient
public final Builder state(String state) {
this.state = state;
return this;
}
@Override
@Transient
public final Builder state(EntityState state) {
this.state(state == null ? null : state.toString());
return this;
}
public final String getUserRole() {
return userRole;
}
public final void setUserRole(String userRole) {
this.userRole = userRole;
}
@Override
@Transient
public final Builder userRole(String userRole) {
this.userRole = userRole;
return this;
}
@Override
@Transient
public final Builder userRole(UserRole userRole) {
this.userRole(userRole == null ? null : userRole.toString());
return this;
}
public final Instant getEnabledDate() {
return enabledDate;
}
public final void setEnabledDate(Instant enabledDate) {
this.enabledDate = enabledDate;
}
@Override
@Transient
public final Builder enabledDate(Instant enabledDate) {
this.enabledDate = enabledDate;
return this;
}
public final Instant getDisabledDate() {
return disabledDate;
}
public final void setDisabledDate(Instant disabledDate) {
this.disabledDate = disabledDate;
}
@Override
@Transient
public final Builder disabledDate(Instant disabledDate) {
this.disabledDate = disabledDate;
return this;
}
@Override
public User build() {
return new User(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy