com.amazonaws.services.workdocs.model

Class DescribeGroupsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.workdocs.model.DescribeGroupsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeGroupsRequest
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
DescribeGroupsRequest()

Method Summary

Modifier and Type	Method and Description
DescribeGroupsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAuthenticationToken() Amazon WorkDocs authentication token.
Integer	getLimit() The maximum number of items to return with this call.
String	getMarker() The marker for the next set of results.
String	getOrganizationId() The ID of the organization.
String	getSearchQuery() A query to describe groups by group name.
int	hashCode()
void	setAuthenticationToken(String authenticationToken) Amazon WorkDocs authentication token.
void	setLimit(Integer limit) The maximum number of items to return with this call.
void	setMarker(String marker) The marker for the next set of results.
void	setOrganizationId(String organizationId) The ID of the organization.
void	setSearchQuery(String searchQuery) A query to describe groups by group name.
String	toString() Returns a string representation of this object.
DescribeGroupsRequest	withAuthenticationToken(String authenticationToken) Amazon WorkDocs authentication token.
DescribeGroupsRequest	withLimit(Integer limit) The maximum number of items to return with this call.
DescribeGroupsRequest	withMarker(String marker) The marker for the next set of results.
DescribeGroupsRequest	withOrganizationId(String organizationId) The ID of the organization.
DescribeGroupsRequest	withSearchQuery(String searchQuery) A query to describe groups by group name.

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

DescribeGroupsRequest

public DescribeGroupsRequest()

Method Detail

setAuthenticationToken

public void setAuthenticationToken(String authenticationToken)

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

Parameters:

authenticationToken - Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

getAuthenticationToken

public String getAuthenticationToken()

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

Returns:

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

withAuthenticationToken

public DescribeGroupsRequest withAuthenticationToken(String authenticationToken)

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

Parameters:

authenticationToken - Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

Returns:

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

setSearchQuery

public void setSearchQuery(String searchQuery)

A query to describe groups by group name.

Parameters:

searchQuery - A query to describe groups by group name.

getSearchQuery

public String getSearchQuery()

A query to describe groups by group name.

Returns:

A query to describe groups by group name.

withSearchQuery

public DescribeGroupsRequest withSearchQuery(String searchQuery)

A query to describe groups by group name.

Parameters:

searchQuery - A query to describe groups by group name.

Returns:

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

setOrganizationId

public void setOrganizationId(String organizationId)

The ID of the organization.

Parameters:

organizationId - The ID of the organization.

getOrganizationId

public String getOrganizationId()

The ID of the organization.

Returns:

The ID of the organization.

withOrganizationId

public DescribeGroupsRequest withOrganizationId(String organizationId)

The ID of the organization.

Parameters:

organizationId - The ID of the organization.

Returns:

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

setMarker

public void setMarker(String marker)

The marker for the next set of results. (You received this marker from a previous call.)

Parameters:

marker - The marker for the next set of results. (You received this marker from a previous call.)

getMarker

public String getMarker()

The marker for the next set of results. (You received this marker from a previous call.)

Returns:

The marker for the next set of results. (You received this marker from a previous call.)

withMarker

public DescribeGroupsRequest withMarker(String marker)

The marker for the next set of results. (You received this marker from a previous call.)

Parameters:

marker - The marker for the next set of results. (You received this marker from a previous call.)

Returns:

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

setLimit

public void setLimit(Integer limit)

The maximum number of items to return with this call.

Parameters:

limit - The maximum number of items to return with this call.

getLimit

public Integer getLimit()

The maximum number of items to return with this call.

Returns:

The maximum number of items to return with this call.

withLimit

public DescribeGroupsRequest withLimit(Integer limit)

The maximum number of items to return with this call.

Parameters:

limit - The maximum number of items to return with this call.

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 DescribeGroupsRequest 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()