com.amazonaws.services.sagemaker.model

Class ListUserProfilesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sagemaker.model.ListUserProfilesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
ListUserProfilesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDomainIdEquals() A parameter by which to filter the results.
Integer	getMaxResults() This parameter defines the maximum number of results that can be return in a single response.
String	getNextToken() If the previous response was truncated, you will receive this token.
String	getSortBy() The parameter by which to sort the results.
String	getSortOrder() The sort order for the results.
String	getUserProfileNameContains() A parameter by which to filter the results.
int	hashCode()
void	setDomainIdEquals(String domainIdEquals) A parameter by which to filter the results.
void	setMaxResults(Integer maxResults) This parameter defines the maximum number of results that can be return in a single response.
void	setNextToken(String nextToken) If the previous response was truncated, you will receive this token.
void	setSortBy(String sortBy) The parameter by which to sort the results.
void	setSortOrder(String sortOrder) The sort order for the results.
void	setUserProfileNameContains(String userProfileNameContains) A parameter by which to filter the results.
String	toString() Returns a string representation of this object.
ListUserProfilesRequest	withDomainIdEquals(String domainIdEquals) A parameter by which to filter the results.
ListUserProfilesRequest	withMaxResults(Integer maxResults) This parameter defines the maximum number of results that can be return in a single response.
ListUserProfilesRequest	withNextToken(String nextToken) If the previous response was truncated, you will receive this token.
ListUserProfilesRequest	withSortBy(String sortBy) The parameter by which to sort the results.
ListUserProfilesRequest	withSortBy(UserProfileSortKey sortBy) The parameter by which to sort the results.
ListUserProfilesRequest	withSortOrder(SortOrder sortOrder) The sort order for the results.
ListUserProfilesRequest	withSortOrder(String sortOrder) The sort order for the results.
ListUserProfilesRequest	withUserProfileNameContains(String userProfileNameContains) A parameter by which to filter the results.

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

ListUserProfilesRequest

public ListUserProfilesRequest()

Method Detail

setNextToken

public void setNextToken(String nextToken)

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

Parameters:

nextToken - If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

getNextToken

public String getNextToken()

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

Returns:

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

withNextToken

public ListUserProfilesRequest withNextToken(String nextToken)

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

Parameters:

nextToken - If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

Returns:

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

setMaxResults

public void setMaxResults(Integer maxResults)

This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.

Parameters:

maxResults - This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.

getMaxResults

public Integer getMaxResults()

This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.

Returns:

This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.

withMaxResults

public ListUserProfilesRequest withMaxResults(Integer maxResults)

This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.

Parameters:

maxResults - This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.

Returns:

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

setSortOrder

public void setSortOrder(String sortOrder)

The sort order for the results. The default is Ascending.

Parameters:

sortOrder - The sort order for the results. The default is Ascending.

See Also:

SortOrder

getSortOrder

public String getSortOrder()

The sort order for the results. The default is Ascending.

Returns:

The sort order for the results. The default is Ascending.

See Also:

SortOrder

withSortOrder

public ListUserProfilesRequest withSortOrder(String sortOrder)

The sort order for the results. The default is Ascending.

Parameters:

sortOrder - The sort order for the results. The default is Ascending.

Returns:

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

See Also:

SortOrder

withSortOrder

public ListUserProfilesRequest withSortOrder(SortOrder sortOrder)

The sort order for the results. The default is Ascending.

Parameters:

sortOrder - The sort order for the results. The default is Ascending.

Returns:

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

See Also:

SortOrder

setSortBy

public void setSortBy(String sortBy)

The parameter by which to sort the results. The default is CreationTime.

Parameters:

sortBy - The parameter by which to sort the results. The default is CreationTime.

See Also:

UserProfileSortKey

getSortBy

public String getSortBy()

The parameter by which to sort the results. The default is CreationTime.

Returns:

The parameter by which to sort the results. The default is CreationTime.

See Also:

UserProfileSortKey

withSortBy

public ListUserProfilesRequest withSortBy(String sortBy)

The parameter by which to sort the results. The default is CreationTime.

Parameters:

sortBy - The parameter by which to sort the results. The default is CreationTime.

Returns:

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

See Also:

UserProfileSortKey

withSortBy

public ListUserProfilesRequest withSortBy(UserProfileSortKey sortBy)

The parameter by which to sort the results. The default is CreationTime.

Parameters:

sortBy - The parameter by which to sort the results. The default is CreationTime.

Returns:

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

See Also:

UserProfileSortKey

setDomainIdEquals

public void setDomainIdEquals(String domainIdEquals)

A parameter by which to filter the results.

Parameters:

domainIdEquals - A parameter by which to filter the results.

getDomainIdEquals

public String getDomainIdEquals()

A parameter by which to filter the results.

Returns:

A parameter by which to filter the results.

withDomainIdEquals

public ListUserProfilesRequest withDomainIdEquals(String domainIdEquals)

A parameter by which to filter the results.

Parameters:

domainIdEquals - A parameter by which to filter the results.

Returns:

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

setUserProfileNameContains

public void setUserProfileNameContains(String userProfileNameContains)

A parameter by which to filter the results.

Parameters:

userProfileNameContains - A parameter by which to filter the results.

getUserProfileNameContains

public String getUserProfileNameContains()

A parameter by which to filter the results.

Returns:

A parameter by which to filter the results.

withUserProfileNameContains

public ListUserProfilesRequest withUserProfileNameContains(String userProfileNameContains)

A parameter by which to filter the results.

Parameters:

userProfileNameContains - A parameter by which to filter the results.

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