Package software.amazon.awssdk.services.clouddirectory.model

Interface BatchReadSuccessfulResponse.Builder

All Superinterfaces:

Buildable, CopyableBuilder<BatchReadSuccessfulResponse.Builder,BatchReadSuccessfulResponse>, SdkBuilder<BatchReadSuccessfulResponse.Builder,BatchReadSuccessfulResponse>, SdkPojo

Enclosing class:

BatchReadSuccessfulResponse

public static interface BatchReadSuccessfulResponse.Builder
extends SdkPojo, CopyableBuilder<BatchReadSuccessfulResponse.Builder,BatchReadSuccessfulResponse>

Method Summary

Modifier and Type	Method	Description
default BatchReadSuccessfulResponse.Builder	getLinkAttributes(Consumer<BatchGetLinkAttributesResponse.Builder> getLinkAttributes)	The list of attributes to retrieve from the typed link.
BatchReadSuccessfulResponse.Builder	getLinkAttributes(BatchGetLinkAttributesResponse getLinkAttributes)	The list of attributes to retrieve from the typed link.
default BatchReadSuccessfulResponse.Builder	getObjectAttributes(Consumer<BatchGetObjectAttributesResponse.Builder> getObjectAttributes)	Retrieves attributes within a facet that are associated with an object.
BatchReadSuccessfulResponse.Builder	getObjectAttributes(BatchGetObjectAttributesResponse getObjectAttributes)	Retrieves attributes within a facet that are associated with an object.
default BatchReadSuccessfulResponse.Builder	getObjectInformation(Consumer<BatchGetObjectInformationResponse.Builder> getObjectInformation)	Retrieves metadata about an object.
BatchReadSuccessfulResponse.Builder	getObjectInformation(BatchGetObjectInformationResponse getObjectInformation)	Retrieves metadata about an object.
default BatchReadSuccessfulResponse.Builder	listAttachedIndices(Consumer<BatchListAttachedIndicesResponse.Builder> listAttachedIndices)	Lists indices attached to an object.
BatchReadSuccessfulResponse.Builder	listAttachedIndices(BatchListAttachedIndicesResponse listAttachedIndices)	Lists indices attached to an object.
default BatchReadSuccessfulResponse.Builder	listIncomingTypedLinks(Consumer<BatchListIncomingTypedLinksResponse.Builder> listIncomingTypedLinks)	Returns a paginated list of all the incoming TypedLinkSpecifier information for an object.
BatchReadSuccessfulResponse.Builder	listIncomingTypedLinks(BatchListIncomingTypedLinksResponse listIncomingTypedLinks)	Returns a paginated list of all the incoming TypedLinkSpecifier information for an object.
default BatchReadSuccessfulResponse.Builder	listIndex(Consumer<BatchListIndexResponse.Builder> listIndex)	Lists objects attached to the specified index.
BatchReadSuccessfulResponse.Builder	listIndex(BatchListIndexResponse listIndex)	Lists objects attached to the specified index.
default BatchReadSuccessfulResponse.Builder	listObjectAttributes(Consumer<BatchListObjectAttributesResponse.Builder> listObjectAttributes)	Lists all attributes that are associated with an object.
BatchReadSuccessfulResponse.Builder	listObjectAttributes(BatchListObjectAttributesResponse listObjectAttributes)	Lists all attributes that are associated with an object.
default BatchReadSuccessfulResponse.Builder	listObjectChildren(Consumer<BatchListObjectChildrenResponse.Builder> listObjectChildren)	Returns a paginated list of child objects that are associated with a given object.
BatchReadSuccessfulResponse.Builder	listObjectChildren(BatchListObjectChildrenResponse listObjectChildren)	Returns a paginated list of child objects that are associated with a given object.
default BatchReadSuccessfulResponse.Builder	listObjectParentPaths(Consumer<BatchListObjectParentPathsResponse.Builder> listObjectParentPaths)	Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects.
BatchReadSuccessfulResponse.Builder	listObjectParentPaths(BatchListObjectParentPathsResponse listObjectParentPaths)	Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects.
default BatchReadSuccessfulResponse.Builder	listObjectParents(Consumer<BatchListObjectParentsResponse.Builder> listObjectParents)	The list of parent objects to retrieve.
BatchReadSuccessfulResponse.Builder	listObjectParents(BatchListObjectParentsResponse listObjectParents)	The list of parent objects to retrieve.
default BatchReadSuccessfulResponse.Builder	listObjectPolicies(Consumer<BatchListObjectPoliciesResponse.Builder> listObjectPolicies)	Returns policies attached to an object in pagination fashion.
BatchReadSuccessfulResponse.Builder	listObjectPolicies(BatchListObjectPoliciesResponse listObjectPolicies)	Returns policies attached to an object in pagination fashion.
default BatchReadSuccessfulResponse.Builder	listOutgoingTypedLinks(Consumer<BatchListOutgoingTypedLinksResponse.Builder> listOutgoingTypedLinks)	Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object.
BatchReadSuccessfulResponse.Builder	listOutgoingTypedLinks(BatchListOutgoingTypedLinksResponse listOutgoingTypedLinks)	Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object.
default BatchReadSuccessfulResponse.Builder	listPolicyAttachments(Consumer<BatchListPolicyAttachmentsResponse.Builder> listPolicyAttachments)	Returns all of the ObjectIdentifiers to which a given policy is attached.
BatchReadSuccessfulResponse.Builder	listPolicyAttachments(BatchListPolicyAttachmentsResponse listPolicyAttachments)	Returns all of the ObjectIdentifiers to which a given policy is attached.
default BatchReadSuccessfulResponse.Builder	lookupPolicy(Consumer<BatchLookupPolicyResponse.Builder> lookupPolicy)	Lists all policies from the root of the Directory to the object specified.
BatchReadSuccessfulResponse.Builder	lookupPolicy(BatchLookupPolicyResponse lookupPolicy)	Lists all policies from the root of the Directory to the object specified.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

