com.amazonaws.services.identitystore.model

Class ListGroupsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.identitystore.model.ListGroupsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListGroupsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListGroupsRequest()

Method Summary

Modifier and Type	Method and Description
ListGroupsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<Filter>	getFilters() Deprecated.
String	getIdentityStoreId() The globally unique identifier for the identity store, such as d-1234567890.
Integer	getMaxResults() The maximum number of results to be returned per request.
String	getNextToken() The pagination token used for the ListUsers and ListGroups API operations.
int	hashCode()
void	setFilters(Collection<Filter> filters) Deprecated.
void	setIdentityStoreId(String identityStoreId) The globally unique identifier for the identity store, such as d-1234567890.
void	setMaxResults(Integer maxResults) The maximum number of results to be returned per request.
void	setNextToken(String nextToken) The pagination token used for the ListUsers and ListGroups API operations.
String	toString() Returns a string representation of this object.
ListGroupsRequest	withFilters(Collection<Filter> filters) Deprecated.
ListGroupsRequest	withFilters(Filter... filters) Deprecated.
ListGroupsRequest	withIdentityStoreId(String identityStoreId) The globally unique identifier for the identity store, such as d-1234567890.
ListGroupsRequest	withMaxResults(Integer maxResults) The maximum number of results to be returned per request.
ListGroupsRequest	withNextToken(String nextToken) The pagination token used for the ListUsers and ListGroups API operations.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListGroupsRequest

public ListGroupsRequest()

Method Detail

setIdentityStoreId

public void setIdentityStoreId(String identityStoreId)

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

Parameters:

identityStoreId - The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

getIdentityStoreId

public String getIdentityStoreId()

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

Returns:

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

withIdentityStoreId

public ListGroupsRequest withIdentityStoreId(String identityStoreId)

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

Parameters:

identityStoreId - The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

Returns:

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

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

Parameters:

maxResults - The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

getMaxResults

public Integer getMaxResults()

The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

Returns:

The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

withMaxResults

public ListGroupsRequest withMaxResults(Integer maxResults)

The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

Parameters:

maxResults - The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

Parameters:

nextToken - The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

getNextToken

public String getNextToken()

The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

Returns:

The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

withNextToken

public ListGroupsRequest withNextToken(String nextToken)

The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

Parameters:

nextToken - The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

Returns:

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

getFilters

@Deprecated
public List<Filter> getFilters()

Deprecated.

A list of Filter objects, which is used in the ListUsers and ListGroups requests.

Returns:

A list of Filter objects, which is used in the ListUsers and ListGroups requests.

setFilters

@Deprecated
public void setFilters(Collection<Filter> filters)

Deprecated.

A list of Filter objects, which is used in the ListUsers and ListGroups requests.

Parameters:

filters - A list of Filter objects, which is used in the ListUsers and ListGroups requests.

withFilters

@Deprecated
public ListGroupsRequest withFilters(Filter... filters)

Deprecated.

A list of Filter objects, which is used in the ListUsers and ListGroups requests.

NOTE: This method appends the values to the existing list (if any). Use setFilters(java.util.Collection) or withFilters(java.util.Collection) if you want to override the existing values.

Parameters:

filters - A list of Filter objects, which is used in the ListUsers and ListGroups requests.

Returns:

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

withFilters

@Deprecated
public ListGroupsRequest withFilters(Collection<Filter> filters)

Deprecated.

A list of Filter objects, which is used in the ListUsers and ListGroups requests.

Parameters:

filters - A list of Filter objects, which is used in the ListUsers and ListGroups requests.

Returns:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ListGroupsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()