software.amazon.awssdk.services.iam.model.UserDetail Maven / Gradle / Ivy
Show all versions of iam 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.iam.model;
import java.io.Serializable;
import java.time.Instant;
import java.util.Arrays;
import java.util.Collection;
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 java.util.stream.Collectors;
import java.util.stream.Stream;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Contains information about an IAM user, including all the user's policies and all the IAM groups the user is in.
*
*
* This data type is used as a response element in the GetAccountAuthorizationDetails operation.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class UserDetail implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField PATH_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(UserDetail::path)).setter(setter(Builder::path))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Path").build()).build();
private static final SdkField USER_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(UserDetail::userName)).setter(setter(Builder::userName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UserName").build()).build();
private static final SdkField USER_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(UserDetail::userId)).setter(setter(Builder::userId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UserId").build()).build();
private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(UserDetail::arn)).setter(setter(Builder::arn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Arn").build()).build();
private static final SdkField CREATE_DATE_FIELD = SdkField. builder(MarshallingType.INSTANT)
.getter(getter(UserDetail::createDate)).setter(setter(Builder::createDate))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreateDate").build()).build();
private static final SdkField> USER_POLICY_LIST_FIELD = SdkField
.> builder(MarshallingType.LIST)
.getter(getter(UserDetail::userPolicyList))
.setter(setter(Builder::userPolicyList))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UserPolicyList").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(PolicyDetail::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> GROUP_LIST_FIELD = SdkField
.> builder(MarshallingType.LIST)
.getter(getter(UserDetail::groupList))
.setter(setter(Builder::groupList))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GroupList").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> ATTACHED_MANAGED_POLICIES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.getter(getter(UserDetail::attachedManagedPolicies))
.setter(setter(Builder::attachedManagedPolicies))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AttachedManagedPolicies").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(AttachedPolicy::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField PERMISSIONS_BOUNDARY_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).getter(getter(UserDetail::permissionsBoundary))
.setter(setter(Builder::permissionsBoundary)).constructor(AttachedPermissionsBoundary::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PermissionsBoundary").build())
.build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.getter(getter(UserDetail::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(PATH_FIELD, USER_NAME_FIELD,
USER_ID_FIELD, ARN_FIELD, CREATE_DATE_FIELD, USER_POLICY_LIST_FIELD, GROUP_LIST_FIELD,
ATTACHED_MANAGED_POLICIES_FIELD, PERMISSIONS_BOUNDARY_FIELD, TAGS_FIELD));
private static final long serialVersionUID = 1L;
private final String path;
private final String userName;
private final String userId;
private final String arn;
private final Instant createDate;
private final List userPolicyList;
private final List groupList;
private final List attachedManagedPolicies;
private final AttachedPermissionsBoundary permissionsBoundary;
private final List tags;
private UserDetail(BuilderImpl builder) {
this.path = builder.path;
this.userName = builder.userName;
this.userId = builder.userId;
this.arn = builder.arn;
this.createDate = builder.createDate;
this.userPolicyList = builder.userPolicyList;
this.groupList = builder.groupList;
this.attachedManagedPolicies = builder.attachedManagedPolicies;
this.permissionsBoundary = builder.permissionsBoundary;
this.tags = builder.tags;
}
/**
*
* The path to the user. For more information about paths, see IAM Identifiers in the IAM
* User Guide.
*
*
* @return The path to the user. For more information about paths, see IAM Identifiers in the
* IAM User Guide.
*/
public String path() {
return path;
}
/**
*
* The friendly name identifying the user.
*
*
* @return The friendly name identifying the user.
*/
public String userName() {
return userName;
}
/**
*
* The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the IAM
* User Guide.
*
*
* @return The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the
* IAM User Guide.
*/
public String userId() {
return userId;
}
/**
* Returns the value of the Arn property for this object.
*
* @return The value of the Arn property for this object.
*/
public String arn() {
return arn;
}
/**
*
* The date and time, in ISO 8601 date-time format, when the user was
* created.
*
*
* @return The date and time, in ISO 8601 date-time format, when the
* user was created.
*/
public Instant createDate() {
return createDate;
}
/**
* Returns true if the UserPolicyList property was specified by the sender (it may be empty), or false if the sender
* did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public boolean hasUserPolicyList() {
return userPolicyList != null && !(userPolicyList instanceof SdkAutoConstructList);
}
/**
*
* A list of the inline policies embedded in the user.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasUserPolicyList()} to see if a value was sent in this field.
*
*
* @return A list of the inline policies embedded in the user.
*/
public List userPolicyList() {
return userPolicyList;
}
/**
* Returns true if the GroupList property was specified by the sender (it may be empty), or false if the sender did
* not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public boolean hasGroupList() {
return groupList != null && !(groupList instanceof SdkAutoConstructList);
}
/**
*
* A list of IAM groups that the user is in.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasGroupList()} to see if a value was sent in this field.
*
*
* @return A list of IAM groups that the user is in.
*/
public List groupList() {
return groupList;
}
/**
* Returns true if the AttachedManagedPolicies property was specified by the sender (it may be empty), or false if
* the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS
* service.
*/
public boolean hasAttachedManagedPolicies() {
return attachedManagedPolicies != null && !(attachedManagedPolicies instanceof SdkAutoConstructList);
}
/**
*
* A list of the managed policies attached to the user.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasAttachedManagedPolicies()} to see if a value was sent in this field.
*
*
* @return A list of the managed policies attached to the user.
*/
public List attachedManagedPolicies() {
return attachedManagedPolicies;
}
/**
*
* The ARN of the policy used to set the permissions boundary for the user.
*
*
* For more information about permissions boundaries, see Permissions Boundaries
* for IAM Identities in the IAM User Guide.
*
*
* @return The ARN of the policy used to set the permissions boundary for the user.
*
* For more information about permissions boundaries, see Permissions
* Boundaries for IAM Identities in the IAM User Guide.
*/
public AttachedPermissionsBoundary permissionsBoundary() {
return permissionsBoundary;
}
/**
* Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not
* specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public boolean hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* A list of tags that are associated with the specified user. For more information about tagging, see Tagging IAM Identities in the IAM
* User Guide.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasTags()} to see if a value was sent in this field.
*
*
* @return A list of tags that are associated with the specified user. For more information about tagging, see Tagging IAM Identities in the
* IAM User Guide.
*/
public List tags() {
return tags;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(path());
hashCode = 31 * hashCode + Objects.hashCode(userName());
hashCode = 31 * hashCode + Objects.hashCode(userId());
hashCode = 31 * hashCode + Objects.hashCode(arn());
hashCode = 31 * hashCode + Objects.hashCode(createDate());
hashCode = 31 * hashCode + Objects.hashCode(userPolicyList());
hashCode = 31 * hashCode + Objects.hashCode(groupList());
hashCode = 31 * hashCode + Objects.hashCode(attachedManagedPolicies());
hashCode = 31 * hashCode + Objects.hashCode(permissionsBoundary());
hashCode = 31 * hashCode + Objects.hashCode(tags());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof UserDetail)) {
return false;
}
UserDetail other = (UserDetail) obj;
return Objects.equals(path(), other.path()) && Objects.equals(userName(), other.userName())
&& Objects.equals(userId(), other.userId()) && Objects.equals(arn(), other.arn())
&& Objects.equals(createDate(), other.createDate()) && Objects.equals(userPolicyList(), other.userPolicyList())
&& Objects.equals(groupList(), other.groupList())
&& Objects.equals(attachedManagedPolicies(), other.attachedManagedPolicies())
&& Objects.equals(permissionsBoundary(), other.permissionsBoundary()) && Objects.equals(tags(), other.tags());
}
/**
* 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 String toString() {
return ToString.builder("UserDetail").add("Path", path()).add("UserName", userName()).add("UserId", userId())
.add("Arn", arn()).add("CreateDate", createDate()).add("UserPolicyList", userPolicyList())
.add("GroupList", groupList()).add("AttachedManagedPolicies", attachedManagedPolicies())
.add("PermissionsBoundary", permissionsBoundary()).add("Tags", tags()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Path":
return Optional.ofNullable(clazz.cast(path()));
case "UserName":
return Optional.ofNullable(clazz.cast(userName()));
case "UserId":
return Optional.ofNullable(clazz.cast(userId()));
case "Arn":
return Optional.ofNullable(clazz.cast(arn()));
case "CreateDate":
return Optional.ofNullable(clazz.cast(createDate()));
case "UserPolicyList":
return Optional.ofNullable(clazz.cast(userPolicyList()));
case "GroupList":
return Optional.ofNullable(clazz.cast(groupList()));
case "AttachedManagedPolicies":
return Optional.ofNullable(clazz.cast(attachedManagedPolicies()));
case "PermissionsBoundary":
return Optional.ofNullable(clazz.cast(permissionsBoundary()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function