listObjectAttributes

BatchReadSuccessfulResponse.Builder listObjectAttributes(BatchListObjectAttributesResponse listObjectAttributes)

Lists all attributes that are associated with an object.

Parameters:

listObjectAttributes - Lists all attributes that are associated with an object.

Returns:

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

listObjectAttributes

default BatchReadSuccessfulResponse.Builder listObjectAttributes(Consumer<BatchListObjectAttributesResponse.Builder> listObjectAttributes)

Lists all attributes that are associated with an object.

This is a convenience method that creates an instance of the BatchListObjectAttributesResponse.Builder avoiding the need to create one manually via BatchListObjectAttributesResponse.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to listObjectAttributes(BatchListObjectAttributesResponse).

Parameters:

listObjectAttributes - a consumer that will call methods on BatchListObjectAttributesResponse.Builder

Returns:

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

See Also:

• listObjectAttributes(BatchListObjectAttributesResponse)

listObjectChildren

BatchReadSuccessfulResponse.Builder listObjectChildren(BatchListObjectChildrenResponse listObjectChildren)

Returns a paginated list of child objects that are associated with a given object.

Parameters:

listObjectChildren - Returns a paginated list of child objects that are associated with a given object.

Returns:

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

listObjectChildren

default BatchReadSuccessfulResponse.Builder listObjectChildren(Consumer<BatchListObjectChildrenResponse.Builder> listObjectChildren)

Returns a paginated list of child objects that are associated with a given object.

This is a convenience method that creates an instance of the BatchListObjectChildrenResponse.Builder avoiding the need to create one manually via BatchListObjectChildrenResponse.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to listObjectChildren(BatchListObjectChildrenResponse).

Parameters:

listObjectChildren - a consumer that will call methods on BatchListObjectChildrenResponse.Builder

