@Generated(value="software.amazon.awssdk:codegen") public final class ListChildrenRequest extends OrganizationsRequest implements ToCopyableBuilder<ListChildrenRequest.Builder,ListChildrenRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
ListChildrenRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static ListChildrenRequest.Builder |
builder() |
ChildType |
childType()
Filters the output to include only the specified child type.
|
String |
childTypeAsString()
Filters the output to include only the specified child type.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
int |
hashCode() |
Integer |
maxResults()
(Optional) Use this to limit the number of results you want included per page in the response.
|
String |
nextToken()
Use this parameter if you receive a
NextToken response in a previous request that indicates that
there is more output available. |
String |
parentId()
The unique identifier (ID) for the parent root or OU whose children you want to list.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends ListChildrenRequest.Builder> |
serializableBuilderClass() |
ListChildrenRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfigurationcopypublic 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.
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.
public ChildType childType()
Filters the output to include only the specified child type.
If the service returns an enum value that is not available in the current SDK version, childType will
return ChildType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
childTypeAsString().
ChildTypepublic String childTypeAsString()
Filters the output to include only the specified child type.
If the service returns an enum value that is not available in the current SDK version, childType will
return ChildType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
childTypeAsString().
ChildTypepublic 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.
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.public Integer maxResults()
(Optional) Use this to limit the number of results you want included per page 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.
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.public ListChildrenRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<ListChildrenRequest.Builder,ListChildrenRequest>toBuilder in class OrganizationsRequestpublic static ListChildrenRequest.Builder builder()
public static Class<? extends ListChildrenRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will
again be available.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.