public class ListGroupsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
ListGroups operation.
Lists the groups that have the specified path prefix.
You can paginate the results using the MaxItems and
Marker parameters.
NOOP| Constructor and Description |
|---|
ListGroupsRequest()
Default constructor for a new ListGroupsRequest object.
|
| Modifier and Type | Method and Description |
|---|---|
ListGroupsRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(Object obj) |
String |
getMarker()
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated.
|
Integer |
getMaxItems()
Use this only when paginating results to indicate the maximum number
of items you want in the response.
|
String |
getPathPrefix()
The path prefix for filtering the results.
|
int |
hashCode() |
void |
setMarker(String marker)
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated.
|
void |
setMaxItems(Integer maxItems)
Use this only when paginating results to indicate the maximum number
of items you want in the response.
|
void |
setPathPrefix(String pathPrefix)
The path prefix for filtering the results.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
ListGroupsRequest |
withMarker(String marker)
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated.
|
ListGroupsRequest |
withMaxItems(Integer maxItems)
Use this only when paginating results to indicate the maximum number
of items you want in the response.
|
ListGroupsRequest |
withPathPrefix(String pathPrefix)
The path prefix for filtering the results.
|
copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollectorpublic ListGroupsRequest()
public String getPathPrefix()
/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]*
/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)
/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]*
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 ListGroupsRequest withPathPrefix(String pathPrefix)
/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]*
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 String getMarker()
Marker element in the response you
received to inform the next call about where to start.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]+
Marker element in the response you
received to inform the next call about where to start.public void setMarker(String marker)
Marker element in the response you
received to inform the next call about where to start.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]+
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 you
received to inform the next call about where to start.public ListGroupsRequest withMarker(String marker)
Marker element in the response you
received to inform the next call about where to start.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]+
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 you
received to inform the next call about where to start.public Integer getMaxItems()
IsTruncated response
element is true. This parameter is optional. If you do
not include it, it defaults to 100. Note that IAM might return fewer
results, even when there are more results available. If this is the
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.
Constraints:
Range: 1 - 1000
IsTruncated response
element is true. This parameter is optional. If you do
not include it, it defaults to 100. Note that IAM might return fewer
results, even when there are more results available. If this is the
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 void setMaxItems(Integer maxItems)
IsTruncated response
element is true. This parameter is optional. If you do
not include it, it defaults to 100. Note that IAM might return fewer
results, even when there are more results available. If this is the
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.
Constraints:
Range: 1 - 1000
maxItems - Use this only when paginating results to indicate the maximum number
of items you want in the response. If there are additional items
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. Note that IAM might return fewer
results, even when there are more results available. If this is the
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 ListGroupsRequest withMaxItems(Integer maxItems)
IsTruncated response
element is true. This parameter is optional. If you do
not include it, it defaults to 100. Note that IAM might return fewer
results, even when there are more results available. If this is the
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 1 - 1000
maxItems - Use this only when paginating results to indicate the maximum number
of items you want in the response. If there are additional items
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. Note that IAM might return fewer
results, even when there are more results available. If this is the
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 String toString()
toString in class ObjectObject.toString()public ListGroupsRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()Copyright © 2015. All rights reserved.