Returns:

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

See Also:

• listObjectChildren(BatchListObjectChildrenResponse)

getObjectInformation

BatchReadSuccessfulResponse.Builder getObjectInformation(BatchGetObjectInformationResponse getObjectInformation)

Retrieves metadata about an object.

Parameters:

getObjectInformation - Retrieves metadata about an object.

Returns:

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

getObjectInformation

default BatchReadSuccessfulResponse.Builder getObjectInformation(Consumer<BatchGetObjectInformationResponse.Builder> getObjectInformation)

Retrieves metadata about an object.

This is a convenience method that creates an instance of the BatchGetObjectInformationResponse.Builder avoiding the need to create one manually via BatchGetObjectInformationResponse.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to getObjectInformation(BatchGetObjectInformationResponse).

Parameters:

getObjectInformation - a consumer that will call methods on BatchGetObjectInformationResponse.Builder

Returns:

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

See Also:

• getObjectInformation(BatchGetObjectInformationResponse)

getObjectAttributes

BatchReadSuccessfulResponse.Builder getObjectAttributes(BatchGetObjectAttributesResponse getObjectAttributes)

Retrieves attributes within a facet that are associated with an object.

Parameters:

getObjectAttributes - Retrieves attributes within a facet that are associated with an object.

Returns:

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

getObjectAttributes

default BatchReadSuccessfulResponse.Builder getObjectAttributes(Consumer<BatchGetObjectAttributesResponse.Builder> getObjectAttributes)

Retrieves attributes within a facet that are associated with an object.

This is a convenience method that creates an instance of the BatchGetObjectAttributesResponse.Builder avoiding the need to create one manually via BatchGetObjectAttributesResponse.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to getObjectAttributes(BatchGetObjectAttributesResponse).

Parameters:

getObjectAttributes - a consumer that will call methods on BatchGetObjectAttributesResponse.Builder

Returns:

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

See Also:

• getObjectAttributes(BatchGetObjectAttributesResponse)

listAttachedIndices

BatchReadSuccessfulResponse.Builder listAttachedIndices(BatchListAttachedIndicesResponse listAttachedIndices)

Lists indices attached to an object.

Parameters:

listAttachedIndices - Lists indices attached to an object.

Returns:

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

listAttachedIndices

default BatchReadSuccessfulResponse.Builder listAttachedIndices(Consumer<BatchListAttachedIndicesResponse.Builder> listAttachedIndices)

Lists indices attached to an object.

This is a convenience method that creates an instance of the BatchListAttachedIndicesResponse.Builder avoiding the need to create one manually via BatchListAttachedIndicesResponse.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to listAttachedIndices(BatchListAttachedIndicesResponse).

Parameters:

listAttachedIndices - a consumer that will call methods on BatchListAttachedIndicesResponse.Builder

Returns:

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

See Also:

• listAttachedIndices(BatchListAttachedIndicesResponse)

listObjectParentPaths

BatchReadSuccessfulResponse.Builder listObjectParentPaths(BatchListObjectParentPathsResponse listObjectParentPaths)

Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see Directory Structure.

Parameters:

listObjectParentPaths - Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see Directory Structure.

Returns:

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

listObjectParentPaths

default BatchReadSuccessfulResponse.Builder listObjectParentPaths(Consumer<BatchListObjectParentPathsResponse.Builder> listObjectParentPaths)

Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see Directory Structure.

This is a convenience method that creates an instance of the BatchListObjectParentPathsResponse.Builder avoiding the need to create one manually via BatchListObjectParentPathsResponse.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to listObjectParentPaths(BatchListObjectParentPathsResponse).

Parameters:

listObjectParentPaths - a consumer that will call methods on BatchListObjectParentPathsResponse.Builder

Returns:

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

See Also:

• listObjectParentPaths(BatchListObjectParentPathsResponse)

listObjectPolicies

