software.amazon.awssdk.services.iam.model.ListRolesRequest 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.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 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 ListRolesRequest extends IamRequest implements ToCopyableBuilder {
private static final SdkField PATH_PREFIX_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PathPrefix").getter(getter(ListRolesRequest::pathPrefix)).setter(setter(Builder::pathPrefix))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PathPrefix").build()).build();
private static final SdkField MARKER_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Marker")
.getter(getter(ListRolesRequest::marker)).setter(setter(Builder::marker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Marker").build()).build();
private static final SdkField MAX_ITEMS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxItems").getter(getter(ListRolesRequest::maxItems)).setter(setter(Builder::maxItems))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxItems").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(PATH_PREFIX_FIELD,
MARKER_FIELD, MAX_ITEMS_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private final String pathPrefix;
private final String marker;
private final Integer maxItems;
private ListRolesRequest(BuilderImpl builder) {
super(builder);
this.pathPrefix = builder.pathPrefix;
this.marker = builder.marker;
this.maxItems = builder.maxItems;
}
/**
*
* The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/
* gets all roles whose path starts with /application_abc/component_xyz/.
*
*
* This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles. This parameter
* allows (through its regex pattern) a string of characters
* consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In
* addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (
* \u007F), including most punctuation characters, digits, and upper and lowercased letters.
*
*
* @return The path prefix for filtering the results. For example, the prefix
* /application_abc/component_xyz/ gets all roles whose path starts with
* /application_abc/component_xyz/.
*
* This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles. This
* parameter allows (through its regex pattern) a string of
* characters consisting of either a forward slash (/) by itself or a string that must begin and end with
* forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through
* the DEL character (\u007F), including most punctuation characters, digits, and upper and
* lowercased letters.
*/
public final String pathPrefix() {
return pathPrefix;
}
/**
*
* Use this parameter only when paginating results and only after you receive a response indicating that the results
* are truncated. Set it to the value of the Marker element in the response that you received to
* indicate where the next call should start.
*
*
* @return Use this parameter only when paginating results and only after you receive a response indicating that the
* results are truncated. Set it to the value of the Marker element in the response that you
* received to indicate where the next call should start.
*/
public final String marker() {
return marker;
}
/**
*
* Use this only when paginating results to indicate the maximum number of items you want in the response. If
* additional items exist beyond the maximum you specify, the IsTruncated response element is
* true.
*
*
* If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
* results, even when there are more results available. In that case, the IsTruncated response element
* returns true, and Marker contains a value to include in the subsequent call that tells
* the service where to continue from.
*
*
* @return Use this only when paginating results to indicate the maximum number of items you want in the response.
* If additional items exist beyond the maximum you specify, the IsTruncated response element
* is true.
*
* If you do not include this parameter, the number of items defaults to 100. Note that IAM might return
* fewer results, even when there are more results available. In that case, the IsTruncated
* response element returns true, and Marker contains a value to include in the
* subsequent call that tells the service where to continue from.
*/
public final Integer maxItems() {
return maxItems;
}
@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(pathPrefix());
hashCode = 31 * hashCode + Objects.hashCode(marker());
hashCode = 31 * hashCode + Objects.hashCode(maxItems());
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 ListRolesRequest)) {
return false;
}
ListRolesRequest other = (ListRolesRequest) obj;
return Objects.equals(pathPrefix(), other.pathPrefix()) && Objects.equals(marker(), other.marker())
&& Objects.equals(maxItems(), other.maxItems());
}
/**
* 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("ListRolesRequest").add("PathPrefix", pathPrefix()).add("Marker", marker())
.add("MaxItems", maxItems()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "PathPrefix":
return Optional.ofNullable(clazz.cast(pathPrefix()));
case "Marker":
return Optional.ofNullable(clazz.cast(marker()));
case "MaxItems":
return Optional.ofNullable(clazz.cast(maxItems()));
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("PathPrefix", PATH_PREFIX_FIELD);
map.put("Marker", MARKER_FIELD);
map.put("MaxItems", MAX_ITEMS_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((ListRolesRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends IamRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The path prefix for filtering the results. For example, the prefix
* /application_abc/component_xyz/ gets all roles whose path starts with
* /application_abc/component_xyz/.
*
*
* This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles. This
* parameter allows (through its regex pattern) a string of
* characters consisting of either a forward slash (/) by itself or a string that must begin and end with
* forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the
* DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased
* letters.
*
*
* @param pathPrefix
* The path prefix for filtering the results. For example, the prefix
* /application_abc/component_xyz/ gets all roles whose path starts with
* /application_abc/component_xyz/.
*
* This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles. This
* parameter allows (through its regex pattern) a string of
* characters consisting of either a forward slash (/) by itself or a string that must begin and end with
* forward slashes. In addition, it can contain any ASCII character from the ! (\u0021)
* through the DEL character (\u007F), including most punctuation characters, digits, and
* upper and lowercased letters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder pathPrefix(String pathPrefix);
/**
*
* Use this parameter only when paginating results and only after you receive a response indicating that the
* results are truncated. Set it to the value of the Marker element in the response that you
* received to indicate where the next call should start.
*
*
* @param marker
* Use this parameter only when paginating results and only after you receive a response indicating that
* the results are truncated. Set it to the value of the Marker element in the response that
* you received to indicate where the next call should start.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder marker(String marker);
/**
*
* Use this only when paginating results to indicate the maximum number of items you want in the response. If
* additional items exist beyond the maximum you specify, the IsTruncated response element is
* true.
*
*
* If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
* results, even when there are more results available. In that case, the IsTruncated response
* element returns true, and Marker contains a value to include in the subsequent call
* that tells the service where to continue from.
*
*
* @param maxItems
* Use this only when paginating results to indicate the maximum number of items you want in the
* response. If additional items exist beyond the maximum you specify, the IsTruncated
* response element is true.
*
* If you do not include this parameter, the number of items defaults to 100. Note that IAM might return
* fewer results, even when there are more results available. In that case, the IsTruncated
* response element returns true, and Marker contains a value to include in the
* subsequent call that tells the service where to continue from.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxItems(Integer maxItems);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends IamRequest.BuilderImpl implements Builder {
private String pathPrefix;
private String marker;
private Integer maxItems;
private BuilderImpl() {
}
private BuilderImpl(ListRolesRequest model) {
super(model);
pathPrefix(model.pathPrefix);
marker(model.marker);
maxItems(model.maxItems);
}
public final String getPathPrefix() {
return pathPrefix;
}
public final void setPathPrefix(String pathPrefix) {
this.pathPrefix = pathPrefix;
}
@Override
public final Builder pathPrefix(String pathPrefix) {
this.pathPrefix = pathPrefix;
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;
}
public final Integer getMaxItems() {
return maxItems;
}
public final void setMaxItems(Integer maxItems) {
this.maxItems = maxItems;
}
@Override
public final Builder maxItems(Integer maxItems) {
this.maxItems = maxItems;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public ListRolesRequest build() {
return new ListRolesRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}