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

Class BatchReadOperation

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:

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<BatchReadOperation.Builder,BatchReadOperation>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.