software.amazon.awssdk.services.iam.model.GetGroupResponse Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of iam Show documentation
Show all versions of iam Show documentation
The AWS Java SDK for AWS IAM module holds the client classes that are used for communicating with AWS
Identity and Access Management 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.iam.model;
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 the response to a successful GetGroup request.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class GetGroupResponse extends IamResponse implements ToCopyableBuilder {
private static final SdkField GROUP_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.getter(getter(GetGroupResponse::group)).setter(setter(Builder::group)).constructor(Group::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Group").build()).build();
private static final SdkField> USERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.getter(getter(GetGroupResponse::users))
.setter(setter(Builder::users))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Users").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(User::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField IS_TRUNCATED_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.getter(getter(GetGroupResponse::isTruncated)).setter(setter(Builder::isTruncated))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("IsTruncated").build()).build();
private static final SdkField MARKER_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(GetGroupResponse::marker)).setter(setter(Builder::marker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Marker").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(GROUP_FIELD, USERS_FIELD,
IS_TRUNCATED_FIELD, MARKER_FIELD));
private final Group group;
private final List users;
private final Boolean isTruncated;
private final String marker;
private GetGroupResponse(BuilderImpl builder) {
super(builder);
this.group = builder.group;
this.users = builder.users;
this.isTruncated = builder.isTruncated;
this.marker = builder.marker;
}
/**
*
* A structure that contains details about the group.
*
*
* @return A structure that contains details about the group.
*/
public Group group() {
return group;
}
/**
* Returns true if the Users 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 hasUsers() {
return users != null && !(users instanceof SdkAutoConstructList);
}
/**
*
* A list of users in the group.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasUsers()} to see if a value was sent in this field.
*
*
* @return A list of users in the group.
*/
public List users() {
return users;
}
/**
*
* A flag that indicates whether there are more items to return. If your results were truncated, you can make a
* subsequent pagination request using the Marker request parameter to retrieve more items. Note that
* IAM might return fewer than the MaxItems number of results even when there are more results
* available. We recommend that you check IsTruncated after every call to ensure that you receive all
* your results.
*
*
* @return A flag that indicates whether there are more items to return. If your results were truncated, you can
* make a subsequent pagination request using the Marker request parameter to retrieve more
* items. Note that IAM might return fewer than the MaxItems number of results even when there
* are more results available. We recommend that you check IsTruncated after every call to
* ensure that you receive all your results.
*/
public Boolean isTruncated() {
return isTruncated;
}
/**
*
* When IsTruncated is true, this element is present and contains the value to use for the
* Marker parameter in a subsequent pagination request.
*
*
* @return When IsTruncated is true, this element is present and contains the value to use
* for the Marker parameter in a subsequent pagination request.
*/
public String marker() {
return marker;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(group());
hashCode = 31 * hashCode + Objects.hashCode(users());
hashCode = 31 * hashCode + Objects.hashCode(isTruncated());
hashCode = 31 * hashCode + Objects.hashCode(marker());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof GetGroupResponse)) {
return false;
}
GetGroupResponse other = (GetGroupResponse) obj;
return Objects.equals(group(), other.group()) && Objects.equals(users(), other.users())
&& Objects.equals(isTruncated(), other.isTruncated()) && Objects.equals(marker(), other.marker());
}
/**
* 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("GetGroupResponse").add("Group", group()).add("Users", users()).add("IsTruncated", isTruncated())
.add("Marker", marker()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Group":
return Optional.ofNullable(clazz.cast(group()));
case "Users":
return Optional.ofNullable(clazz.cast(users()));
case "IsTruncated":
return Optional.ofNullable(clazz.cast(isTruncated()));
case "Marker":
return Optional.ofNullable(clazz.cast(marker()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetGroupResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends IamResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* A structure that contains details about the group.
*
*
* @param group
* A structure that contains details about the group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder group(Group group);
/**
*
* A structure that contains details about the group.
*
* This is a convenience that creates an instance of the {@link Group.Builder} avoiding the need to create one
* manually via {@link Group#builder()}.
*
* When the {@link Consumer} completes, {@link Group.Builder#build()} is called immediately and its result is
* passed to {@link #group(Group)}.
*
* @param group
* a consumer that will call methods on {@link Group.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #group(Group)
*/
default Builder group(Consumer group) {
return group(Group.builder().applyMutation(group).build());
}
/**
*
* A list of users in the group.
*
*
* @param users
* A list of users in the group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder users(Collection users);
/**
*
* A list of users in the group.
*
*
* @param users
* A list of users in the group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder users(User... users);
/**
*
* A list of users in the group.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create
* one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result
* is passed to {@link #users(List)}.
*
* @param users
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #users(List)
*/
Builder users(Consumer... users);
/**
*
* A flag that indicates whether there are more items to return. If your results were truncated, you can make a
* subsequent pagination request using the Marker request parameter to retrieve more items. Note
* that IAM might return fewer than the MaxItems number of results even when there are more results
* available. We recommend that you check IsTruncated after every call to ensure that you receive
* all your results.
*
*
* @param isTruncated
* A flag that indicates whether there are more items to return. If your results were truncated, you can
* make a subsequent pagination request using the Marker request parameter to retrieve more
* items. Note that IAM might return fewer than the MaxItems number of results even when
* there are more results available. We recommend that you check IsTruncated after every
* call to ensure that you receive all your results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder isTruncated(Boolean isTruncated);
/**
*
* When IsTruncated is true, this element is present and contains the value to use for
* the Marker parameter in a subsequent pagination request.
*
*
* @param marker
* When IsTruncated is true, this element is present and contains the value to
* use for the Marker parameter in a subsequent pagination request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder marker(String marker);
}
static final class BuilderImpl extends IamResponse.BuilderImpl implements Builder {
private Group group;
private List users = DefaultSdkAutoConstructList.getInstance();
private Boolean isTruncated;
private String marker;
private BuilderImpl() {
}
private BuilderImpl(GetGroupResponse model) {
super(model);
group(model.group);
users(model.users);
isTruncated(model.isTruncated);
marker(model.marker);
}
public final Group.Builder getGroup() {
return group != null ? group.toBuilder() : null;
}
@Override
public final Builder group(Group group) {
this.group = group;
return this;
}
public final void setGroup(Group.BuilderImpl group) {
this.group = group != null ? group.build() : null;
}
public final Collection getUsers() {
return users != null ? users.stream().map(User::toBuilder).collect(Collectors.toList()) : null;
}
@Override
public final Builder users(Collection users) {
this.users = _userListTypeCopier.copy(users);
return this;
}
@Override
@SafeVarargs
public final Builder users(User... users) {
users(Arrays.asList(users));
return this;
}
@Override
@SafeVarargs
public final Builder users(Consumer... users) {
users(Stream.of(users).map(c -> User.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final void setUsers(Collection users) {
this.users = _userListTypeCopier.copyFromBuilder(users);
}
public final Boolean getIsTruncated() {
return isTruncated;
}
@Override
public final Builder isTruncated(Boolean isTruncated) {
this.isTruncated = isTruncated;
return this;
}
public final void setIsTruncated(Boolean isTruncated) {
this.isTruncated = isTruncated;
}
public final String getMarker() {
return marker;
}
@Override
public final Builder marker(String marker) {
this.marker = marker;
return this;
}
public final void setMarker(String marker) {
this.marker = marker;
}
@Override
public GetGroupResponse build() {
return new GetGroupResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy