software.amazon.awssdk.services.iam.model.ListGroupsResponse 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.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
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 ListGroups request.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ListGroupsResponse extends IamResponse implements
ToCopyableBuilder {
private static final SdkField> GROUPS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Groups")
.getter(getter(ListGroupsResponse::groups))
.setter(setter(Builder::groups))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Groups").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Group::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField IS_TRUNCATED_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("IsTruncated").getter(getter(ListGroupsResponse::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).memberName("Marker")
.getter(getter(ListGroupsResponse::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(GROUPS_FIELD,
IS_TRUNCATED_FIELD, MARKER_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private final List groups;
private final Boolean isTruncated;
private final String marker;
private ListGroupsResponse(BuilderImpl builder) {
super(builder);
this.groups = builder.groups;
this.isTruncated = builder.isTruncated;
this.marker = builder.marker;
}
/**
* For responses, this returns true if the service returned a value for the Groups property. This DOES NOT check
* that the value is non-empty (for which, you should check the {@code 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.
*/
public final boolean hasGroups() {
return groups != null && !(groups instanceof SdkAutoConstructList);
}
/**
*
* A list of groups.
*
*
* 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 {@link #hasGroups} method.
*
*
* @return A list of groups.
*/
public final List groups() {
return groups;
}
/**
*
* 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 final 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 final 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 final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(hasGroups() ? groups() : null);
hashCode = 31 * hashCode + Objects.hashCode(isTruncated());
hashCode = 31 * hashCode + Objects.hashCode(marker());
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 ListGroupsResponse)) {
return false;
}
ListGroupsResponse other = (ListGroupsResponse) obj;
return hasGroups() == other.hasGroups() && Objects.equals(groups(), other.groups())
&& 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 final String toString() {
return ToString.builder("ListGroupsResponse").add("Groups", hasGroups() ? groups() : null)
.add("IsTruncated", isTruncated()).add("Marker", marker()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Groups":
return Optional.ofNullable(clazz.cast(groups()));
case "IsTruncated":
return Optional.ofNullable(clazz.cast(isTruncated()));
case "Marker":
return Optional.ofNullable(clazz.cast(marker()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("Groups", GROUPS_FIELD);
map.put("IsTruncated", IS_TRUNCATED_FIELD);
map.put("Marker", MARKER_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((ListGroupsResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends IamResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* A list of groups.
*
*
* @param groups
* A list of groups.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder groups(Collection groups);
/**
*
* A list of groups.
*
*
* @param groups
* A list of groups.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder groups(Group... groups);
/**
*
* A list of groups.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.iam.model.Group.Builder} avoiding the need to create one manually via
* {@link software.amazon.awssdk.services.iam.model.Group#builder()}.
*
*
* When the {@link Consumer} completes, {@link software.amazon.awssdk.services.iam.model.Group.Builder#build()}
* is called immediately and its result is passed to {@link #groups(List)}.
*
* @param groups
* a consumer that will call methods on {@link software.amazon.awssdk.services.iam.model.Group.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #groups(java.util.Collection)
*/
Builder groups(Consumer... groups);
/**
*
* 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 List groups = DefaultSdkAutoConstructList.getInstance();
private Boolean isTruncated;
private String marker;
private BuilderImpl() {
}
private BuilderImpl(ListGroupsResponse model) {
super(model);
groups(model.groups);
isTruncated(model.isTruncated);
marker(model.marker);
}
public final List getGroups() {
List result = _groupListTypeCopier.copyToBuilder(this.groups);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setGroups(Collection groups) {
this.groups = _groupListTypeCopier.copyFromBuilder(groups);
}
@Override
public final Builder groups(Collection groups) {
this.groups = _groupListTypeCopier.copy(groups);
return this;
}
@Override
@SafeVarargs
public final Builder groups(Group... groups) {
groups(Arrays.asList(groups));
return this;
}
@Override
@SafeVarargs
public final Builder groups(Consumer... groups) {
groups(Stream.of(groups).map(c -> Group.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final Boolean getIsTruncated() {
return isTruncated;
}
public final void setIsTruncated(Boolean isTruncated) {
this.isTruncated = isTruncated;
}
@Override
public final Builder isTruncated(Boolean isTruncated) {
this.isTruncated = isTruncated;
return this;
}
public final String getMarker() {
return marker;
}
public final void setMarker(String marker) {
this.marker = marker;
}
@Override
public final Builder marker(String marker) {
this.marker = marker;
return this;
}
@Override
public ListGroupsResponse build() {
return new ListGroupsResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}