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

Interface BatchReadOperation.Builder

All Superinterfaces:

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

Enclosing class:

BatchReadOperation

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

Method Summary

Modifier and Type	Method	Description
default BatchReadOperation.Builder	getLinkAttributes(Consumer<BatchGetLinkAttributes.Builder> getLinkAttributes)	Retrieves attributes that are associated with a typed link.
BatchReadOperation.Builder	getLinkAttributes(BatchGetLinkAttributes getLinkAttributes)	Retrieves attributes that are associated with a typed link.
default BatchReadOperation.Builder	getObjectAttributes(Consumer<BatchGetObjectAttributes.Builder> getObjectAttributes)	Retrieves attributes within a facet that are associated with an object.
BatchReadOperation.Builder	getObjectAttributes(BatchGetObjectAttributes getObjectAttributes)	Retrieves attributes within a facet that are associated with an object.
default BatchReadOperation.Builder	getObjectInformation(Consumer<BatchGetObjectInformation.Builder> getObjectInformation)	Retrieves metadata about an object.
BatchReadOperation.Builder	getObjectInformation(BatchGetObjectInformation getObjectInformation)	Retrieves metadata about an object.
default BatchReadOperation.Builder	listAttachedIndices(Consumer<BatchListAttachedIndices.Builder> listAttachedIndices)	Lists indices attached to an object.
BatchReadOperation.Builder	listAttachedIndices(BatchListAttachedIndices listAttachedIndices)	Lists indices attached to an object.
default BatchReadOperation.Builder	listIncomingTypedLinks(Consumer<BatchListIncomingTypedLinks.Builder> listIncomingTypedLinks)	Returns a paginated list of all the incoming TypedLinkSpecifier information for an object.
BatchReadOperation.Builder	listIncomingTypedLinks(BatchListIncomingTypedLinks listIncomingTypedLinks)	Returns a paginated list of all the incoming TypedLinkSpecifier information for an object.
default BatchReadOperation.Builder	listIndex(Consumer<BatchListIndex.Builder> listIndex)	Lists objects attached to the specified index.
BatchReadOperation.Builder	listIndex(BatchListIndex listIndex)	Lists objects attached to the specified index.
default BatchReadOperation.Builder	listObjectAttributes(Consumer<BatchListObjectAttributes.Builder> listObjectAttributes)	Lists all attributes that are associated with an object.
BatchReadOperation.Builder	listObjectAttributes(BatchListObjectAttributes listObjectAttributes)	Lists all attributes that are associated with an object.
default BatchReadOperation.Builder	listObjectChildren(Consumer<BatchListObjectChildren.Builder> listObjectChildren)	Returns a paginated list of child objects that are associated with a given object.
BatchReadOperation.Builder	listObjectChildren(BatchListObjectChildren listObjectChildren)	Returns a paginated list of child objects that are associated with a given object.
default BatchReadOperation.Builder	listObjectParentPaths(Consumer<BatchListObjectParentPaths.Builder> listObjectParentPaths)	Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects.
BatchReadOperation.Builder	listObjectParentPaths(BatchListObjectParentPaths listObjectParentPaths)	Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects.
default BatchReadOperation.Builder	listObjectParents(Consumer<BatchListObjectParents.Builder> listObjectParents)	Lists parent objects that are associated with a given object in pagination fashion.
BatchReadOperation.Builder	listObjectParents(BatchListObjectParents listObjectParents)	Lists parent objects that are associated with a given object in pagination fashion.
default BatchReadOperation.Builder	listObjectPolicies(Consumer<BatchListObjectPolicies.Builder> listObjectPolicies)	Returns policies attached to an object in pagination fashion.
BatchReadOperation.Builder	listObjectPolicies(BatchListObjectPolicies listObjectPolicies)	Returns policies attached to an object in pagination fashion.
default BatchReadOperation.Builder	listOutgoingTypedLinks(Consumer<BatchListOutgoingTypedLinks.Builder> listOutgoingTypedLinks)	Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object.
BatchReadOperation.Builder	listOutgoingTypedLinks(BatchListOutgoingTypedLinks listOutgoingTypedLinks)	Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object.
default BatchReadOperation.Builder	listPolicyAttachments(Consumer<BatchListPolicyAttachments.Builder> listPolicyAttachments)	Returns all of the ObjectIdentifiers to which a given policy is attached.
BatchReadOperation.Builder	listPolicyAttachments(BatchListPolicyAttachments listPolicyAttachments)	Returns all of the ObjectIdentifiers to which a given policy is attached.
default BatchReadOperation.Builder	lookupPolicy(Consumer<BatchLookupPolicy.Builder> lookupPolicy)	Lists all policies from the root of the Directory to the object specified.
BatchReadOperation.Builder	lookupPolicy(BatchLookupPolicy 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

BatchReadOperation.Builder listObjectAttributes(BatchListObjectAttributes 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 BatchReadOperation.Builder listObjectAttributes(Consumer<BatchListObjectAttributes.Builder> listObjectAttributes)

Lists all attributes that are associated with an object.

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

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

Parameters:

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

Returns:

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

See Also:

• listObjectAttributes(BatchListObjectAttributes)

listObjectChildren

BatchReadOperation.Builder listObjectChildren(BatchListObjectChildren 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 BatchReadOperation.Builder listObjectChildren(Consumer<BatchListObjectChildren.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 BatchListObjectChildren.Builder avoiding the need to create one manually via BatchListObjectChildren.builder().

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

Parameters:

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

Returns:

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

See Also:

• listObjectChildren(BatchListObjectChildren)

listAttachedIndices

BatchReadOperation.Builder listAttachedIndices(BatchListAttachedIndices 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 BatchReadOperation.Builder listAttachedIndices(Consumer<BatchListAttachedIndices.Builder> listAttachedIndices)

Lists indices attached to an object.

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

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

Parameters:

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

Returns:

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

See Also:

• listAttachedIndices(BatchListAttachedIndices)

listObjectParentPaths

BatchReadOperation.Builder listObjectParentPaths(BatchListObjectParentPaths 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 BatchReadOperation.Builder listObjectParentPaths(Consumer<BatchListObjectParentPaths.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 BatchListObjectParentPaths.Builder avoiding the need to create one manually via BatchListObjectParentPaths.builder().

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

Parameters:

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

Returns:

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

See Also:

• listObjectParentPaths(BatchListObjectParentPaths)

getObjectInformation

BatchReadOperation.Builder getObjectInformation(BatchGetObjectInformation 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 BatchReadOperation.Builder getObjectInformation(Consumer<BatchGetObjectInformation.Builder> getObjectInformation)

Retrieves metadata about an object.

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

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

Parameters:

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

Returns:

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

See Also:

• getObjectInformation(BatchGetObjectInformation)

getObjectAttributes

BatchReadOperation.Builder getObjectAttributes(BatchGetObjectAttributes 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 BatchReadOperation.Builder getObjectAttributes(Consumer<BatchGetObjectAttributes.Builder> getObjectAttributes)

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

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

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

Parameters:

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

Returns:

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

See Also:

• getObjectAttributes(BatchGetObjectAttributes)

listObjectParents

BatchReadOperation.Builder listObjectParents(BatchListObjectParents listObjectParents)

Lists parent objects that are associated with a given object in pagination fashion.

Parameters:

listObjectParents - Lists parent objects that are associated with a given object in pagination fashion.

Returns:

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

listObjectParents

default BatchReadOperation.Builder listObjectParents(Consumer<BatchListObjectParents.Builder> listObjectParents)

Lists parent objects that are associated with a given object in pagination fashion.

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

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

Parameters:

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

Returns:

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

See Also:

• listObjectParents(BatchListObjectParents)

listObjectPolicies

BatchReadOperation.Builder listObjectPolicies(BatchListObjectPolicies 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 BatchReadOperation.Builder listObjectPolicies(Consumer<BatchListObjectPolicies.Builder> listObjectPolicies)

Returns policies attached to an object in pagination fashion.

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

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

Parameters:

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

Returns:

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

See Also:

• listObjectPolicies(BatchListObjectPolicies)

listPolicyAttachments

BatchReadOperation.Builder listPolicyAttachments(BatchListPolicyAttachments 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 BatchReadOperation.Builder listPolicyAttachments(Consumer<BatchListPolicyAttachments.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 BatchListPolicyAttachments.Builder avoiding the need to create one manually via BatchListPolicyAttachments.builder().

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

Parameters:

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

Returns:

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

See Also:

• listPolicyAttachments(BatchListPolicyAttachments)

lookupPolicy

BatchReadOperation.Builder lookupPolicy(BatchLookupPolicy 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 BatchReadOperation.Builder lookupPolicy(Consumer<BatchLookupPolicy.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 BatchLookupPolicy.Builder avoiding the need to create one manually via BatchLookupPolicy.builder().

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

Parameters:

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

Returns:

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

See Also:

• lookupPolicy(BatchLookupPolicy)

listIndex

BatchReadOperation.Builder listIndex(BatchListIndex 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 BatchReadOperation.Builder listIndex(Consumer<BatchListIndex.Builder> listIndex)

Lists objects attached to the specified index.

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

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

Parameters:

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

Returns:

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

See Also:

• listIndex(BatchListIndex)

listOutgoingTypedLinks

BatchReadOperation.Builder listOutgoingTypedLinks(BatchListOutgoingTypedLinks 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 BatchReadOperation.Builder listOutgoingTypedLinks(Consumer<BatchListOutgoingTypedLinks.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 BatchListOutgoingTypedLinks.Builder avoiding the need to create one manually via BatchListOutgoingTypedLinks.builder().

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

Parameters:

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

Returns:

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

See Also:

• listOutgoingTypedLinks(BatchListOutgoingTypedLinks)

listIncomingTypedLinks

BatchReadOperation.Builder listIncomingTypedLinks(BatchListIncomingTypedLinks 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 BatchReadOperation.Builder listIncomingTypedLinks(Consumer<BatchListIncomingTypedLinks.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 BatchListIncomingTypedLinks.Builder avoiding the need to create one manually via BatchListIncomingTypedLinks.builder().

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

Parameters:

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

Returns:

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

See Also:

• listIncomingTypedLinks(BatchListIncomingTypedLinks)

getLinkAttributes

BatchReadOperation.Builder getLinkAttributes(BatchGetLinkAttributes getLinkAttributes)

Retrieves attributes that are associated with a typed link.

Parameters:

getLinkAttributes - Retrieves attributes that are associated with a typed link.

Returns:

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

getLinkAttributes

default BatchReadOperation.Builder getLinkAttributes(Consumer<BatchGetLinkAttributes.Builder> getLinkAttributes)

Retrieves attributes that are associated with a typed link.

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

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

Parameters:

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

Returns:

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

See Also:

• getLinkAttributes(BatchGetLinkAttributes)