Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010-2015 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;
 
 
Container for the parameters to the ListGroups operation.

Lists the groups that have the specified path prefix.

You can paginate the results using the MaxItems and Marker parameters.

 
 public class ListGroupsRequest extends AmazonWebServiceRequest implements SerializableCloneable {

    
The path prefix for filtering the results. For example, the prefix /division_abc/subdivision_xyz/ gets 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. This parameter is optional. If you do not include it, it defaults to 100.

Constraints:
Range: 1 - 1000

 
     private Integer maxItems;

    
Default constructor for a new ListGroupsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.
 
     public ListGroupsRequest() {}
    
    
The path prefix for filtering the results. For example, the prefix /division_abc/subdivision_xyz/ gets 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]*

Returns:
The path prefix for filtering the results. For example, the prefix /division_abc/subdivision_xyz/ gets 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 ;
     }
    
    
The path prefix for filtering the results. For example, the prefix /division_abc/subdivision_xyz/ gets 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]*

Parameters:
pathPrefix The path prefix for filtering the results. For example, the prefix /division_abc/subdivision_xyz/ gets 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;
    }
    
    
The path prefix for filtering the results. For example, the prefix /division_abc/subdivision_xyz/ gets 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]*

Parameters:
pathPrefix The path prefix for filtering the results. For example, the prefix /division_abc/subdivision_xyz/ gets 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 updated object so that method calls can be chained together.
    public ListGroupsRequest withPathPrefix(String pathPrefix) {
        this. = 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]*

Returns:
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 ;
    }
    
    
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]*

Parameters:
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;
    }
    
    
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]*

Parameters:
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 updated object so that method calls can be chained together.
    public ListGroupsRequest withMarker(String marker) {
        this. = 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. This parameter is optional. If you do not include it, it defaults to 100.

Constraints:
Range: 1 - 1000

Returns:
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. This parameter is optional. If you do not include it, it defaults to 100.
    public Integer getMaxItems() {
        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. This parameter is optional. If you do not include it, it defaults to 100.

Constraints:
Range: 1 - 1000

Parameters:
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. This parameter is optional. If you do not include it, it defaults to 100.
    public void setMaxItems(Integer maxItems) {
        this. = 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. This parameter is optional. If you do not include it, it defaults to 100.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 1 - 1000

Parameters:
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. This parameter is optional. If you do not include it, it defaults to 100.
Returns:
A reference to this updated object so that method calls can be chained together.
    public ListGroupsRequest withMaxItems(Integer maxItems) {
        this. = maxItems;
        return this;
    }

    
Returns a string representation of this object; useful for testing and debugging.

Returns:
A string representation of this object.
See also:
java.lang.Object.toString()
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getPathPrefix() != nullsb.append("PathPrefix: " + getPathPrefix() + ",");
        if (getMarker() != nullsb.append("Marker: " + getMarker() + ",");
        if (getMaxItems() != nullsb.append("MaxItems: " + getMaxItems() );
        sb.append("}");
        return sb.toString();
    }
    
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        
        hashCode = prime * hashCode + ((getPathPrefix() == null) ? 0 : getPathPrefix().hashCode()); 
        hashCode = prime * hashCode + ((getMarker() == null) ? 0 : getMarker().hashCode()); 
        hashCode = prime * hashCode + ((getMaxItems() == null) ? 0 : getMaxItems().hashCode()); 
        return hashCode;
    }
    
    @Override
    public boolean equals(Object obj) {
        if (this == objreturn true;
        if (obj == nullreturn false;
        if (obj instanceof ListGroupsRequest == falsereturn false;
        ListGroupsRequest other = (ListGroupsRequest)obj;
        
        if (other.getPathPrefix() == null ^ this.getPathPrefix() == nullreturn false;
        if (other.getPathPrefix() != null && other.getPathPrefix().equals(this.getPathPrefix()) == falsereturn false
        if (other.getMarker() == null ^ this.getMarker() == nullreturn false;
        if (other.getMarker() != null && other.getMarker().equals(this.getMarker()) == falsereturn false
        if (other.getMaxItems() == null ^ this.getMaxItems() == nullreturn false;
        if (other.getMaxItems() != null && other.getMaxItems().equals(this.getMaxItems()) == falsereturn false
        return true;
    }
    
    @Override
    public ListGroupsRequest clone() {
        
            return (ListGroupsRequestsuper.clone();
    }
}
    
New to GrepCode? Check out our FAQ X