com.amazonaws.services.identitymanagement.model
Class GetGroupRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.identitymanagement.model.GetGroupRequest

All Implemented Interfaces:

Serializable

public class GetGroupRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the GetGroup operation.

Returns a list of users that are in the specified group. You can paginate the results using the MaxItems and Marker parameters.

See Also:

AmazonIdentityManagement.getGroup(GetGroupRequest), Serialized Form

Constructor Summary

GetGroupRequest()
Default constructor for a new GetGroupRequest object.

GetGroupRequest(String groupName)
Constructs a new GetGroupRequest object.

Method Summary

boolean	equals(Object obj)
String	getGroupName() Name of the group.
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.
Integer	getMaxItems() Use this only when paginating results to indicate the maximum number of user names you want in the response.
int	hashCode()
void	setGroupName(String groupName) Name of the group.
void	setMarker(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(Integer maxItems) Use this only when paginating results to indicate the maximum number of user names you want in the response.
String	toString() Returns a string representation of this object; useful for testing and debugging.
GetGroupRequest	withGroupName(String groupName) Name of the group.
GetGroupRequest	withMarker(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.
GetGroupRequest	withMaxItems(Integer maxItems) Use this only when paginating results to indicate the maximum number of user names you want in the response.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetGroupRequest

public GetGroupRequest()

Default constructor for a new GetGroupRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

GetGroupRequest

public GetGroupRequest(String groupName)

Constructs a new GetGroupRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

groupName - Name of the group.

Method Detail

getGroupName

public String getGroupName()

Name of the group.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Returns:

Name of the group.

setGroupName

public void setGroupName(String groupName)

Name of the group.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Parameters:

groupName - Name of the group.

withGroupName

public GetGroupRequest withGroupName(String groupName)

Name of the group.

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

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Parameters:

groupName - Name of the group.

Returns:

A reference to this updated object so that method calls can be chained together.

getMarker

public 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. Set it to the value of the Marker element in the response you just received.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

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.

setMarker

public void setMarker(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. Set it to the value of the Marker element in the response you just received.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

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.

withMarker

public GetGroupRequest withMarker(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. 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: [ -?]*

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.

getMaxItems

public Integer getMaxItems()

Use this only when paginating results to indicate the maximum number of user names you want in the response. If there are additional user names beyond the maximum you specify, the IsTruncated response element is true.

Constraints:
Range: 1 - 1000

Returns:

Use this only when paginating results to indicate the maximum number of user names you want in the response. If there are additional user names beyond the maximum you specify, the IsTruncated response element is true.

setMaxItems

public void setMaxItems(Integer maxItems)

Use this only when paginating results to indicate the maximum number of user names you want in the response. If there are additional user names beyond the maximum you specify, the IsTruncated response element is true.

Constraints:
Range: 1 - 1000

Parameters:

maxItems - Use this only when paginating results to indicate the maximum number of user names you want in the response. If there are additional user names beyond the maximum you specify, the IsTruncated response element is true.

withMaxItems

public GetGroupRequest withMaxItems(Integer maxItems)

Use this only when paginating results to indicate the maximum number of user names you want in the response. If there are additional user names 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

Parameters:

maxItems - Use this only when paginating results to indicate the maximum number of user names you want in the response. If there are additional user names beyond the maximum you specify, the IsTruncated response element is true.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

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

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object