java.lang.Object
- software.amazon.awssdk.services.clouddirectory.model.BatchReadOperation

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<BatchReadOperation.Builder,BatchReadOperation>

@Generated("software.amazon.awssdk:codegen")
public final class BatchReadOperation
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<BatchReadOperation.Builder,BatchReadOperation>

Represents the output of a BatchRead operation.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface BatchReadOperation.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static BatchReadOperation.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`BatchGetLinkAttributes`	`getLinkAttributes()`	Retrieves attributes that are associated with a typed link.
`BatchGetObjectAttributes`	`getObjectAttributes()`	Retrieves attributes within a facet that are associated with an object.
`BatchGetObjectInformation`	`getObjectInformation()`	Retrieves metadata about an object.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`BatchListAttachedIndices`	`listAttachedIndices()`	Lists indices attached to an object.
`BatchListIncomingTypedLinks`	`listIncomingTypedLinks()`	Returns a paginated list of all the incoming TypedLinkSpecifier information for an object.
`BatchListIndex`	`listIndex()`	Lists objects attached to the specified index.
`BatchListObjectAttributes`	`listObjectAttributes()`	Lists all attributes that are associated with an object.
`BatchListObjectChildren`	`listObjectChildren()`	Returns a paginated list of child objects that are associated with a given object.
`BatchListObjectParentPaths`	`listObjectParentPaths()`	Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects.
`BatchListObjectParents`	`listObjectParents()`	Lists parent objects that are associated with a given object in pagination fashion.
`BatchListObjectPolicies`	`listObjectPolicies()`	Returns policies attached to an object in pagination fashion.
`BatchListOutgoingTypedLinks`	`listOutgoingTypedLinks()`	Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object.
`BatchListPolicyAttachments`	`listPolicyAttachments()`	Returns all of the `ObjectIdentifiers` to which a given policy is attached.
`BatchLookupPolicy`	`lookupPolicy()`	Lists all policies from the root of the Directory to the object specified.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends BatchReadOperation.Builder>`	`serializableBuilderClass()`
`BatchReadOperation.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - listObjectAttributes
```
public final BatchListObjectAttributes listObjectAttributes()
```
    Lists all attributes that are associated with an object.
    
    Returns:
    
    Lists all attributes that are associated with an object.
  - listObjectChildren
```
public final BatchListObjectChildren listObjectChildren()
```
    Returns a paginated list of child objects that are associated with a given object.
    
    Returns:
    
    Returns a paginated list of child objects that are associated with a given object.
  - listAttachedIndices
```
public final BatchListAttachedIndices listAttachedIndices()
```
    Lists indices attached to an object.
    
    Returns:
    
    Lists indices attached to an object.
  - listObjectParentPaths
```
public final 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.
    
    Returns:
    
    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.
  - getObjectInformation
```
public final BatchGetObjectInformation getObjectInformation()
```
    Retrieves metadata about an object.
    
    Returns:
    
    Retrieves metadata about an object.
  - getObjectAttributes
```
public final BatchGetObjectAttributes getObjectAttributes()
```
    Retrieves attributes within a facet that are associated with an object.
    
    Returns:
    
    Retrieves attributes within a facet that are associated with an object.
  - listObjectParents
```
public final BatchListObjectParents listObjectParents()
```
    Lists parent objects that are associated with a given object in pagination fashion.
    
    Returns:
    
    Lists parent objects that are associated with a given object in pagination fashion.
  - listObjectPolicies
```
public final BatchListObjectPolicies listObjectPolicies()
```
    Returns policies attached to an object in pagination fashion.
    
    Returns:
    
    Returns policies attached to an object in pagination fashion.
  - listPolicyAttachments
```
public final BatchListPolicyAttachments listPolicyAttachments()
```
    Returns all of the ObjectIdentifiers to which a given policy is attached.
    
    Returns:
    
    Returns all of the ObjectIdentifiers to which a given policy is attached.
  - lookupPolicy
```
public final 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.
    
    Returns:
    
    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.
  - listIndex
```
public final BatchListIndex listIndex()
```
    Lists objects attached to the specified index.
    
    Returns:
    
    Lists objects attached to the specified index.
  - listOutgoingTypedLinks
```
public final 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.
    
    Returns:
    
    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.
  - listIncomingTypedLinks
```
public final 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.
    
    Returns:
    
    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.
  - getLinkAttributes
```
public final BatchGetLinkAttributes getLinkAttributes()
```
    Retrieves attributes that are associated with a typed link.
    
    Returns:
    
    Retrieves attributes that are associated with a typed link.
  - toBuilder
```
public BatchReadOperation.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<BatchReadOperation.Builder,BatchReadOperation>
  - builder
```
public static BatchReadOperation.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends BatchReadOperation.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class BatchReadOperation

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

listObjectAttributes

listObjectChildren

listAttachedIndices

listObjectParentPaths

getObjectInformation

getObjectAttributes

listObjectParents

listObjectPolicies

listPolicyAttachments

lookupPolicy

listIndex

listOutgoingTypedLinks

listIncomingTypedLinks

getLinkAttributes

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields