com.amazonaws.services.identitymanagement.model.ListGroupsRequest Maven / Gradle / Ivy
/*
* Copyright 2010-2011 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 com.amazonaws.services.identitymanagement.model;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.identitymanagement.AmazonIdentityManagement#listGroups(ListGroupsRequest) ListGroups operation}.
*
* Lists the groups that have the specified path prefix.
*
*
* You can paginate the results using the MaxItems and
* Marker parameters.
*
*
* @see com.amazonaws.services.identitymanagement.AmazonIdentityManagement#listGroups(ListGroupsRequest)
*/
public class ListGroupsRequest extends AmazonWebServiceRequest {
/**
* The path prefix for filtering the results. For example:
* /division_abc/subdivision_xyz/, which would get all
* groups whose path starts with
* /division_abc/subdivision_xyz/. This parameter is
* optional. If it is not included, it defaults to a slash (/), listing
* all groups.
*
* Constraints:
* Length: 1 - 512
* Pattern: \u002F[\u0021-\u007F]*
*/
private String pathPrefix;
/**
* Use this only when paginating results, and only in a subsequent
* request after you've received a response where the results are
* truncated. Set it to the value of the Marker element in
* the response you just received.
*
* Constraints:
* Length: 1 - 320
* Pattern: [\u0020-\u00FF]*
*/
private String marker;
/**
* Use this only when paginating results to indicate the maximum number
* of groups you want in the response. If there are additional groups
* beyond the maximum you specify, the IsTruncated response
* element is true.
*
* Constraints:
* Range: 1 - 1000
*/
private Integer maxItems;
/**
* The path prefix for filtering the results. For example:
* /division_abc/subdivision_xyz/, which would get all
* groups whose path starts with
* /division_abc/subdivision_xyz/.
This parameter is
* optional. If it is not included, it defaults to a slash (/), listing
* all groups.
*
* Constraints:
* Length: 1 - 512
* Pattern: \u002F[\u0021-\u007F]*
*
* @return The path prefix for filtering the results. For example:
* /division_abc/subdivision_xyz/, which would get all
* groups whose path starts with
* /division_abc/subdivision_xyz/.
This parameter is
* optional. If it is not included, it defaults to a slash (/), listing
* all groups.
*/
public String getPathPrefix() {
return pathPrefix;
}
/**
* The path prefix for filtering the results. For example:
* /division_abc/subdivision_xyz/, which would get all
* groups whose path starts with
* /division_abc/subdivision_xyz/.
This parameter is
* optional. If it is not included, it defaults to a slash (/), listing
* all groups.
*
* Constraints:
* Length: 1 - 512
* Pattern: \u002F[\u0021-\u007F]*
*
* @param pathPrefix The path prefix for filtering the results. For example:
* /division_abc/subdivision_xyz/, which would get all
* groups whose path starts with
* /division_abc/subdivision_xyz/.
This parameter is
* optional. If it is not included, it defaults to a slash (/), listing
* all groups.
*/
public void setPathPrefix(String pathPrefix) {
this.pathPrefix = pathPrefix;
}
/**
* The path prefix for filtering the results. For example:
* /division_abc/subdivision_xyz/, which would get all
* groups whose path starts with
* /division_abc/subdivision_xyz/.
This parameter is
* optional. If it is not included, it defaults to a slash (/), listing
* all groups.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 512
* Pattern: \u002F[\u0021-\u007F]*
*
* @param pathPrefix The path prefix for filtering the results. For example:
* /division_abc/subdivision_xyz/, which would get all
* groups whose path starts with
* /division_abc/subdivision_xyz/.
This parameter is
* optional. If it is not included, it defaults to a slash (/), listing
* all groups.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ListGroupsRequest withPathPrefix(String pathPrefix) {
this.pathPrefix = pathPrefix;
return this;
}
/**
* Use this only when paginating results, and only in a subsequent
* request after you've received a response where the results are
* truncated. Set it to the value of the Marker element in
* the response you just received.
*
* Constraints:
* Length: 1 - 320
* Pattern: [\u0020-\u00FF]*
*
* @return Use this only when paginating results, and only in a subsequent
* request after you've received a response where the results are
* truncated. Set it to the value of the Marker element in
* the response you just received.
*/
public String getMarker() {
return marker;
}
/**
* Use this only when paginating results, and only in a subsequent
* request after you've received a response where the results are
* truncated. Set it to the value of the Marker element in
* the response you just received.
*
* Constraints:
* Length: 1 - 320
* Pattern: [\u0020-\u00FF]*
*
* @param marker Use this only when paginating results, and only in a subsequent
* request after you've received a response where the results are
* truncated. Set it to the value of the Marker element in
* the response you just received.
*/
public void setMarker(String marker) {
this.marker = marker;
}
/**
* Use this only when paginating results, and only in a subsequent
* request after you've received a response where the results are
* truncated. Set it to the value of the Marker element in
* the response you just received.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 320
* Pattern: [\u0020-\u00FF]*
*
* @param marker Use this only when paginating results, and only in a subsequent
* request after you've received a response where the results are
* truncated. Set it to the value of the Marker element in
* the response you just received.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ListGroupsRequest withMarker(String marker) {
this.marker = marker;
return this;
}
/**
* Use this only when paginating results to indicate the maximum number
* of groups you want in the response. If there are additional groups
* beyond the maximum you specify, the IsTruncated response
* element is true.
*
* Constraints:
* Range: 1 - 1000
*
* @return Use this only when paginating results to indicate the maximum number
* of groups you want in the response. If there are additional groups
* beyond the maximum you specify, the IsTruncated response
* element is true.
*/
public Integer getMaxItems() {
return maxItems;
}
/**
* Use this only when paginating results to indicate the maximum number
* of groups you want in the response. If there are additional groups
* beyond the maximum you specify, the IsTruncated response
* element is true.
*
* Constraints:
* Range: 1 - 1000
*
* @param maxItems Use this only when paginating results to indicate the maximum number
* of groups you want in the response. If there are additional groups
* beyond the maximum you specify, the IsTruncated response
* element is true.
*/
public void setMaxItems(Integer maxItems) {
this.maxItems = maxItems;
}
/**
* Use this only when paginating results to indicate the maximum number
* of groups you want in the response. If there are additional groups
* beyond the maximum you specify, the IsTruncated response
* element is true.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Range: 1 - 1000
*
* @param maxItems Use this only when paginating results to indicate the maximum number
* of groups you want in the response. If there are additional groups
* beyond the maximum you specify, the IsTruncated response
* element is true.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ListGroupsRequest withMaxItems(Integer maxItems) {
this.maxItems = maxItems;
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
sb.append("PathPrefix: " + pathPrefix + ", ");
sb.append("Marker: " + marker + ", ");
sb.append("MaxItems: " + maxItems + ", ");
sb.append("}");
return sb.toString();
}
}