public class ListGroupsRequest extends AmazonWebServiceRequest implements java.io.Serializable
ListGroups operation.
Lists the groups that have the specified path prefix.
You can paginate the results using the MaxItems and Marker parameters.
| コンストラクタと説明 |
|---|
ListGroupsRequest()
Default constructor for a new ListGroupsRequest object.
|
| 修飾子とタイプ | メソッドと説明 |
|---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getMarker()
Use this only when paginating results, and only in a subsequent
request after you've received a response where the results are
truncated.
|
java.lang.Integer |
getMaxItems()
Use this only when paginating results to indicate the maximum number
of groups you want in the response.
|
java.lang.String |
getPathPrefix()
The path prefix for filtering the results.
|
int |
hashCode() |
void |
setMarker(java.lang.String marker)
Use this only when paginating results, and only in a subsequent
request after you've received a response where the results are
truncated.
|
void |
setMaxItems(java.lang.Integer maxItems)
Use this only when paginating results to indicate the maximum number
of groups you want in the response.
|
void |
setPathPrefix(java.lang.String pathPrefix)
The path prefix for filtering the results.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
ListGroupsRequest |
withMarker(java.lang.String marker)
Use this only when paginating results, and only in a subsequent
request after you've received a response where the results are
truncated.
|
ListGroupsRequest |
withMaxItems(java.lang.Integer maxItems)
Use this only when paginating results to indicate the maximum number
of groups you want in the response.
|
ListGroupsRequest |
withPathPrefix(java.lang.String pathPrefix)
The path prefix for filtering the results.
|
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentialspublic ListGroupsRequest()
public java.lang.String getPathPrefix()
/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: /[!-]*
/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(java.lang.String pathPrefix)
/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: /[!-]*
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 ListGroupsRequest withPathPrefix(java.lang.String pathPrefix)
/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: /[!-]*
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 java.lang.String getMarker()
Marker element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
Marker element in
the response you just received.public void setMarker(java.lang.String marker)
Marker element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
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 ListGroupsRequest withMarker(java.lang.String marker)
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: [ -ÿ]*
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 java.lang.Integer getMaxItems()
IsTruncated response
element is true.
Constraints:
Range: 1 - 1000
IsTruncated response
element is true.public void setMaxItems(java.lang.Integer maxItems)
IsTruncated response
element is true.
Constraints:
Range: 1 - 1000
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 ListGroupsRequest withMaxItems(java.lang.Integer maxItems)
IsTruncated response
element is true.
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 groups you want in the response. If there are additional groups
beyond the maximum you specify, the IsTruncated response
element is true.public java.lang.String toString()
toString クラス内 java.lang.ObjectObject.toString()public int hashCode()
hashCode クラス内 java.lang.Objectpublic boolean equals(java.lang.Object obj)
equals クラス内 java.lang.Object