Class ListChildrenRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.organizations.model.OrganizationsRequest
software.amazon.awssdk.services.organizations.model.ListChildrenRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListChildrenRequest.Builder,ListChildrenRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListChildrenRequest extends OrganizationsRequest implements ToCopyableBuilder<ListChildrenRequest.Builder,ListChildrenRequest>

  • Method Details

    • parentId

      public final 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 lowercase letters or digits.

      • Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase 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 lowercase letters or digits.

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

    • childType

      public final 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().

      Returns:
      Filters the output to include only the specified child type.
      See Also:

    • childTypeAsString

      public final 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().

      Returns:
      Filters the output to include only the specified child type.
      See Also:

    • nextToken

      public final String nextToken()

      The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

      Returns:
      The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

    • maxResults

      public final Integer maxResults()

      The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

      Returns:
      The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

    • toBuilder

      public ListChildrenRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListChildrenRequest.Builder,ListChildrenRequest>
      Specified by:
      toBuilder in class OrganizationsRequest
      Returns:
      a builder for type T

    • builder

      public static ListChildrenRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListChildrenRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.