Documentation

Represents the output of a BatchRead success response operation.

See: newBatchReadSuccessfulResponse smart constructor.

Create a value of BatchReadSuccessfulResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:getLinkAttributes:BatchReadSuccessfulResponse', batchReadSuccessfulResponse_getLinkAttributes - The list of attributes to retrieve from the typed link.

$sel:getObjectAttributes:BatchReadSuccessfulResponse', batchReadSuccessfulResponse_getObjectAttributes - Retrieves attributes within a facet that are associated with an object.

$sel:getObjectInformation:BatchReadSuccessfulResponse', batchReadSuccessfulResponse_getObjectInformation - Retrieves metadata about an object.

$sel:listAttachedIndices:BatchReadSuccessfulResponse', batchReadSuccessfulResponse_listAttachedIndices - Lists indices attached to an object.

$sel:listIncomingTypedLinks:BatchReadSuccessfulResponse', batchReadSuccessfulResponse_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.

$sel:listIndex:BatchReadSuccessfulResponse', batchReadSuccessfulResponse_listIndex - Lists objects attached to the specified index.

$sel:listObjectAttributes:BatchReadSuccessfulResponse', batchReadSuccessfulResponse_listObjectAttributes - Lists all attributes that are associated with an object.

$sel:listObjectChildren:BatchReadSuccessfulResponse', batchReadSuccessfulResponse_listObjectChildren - Returns a paginated list of child objects that are associated with a given object.

$sel:listObjectParentPaths:BatchReadSuccessfulResponse', batchReadSuccessfulResponse_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.

$sel:listObjectParents:BatchReadSuccessfulResponse', batchReadSuccessfulResponse_listObjectParents - The list of parent objects to retrieve.

$sel:listObjectPolicies:BatchReadSuccessfulResponse', batchReadSuccessfulResponse_listObjectPolicies - Returns policies attached to an object in pagination fashion.

$sel:listOutgoingTypedLinks:BatchReadSuccessfulResponse', batchReadSuccessfulResponse_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.

$sel:listPolicyAttachments:BatchReadSuccessfulResponse', batchReadSuccessfulResponse_listPolicyAttachments - Returns all of the ObjectIdentifiers to which a given policy is attached.

$sel:lookupPolicy:BatchReadSuccessfulResponse', batchReadSuccessfulResponse_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.

The list of attributes to retrieve from the typed link.

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

Retrieves metadata about an object.

Lists indices attached to an object.

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.

Lists objects attached to the specified index.

Lists all attributes that are associated with an object.

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

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.

The list of parent objects to retrieve.

Returns policies attached to an object in pagination fashion.

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 all of the ObjectIdentifiers to which a given policy is attached.

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.