BatchReadSuccessfulResponse.Builder listObjectPolicies(BatchListObjectPoliciesResponse listObjectPolicies)

Returns policies attached to an object in pagination fashion.

Parameters:

listObjectPolicies - Returns policies attached to an object in pagination fashion.

Returns:

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

listObjectPolicies

default BatchReadSuccessfulResponse.Builder listObjectPolicies(Consumer<BatchListObjectPoliciesResponse.Builder> listObjectPolicies)

Returns policies attached to an object in pagination fashion.

This is a convenience method that creates an instance of the BatchListObjectPoliciesResponse.Builder avoiding the need to create one manually via BatchListObjectPoliciesResponse.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to listObjectPolicies(BatchListObjectPoliciesResponse).

Parameters:

listObjectPolicies - a consumer that will call methods on BatchListObjectPoliciesResponse.Builder

Returns:

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

See Also:

• listObjectPolicies(BatchListObjectPoliciesResponse)

listPolicyAttachments

BatchReadSuccessfulResponse.Builder listPolicyAttachments(BatchListPolicyAttachmentsResponse listPolicyAttachments)

Returns all of the ObjectIdentifiers to which a given policy is attached.

Parameters:

listPolicyAttachments - Returns all of the ObjectIdentifiers to which a given policy is attached.

Returns:

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

listPolicyAttachments

default BatchReadSuccessfulResponse.Builder listPolicyAttachments(Consumer<BatchListPolicyAttachmentsResponse.Builder> listPolicyAttachments)

Returns all of the ObjectIdentifiers to which a given policy is attached.

This is a convenience method that creates an instance of the BatchListPolicyAttachmentsResponse.Builder avoiding the need to create one manually via BatchListPolicyAttachmentsResponse.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to listPolicyAttachments(BatchListPolicyAttachmentsResponse).

Parameters:

listPolicyAttachments - a consumer that will call methods on BatchListPolicyAttachmentsResponse.Builder

Returns:

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

See Also:

• listPolicyAttachments(BatchListPolicyAttachmentsResponse)

lookupPolicy

BatchReadSuccessfulResponse.Builder lookupPolicy(BatchLookupPolicyResponse lookupPolicy)

Lists all policies from the root of the Directory to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the ObjectIdentifier for such objects. If policies are present, it returns ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root from the target object are ignored. For more information, see Policies.

Parameters:

lookupPolicy - Lists all policies from the root of the Directory to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the ObjectIdentifier for such objects. If policies are present, it returns ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root from the target object are ignored. For more information, see Policies.

Returns:

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

lookupPolicy

default BatchReadSuccessfulResponse.Builder lookupPolicy(Consumer<BatchLookupPolicyResponse.Builder> lookupPolicy)

Lists all policies from the root of the Directory to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the ObjectIdentifier for such objects. If policies are present, it returns ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root from the target object are ignored. For more information, see Policies.

This is a convenience method that creates an instance of the BatchLookupPolicyResponse.Builder avoiding the need to create one manually via BatchLookupPolicyResponse.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lookupPolicy(BatchLookupPolicyResponse).

Parameters:

lookupPolicy - a consumer that will call methods on BatchLookupPolicyResponse.Builder

Returns:

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

See Also:

• lookupPolicy(BatchLookupPolicyResponse)

listIndex

BatchReadSuccessfulResponse.Builder listIndex(BatchListIndexResponse listIndex)

Lists objects attached to the specified index.

Parameters:

listIndex - Lists objects attached to the specified index.

Returns:

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

listIndex

default BatchReadSuccessfulResponse.Builder listIndex(Consumer<BatchListIndexResponse.Builder> listIndex)

Lists objects attached to the specified index.

This is a convenience method that creates an instance of the BatchListIndexResponse.Builder avoiding the need to create one manually via BatchListIndexResponse.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to listIndex(BatchListIndexResponse).

Parameters:

listIndex - a consumer that will call methods on BatchListIndexResponse.Builder

