BatchReadOperation (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.clouddirectory.model.BatchReadOperation

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BatchReadOperation
extends Object
implements Serializable, Cloneable, StructuredPojo

Represents the output of a BatchRead operation.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

BatchReadOperation()

Constructors
Constructor and Description
`BatchReadOperation()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchReadOperation`	`clone()`
`boolean`	`equals(Object obj)`
`BatchGetObjectInformation`	`getGetObjectInformation()` Retrieves metadata about an object.
`BatchListAttachedIndices`	`getListAttachedIndices()` Lists indices attached to an object.
`BatchListIncomingTypedLinks`	`getListIncomingTypedLinks()` Returns a paginated list of all the incoming TypedLinkSpecifier information for an object.
`BatchListIndex`	`getListIndex()` Lists objects attached to the specified index.
`BatchListObjectAttributes`	`getListObjectAttributes()` Lists all attributes that are associated with an object.
`BatchListObjectChildren`	`getListObjectChildren()` Returns a paginated list of child objects that are associated with a given object.
`BatchListObjectParentPaths`	`getListObjectParentPaths()` Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects.
`BatchListObjectPolicies`	`getListObjectPolicies()` Returns policies attached to an object in pagination fashion.
`BatchListOutgoingTypedLinks`	`getListOutgoingTypedLinks()` Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object.
`BatchListPolicyAttachments`	`getListPolicyAttachments()` Returns all of the `ObjectIdentifiers` to which a given policy is attached.
`BatchLookupPolicy`	`getLookupPolicy()` Lists all policies from the root of the Directory to the object specified.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setGetObjectInformation(BatchGetObjectInformation getObjectInformation)` Retrieves metadata about an object.
`void`	`setListAttachedIndices(BatchListAttachedIndices listAttachedIndices)` Lists indices attached to an object.
`void`	`setListIncomingTypedLinks(BatchListIncomingTypedLinks listIncomingTypedLinks)` Returns a paginated list of all the incoming TypedLinkSpecifier information for an object.
`void`	`setListIndex(BatchListIndex listIndex)` Lists objects attached to the specified index.
`void`	`setListObjectAttributes(BatchListObjectAttributes listObjectAttributes)` Lists all attributes that are associated with an object.
`void`	`setListObjectChildren(BatchListObjectChildren listObjectChildren)` Returns a paginated list of child objects that are associated with a given object.
`void`	`setListObjectParentPaths(BatchListObjectParentPaths listObjectParentPaths)` Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects.
`void`	`setListObjectPolicies(BatchListObjectPolicies listObjectPolicies)` Returns policies attached to an object in pagination fashion.
`void`	`setListOutgoingTypedLinks(BatchListOutgoingTypedLinks listOutgoingTypedLinks)` Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object.
`void`	`setListPolicyAttachments(BatchListPolicyAttachments listPolicyAttachments)` Returns all of the `ObjectIdentifiers` to which a given policy is attached.
`void`	`setLookupPolicy(BatchLookupPolicy lookupPolicy)` Lists all policies from the root of the Directory to the object specified.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`BatchReadOperation`	`withGetObjectInformation(BatchGetObjectInformation getObjectInformation)` Retrieves metadata about an object.
`BatchReadOperation`	`withListAttachedIndices(BatchListAttachedIndices listAttachedIndices)` Lists indices attached to an object.
`BatchReadOperation`	`withListIncomingTypedLinks(BatchListIncomingTypedLinks listIncomingTypedLinks)` Returns a paginated list of all the incoming TypedLinkSpecifier information for an object.
`BatchReadOperation`	`withListIndex(BatchListIndex listIndex)` Lists objects attached to the specified index.
`BatchReadOperation`	`withListObjectAttributes(BatchListObjectAttributes listObjectAttributes)` Lists all attributes that are associated with an object.
`BatchReadOperation`	`withListObjectChildren(BatchListObjectChildren listObjectChildren)` Returns a paginated list of child objects that are associated with a given object.
`BatchReadOperation`	`withListObjectParentPaths(BatchListObjectParentPaths listObjectParentPaths)` Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects.
`BatchReadOperation`	`withListObjectPolicies(BatchListObjectPolicies listObjectPolicies)` Returns policies attached to an object in pagination fashion.
`BatchReadOperation`	`withListOutgoingTypedLinks(BatchListOutgoingTypedLinks listOutgoingTypedLinks)` Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object.
`BatchReadOperation`	`withListPolicyAttachments(BatchListPolicyAttachments listPolicyAttachments)` Returns all of the `ObjectIdentifiers` to which a given policy is attached.
`BatchReadOperation`	`withLookupPolicy(BatchLookupPolicy lookupPolicy)` Lists all policies from the root of the Directory to the object specified.

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

- Constructor Detail
  - BatchReadOperation
```
public BatchReadOperation()
```
- Method Detail
  - setListObjectAttributes
```
public void setListObjectAttributes(BatchListObjectAttributes listObjectAttributes)
```
    Lists all attributes that are associated with an object.
    
    Parameters:
    
    listObjectAttributes - Lists all attributes that are associated with an object.
  - getListObjectAttributes
```
public BatchListObjectAttributes getListObjectAttributes()
```
    Lists all attributes that are associated with an object.
    
    Returns:
    
    Lists all attributes that are associated with an object.
  - withListObjectAttributes
```
public BatchReadOperation withListObjectAttributes(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.
  - setListObjectChildren
```
public void setListObjectChildren(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.
  - getListObjectChildren
```
public BatchListObjectChildren getListObjectChildren()
```
    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.
  - withListObjectChildren
```
public BatchReadOperation withListObjectChildren(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.
  - setListAttachedIndices
```
public void setListAttachedIndices(BatchListAttachedIndices listAttachedIndices)
```
    Lists indices attached to an object.
    
    Parameters:
    
    listAttachedIndices - Lists indices attached to an object.
  - getListAttachedIndices
```
public BatchListAttachedIndices getListAttachedIndices()
```
    Lists indices attached to an object.
    
    Returns:
    
    Lists indices attached to an object.
  - withListAttachedIndices
```
public BatchReadOperation withListAttachedIndices(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.
  - setListObjectParentPaths
```
public void setListObjectParentPaths(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.
  - getListObjectParentPaths
```
public BatchListObjectParentPaths getListObjectParentPaths()
```
    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.
  - withListObjectParentPaths
```
public BatchReadOperation withListObjectParentPaths(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.
  - setGetObjectInformation
```
public void setGetObjectInformation(BatchGetObjectInformation getObjectInformation)
```
    Retrieves metadata about an object.
    
    Parameters:
    
    getObjectInformation - Retrieves metadata about an object.
  - getGetObjectInformation
```
public BatchGetObjectInformation getGetObjectInformation()
```
    Retrieves metadata about an object.
    
    Returns:
    
    Retrieves metadata about an object.
  - withGetObjectInformation
```
public BatchReadOperation withGetObjectInformation(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.
  - setListObjectPolicies
```
public void setListObjectPolicies(BatchListObjectPolicies listObjectPolicies)
```
    Returns policies attached to an object in pagination fashion.
    
    Parameters:
    
    listObjectPolicies - Returns policies attached to an object in pagination fashion.
  - getListObjectPolicies
```
public BatchListObjectPolicies getListObjectPolicies()
```
    Returns policies attached to an object in pagination fashion.
    
    Returns:
    
    Returns policies attached to an object in pagination fashion.
  - withListObjectPolicies
```
public BatchReadOperation withListObjectPolicies(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.
  - setListPolicyAttachments
```
public void setListPolicyAttachments(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.
  - getListPolicyAttachments
```
public BatchListPolicyAttachments getListPolicyAttachments()
```
    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.
  - withListPolicyAttachments
```
public BatchReadOperation withListPolicyAttachments(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.
  - setLookupPolicy
```
public void setLookupPolicy(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.
  - getLookupPolicy
```
public BatchLookupPolicy getLookupPolicy()
```
    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.
  - withLookupPolicy
```
public BatchReadOperation withLookupPolicy(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.
  - setListIndex
```
public void setListIndex(BatchListIndex listIndex)
```
    Lists objects attached to the specified index.
    
    Parameters:
    
    listIndex - Lists objects attached to the specified index.
  - getListIndex
```
public BatchListIndex getListIndex()
```
    Lists objects attached to the specified index.
    
    Returns:
    
    Lists objects attached to the specified index.
  - withListIndex
```
public BatchReadOperation withListIndex(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.
  - setListOutgoingTypedLinks
```
public void setListOutgoingTypedLinks(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 link.
    
    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 link.
  - getListOutgoingTypedLinks
```
public BatchListOutgoingTypedLinks getListOutgoingTypedLinks()
```
    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 link.
    
    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 link.
  - withListOutgoingTypedLinks
```
public BatchReadOperation withListOutgoingTypedLinks(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 link.
    
    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 link.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setListIncomingTypedLinks
```
public void setListIncomingTypedLinks(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 link.
    
    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 link.
  - getListIncomingTypedLinks
```
public BatchListIncomingTypedLinks getListIncomingTypedLinks()
```
    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 link.
    
    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 link.
  - withListIncomingTypedLinks
```
public BatchReadOperation withListIncomingTypedLinks(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 link.
    
    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 link.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public BatchReadOperation clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class BatchReadOperation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BatchReadOperation

Method Detail

setListObjectAttributes

getListObjectAttributes

withListObjectAttributes

setListObjectChildren

getListObjectChildren

withListObjectChildren

setListAttachedIndices

getListAttachedIndices

withListAttachedIndices

setListObjectParentPaths

getListObjectParentPaths

withListObjectParentPaths

setGetObjectInformation

getGetObjectInformation

withGetObjectInformation

setListObjectPolicies

getListObjectPolicies

withListObjectPolicies

setListPolicyAttachments

getListPolicyAttachments

withListPolicyAttachments

setLookupPolicy

getLookupPolicy

withLookupPolicy

setListIndex

getListIndex

withListIndex

setListOutgoingTypedLinks

getListOutgoingTypedLinks

withListOutgoingTypedLinks

setListIncomingTypedLinks

getListIncomingTypedLinks

withListIncomingTypedLinks

toString

equals

hashCode

clone

marshall