com.amazonaws.services.organizations.model

Class ListChildrenRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.organizations.model.ListChildrenRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
ListChildrenRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getChildType() Filters the output to include only the specified child type.
Integer	getMaxResults() (Optional) Use this to limit the number of results you want included in the response.
String	getNextToken() Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available.
String	getParentId() The unique identifier (ID) for the parent root or OU whose children you want to list.
int	hashCode()
void	setChildType(ChildType childType) Filters the output to include only the specified child type.
void	setChildType(String childType) Filters the output to include only the specified child type.
void	setMaxResults(Integer maxResults) (Optional) Use this to limit the number of results you want included in the response.
void	setNextToken(String nextToken) Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available.
void	setParentId(String parentId) The unique identifier (ID) for the parent root or OU whose children you want to list.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListChildrenRequest	withChildType(ChildType childType) Filters the output to include only the specified child type.
ListChildrenRequest	withChildType(String childType) Filters the output to include only the specified child type.
ListChildrenRequest	withMaxResults(Integer maxResults) (Optional) Use this to limit the number of results you want included in the response.
ListChildrenRequest	withNextToken(String nextToken) Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available.
ListChildrenRequest	withParentId(String parentId) The unique identifier (ID) for the parent root or OU whose children you want to list.

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

ListChildrenRequest

public ListChildrenRequest()

Method Detail

setParentId

public void setParentId(String parentId)

The unique identifier (ID) for the parent root or OU whose children you want to list.

The regex pattern for a parent ID string requires one of the following:

• Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits.

• Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

Parameters:

parentId - The unique identifier (ID) for the parent root or OU whose children you want to list.

The regex pattern for a parent ID string requires one of the following:

• Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits.

• Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

getParentId

public String getParentId()

The unique identifier (ID) for the parent root or OU whose children you want to list.

The regex pattern for a parent ID string requires one of the following:

• Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits.

• Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

Returns:

The unique identifier (ID) for the parent root or OU whose children you want to list.

The regex pattern for a parent ID string requires one of the following:

• Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits.

• Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

withParentId

public ListChildrenRequest withParentId(String parentId)

The unique identifier (ID) for the parent root or OU whose children you want to list.

The regex pattern for a parent ID string requires one of the following:

• Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits.

• Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

Parameters:

parentId - The unique identifier (ID) for the parent root or OU whose children you want to list.

The regex pattern for a parent ID string requires one of the following:

• Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits.

• Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

Returns:

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

setChildType

public void setChildType(String childType)

Filters the output to include only the specified child type.

Parameters:

childType - Filters the output to include only the specified child type.

See Also:

ChildType

getChildType

public String getChildType()

Filters the output to include only the specified child type.

Returns:

Filters the output to include only the specified child type.

See Also:

ChildType

withChildType

public ListChildrenRequest withChildType(String childType)

Filters the output to include only the specified child type.

Parameters:

childType - Filters the output to include only the specified child type.

Returns:

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

See Also:

ChildType

setChildType

public void setChildType(ChildType childType)

Filters the output to include only the specified child type.

Parameters:

childType - Filters the output to include only the specified child type.

See Also:

ChildType

withChildType

public ListChildrenRequest withChildType(ChildType childType)

Filters the output to include only the specified child type.

Parameters:

childType - Filters the output to include only the specified child type.

Returns:

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

See Also:

ChildType

setNextToken

public void setNextToken(String nextToken)

Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

Parameters:

nextToken - Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

getNextToken

public String getNextToken()

Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

Returns:

Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

withNextToken

public ListChildrenRequest withNextToken(String nextToken)

Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

Parameters:

nextToken - Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

Returns:

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

setMaxResults

public void setMaxResults(Integer maxResults)

(Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Parameters:

maxResults - (Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

getMaxResults

public Integer getMaxResults()

(Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Returns:

(Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

withMaxResults

public ListChildrenRequest withMaxResults(Integer maxResults)

(Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Parameters:

maxResults - (Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of 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; useful for testing and debugging.

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