Returns:

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

See Also:

• listIndex(BatchListIndexResponse)

listOutgoingTypedLinks

BatchReadSuccessfulResponse.Builder listOutgoingTypedLinks(BatchListOutgoingTypedLinksResponse listOutgoingTypedLinks)

Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links.

Parameters:

listOutgoingTypedLinks - Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links.

Returns:

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

listOutgoingTypedLinks

default BatchReadSuccessfulResponse.Builder listOutgoingTypedLinks(Consumer<BatchListOutgoingTypedLinksResponse.Builder> listOutgoingTypedLinks)

Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links.

This is a convenience method that creates an instance of the BatchListOutgoingTypedLinksResponse.Builder avoiding the need to create one manually via BatchListOutgoingTypedLinksResponse.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to listOutgoingTypedLinks(BatchListOutgoingTypedLinksResponse).

Parameters:

listOutgoingTypedLinks - a consumer that will call methods on BatchListOutgoingTypedLinksResponse.Builder

Returns:

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

See Also:

• listOutgoingTypedLinks(BatchListOutgoingTypedLinksResponse)

listIncomingTypedLinks

BatchReadSuccessfulResponse.Builder listIncomingTypedLinks(BatchListIncomingTypedLinksResponse listIncomingTypedLinks)

Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links.

Parameters:

listIncomingTypedLinks - Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links.

Returns:

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

listIncomingTypedLinks

default BatchReadSuccessfulResponse.Builder listIncomingTypedLinks(Consumer<BatchListIncomingTypedLinksResponse.Builder> listIncomingTypedLinks)

Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links.

This is a convenience method that creates an instance of the BatchListIncomingTypedLinksResponse.Builder avoiding the need to create one manually via BatchListIncomingTypedLinksResponse.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to listIncomingTypedLinks(BatchListIncomingTypedLinksResponse).

Parameters:

listIncomingTypedLinks - a consumer that will call methods on BatchListIncomingTypedLinksResponse.Builder

Returns:

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

See Also:

• listIncomingTypedLinks(BatchListIncomingTypedLinksResponse)

getLinkAttributes

BatchReadSuccessfulResponse.Builder getLinkAttributes(BatchGetLinkAttributesResponse getLinkAttributes)

The list of attributes to retrieve from the typed link.

Parameters:

getLinkAttributes - The list of attributes to retrieve from the typed link.

Returns:

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

getLinkAttributes

default BatchReadSuccessfulResponse.Builder getLinkAttributes(Consumer<BatchGetLinkAttributesResponse.Builder> getLinkAttributes)

The list of attributes to retrieve from the typed link.

This is a convenience method that creates an instance of the BatchGetLinkAttributesResponse.Builder avoiding the need to create one manually via BatchGetLinkAttributesResponse.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to getLinkAttributes(BatchGetLinkAttributesResponse).

Parameters:

getLinkAttributes - a consumer that will call methods on BatchGetLinkAttributesResponse.Builder

Returns:

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

See Also:

• getLinkAttributes(BatchGetLinkAttributesResponse)

listObjectParents

BatchReadSuccessfulResponse.Builder listObjectParents(BatchListObjectParentsResponse listObjectParents)

The list of parent objects to retrieve.

Parameters:

listObjectParents - The list of parent objects to retrieve.

Returns:

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

listObjectParents

default BatchReadSuccessfulResponse.Builder listObjectParents(Consumer<BatchListObjectParentsResponse.Builder> listObjectParents)

The list of parent objects to retrieve.

This is a convenience method that creates an instance of the BatchListObjectParentsResponse.Builder avoiding the need to create one manually via BatchListObjectParentsResponse.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to listObjectParents(BatchListObjectParentsResponse).

Parameters:

listObjectParents - a consumer that will call methods on BatchListObjectParentsResponse.Builder

Returns:

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

See Also:

• listObjectParents(BatchListObjectParentsResponse)