AbstractAmazonCloudDirectory (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.clouddirectory.AbstractAmazonCloudDirectory

All Implemented Interfaces:

AmazonCloudDirectory

Direct Known Subclasses:

AbstractAmazonCloudDirectoryAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonCloudDirectory
extends Object
implements AmazonCloudDirectory
```
Abstract implementation of AmazonCloudDirectory. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.clouddirectory.AmazonCloudDirectory
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AddFacetToObjectResult`	`addFacetToObject(AddFacetToObjectRequest request)` Adds a new Facet to an object.
`ApplySchemaResult`	`applySchema(ApplySchemaRequest request)` Copies input published schema into Directory with same name and version as that of published schema .
`AttachObjectResult`	`attachObject(AttachObjectRequest request)` Attaches an existing object to another object.
`AttachPolicyResult`	`attachPolicy(AttachPolicyRequest request)` Attaches a policy object to a regular object.
`AttachToIndexResult`	`attachToIndex(AttachToIndexRequest request)` Attaches the specified object to the specified index.
`BatchReadResult`	`batchRead(BatchReadRequest request)` Performs all the read operations in a batch.
`BatchWriteResult`	`batchWrite(BatchWriteRequest request)` Performs all the write operations in a batch.
`CreateDirectoryResult`	`createDirectory(CreateDirectoryRequest request)` Creates a Directory by copying the published schema into the directory.
`CreateFacetResult`	`createFacet(CreateFacetRequest request)` Creates a new Facet in a schema.
`CreateIndexResult`	`createIndex(CreateIndexRequest request)` Creates an index object.
`CreateObjectResult`	`createObject(CreateObjectRequest request)` Creates an object in a Directory.
`CreateSchemaResult`	`createSchema(CreateSchemaRequest request)` Creates a new schema in a development state.
`DeleteDirectoryResult`	`deleteDirectory(DeleteDirectoryRequest request)` Deletes a directory.
`DeleteFacetResult`	`deleteFacet(DeleteFacetRequest request)` Deletes a given Facet.
`DeleteObjectResult`	`deleteObject(DeleteObjectRequest request)` Deletes an object and its associated attributes.
`DeleteSchemaResult`	`deleteSchema(DeleteSchemaRequest request)` Deletes a given schema.
`DetachFromIndexResult`	`detachFromIndex(DetachFromIndexRequest request)` Detaches the specified object from the specified index.
`DetachObjectResult`	`detachObject(DetachObjectRequest request)` Detaches a given object from the parent object.
`DetachPolicyResult`	`detachPolicy(DetachPolicyRequest request)` Detaches a policy from an object.
`DisableDirectoryResult`	`disableDirectory(DisableDirectoryRequest request)` Disables the specified directory.
`EnableDirectoryResult`	`enableDirectory(EnableDirectoryRequest request)` Enables the specified directory.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetDirectoryResult`	`getDirectory(GetDirectoryRequest request)` Retrieves metadata about a directory.
`GetFacetResult`	`getFacet(GetFacetRequest request)` Gets details of the Facet, such as Facet Name, Attributes, Rules, or ObjectType.
`GetObjectInformationResult`	`getObjectInformation(GetObjectInformationRequest request)` Retrieves metadata about an object.
`GetSchemaAsJsonResult`	`getSchemaAsJson(GetSchemaAsJsonRequest request)` Retrieves a JSON representation of the schema.
`ListAppliedSchemaArnsResult`	`listAppliedSchemaArns(ListAppliedSchemaArnsRequest request)` Lists schemas applied to a directory.
`ListAttachedIndicesResult`	`listAttachedIndices(ListAttachedIndicesRequest request)` Lists indices attached to an object.
`ListDevelopmentSchemaArnsResult`	`listDevelopmentSchemaArns(ListDevelopmentSchemaArnsRequest request)` Retrieves the ARNs of schemas in the development state.
`ListDirectoriesResult`	`listDirectories(ListDirectoriesRequest request)` Lists directories created within an account.
`ListFacetAttributesResult`	`listFacetAttributes(ListFacetAttributesRequest request)` Retrieves attributes attached to the facet.
`ListFacetNamesResult`	`listFacetNames(ListFacetNamesRequest request)` Retrieves the names of facets that exist in a schema.
`ListIndexResult`	`listIndex(ListIndexRequest request)` Lists objects attached to the specified index.
`ListObjectAttributesResult`	`listObjectAttributes(ListObjectAttributesRequest request)` Lists all attributes associated with an object.
`ListObjectChildrenResult`	`listObjectChildren(ListObjectChildrenRequest request)` Returns a paginated list of child objects associated with a given object.
`ListObjectParentPathsResult`	`listObjectParentPaths(ListObjectParentPathsRequest request)` Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects.
`ListObjectParentsResult`	`listObjectParents(ListObjectParentsRequest request)` Lists parent objects associated with a given object in pagination fashion.
`ListObjectPoliciesResult`	`listObjectPolicies(ListObjectPoliciesRequest request)` Returns policies attached to an object in pagination fashion.
`ListPolicyAttachmentsResult`	`listPolicyAttachments(ListPolicyAttachmentsRequest request)` Returns all of the `ObjectIdentifiers` to which a given policy is attached.
`ListPublishedSchemaArnsResult`	`listPublishedSchemaArns(ListPublishedSchemaArnsRequest request)` Retrieves published schema ARNs.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Returns tags for a resource.
`LookupPolicyResult`	`lookupPolicy(LookupPolicyRequest request)` Lists all policies from the root of the Directory to the object specified.
`PublishSchemaResult`	`publishSchema(PublishSchemaRequest request)` Publishes a development schema with a version.
`PutSchemaFromJsonResult`	`putSchemaFromJson(PutSchemaFromJsonRequest request)` Allows a schema to be updated using JSON upload.
`RemoveFacetFromObjectResult`	`removeFacetFromObject(RemoveFacetFromObjectRequest request)` Removes the specified facet from the specified object.
`void`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client ("clouddirectory.us-east-1.amazonaws.com").
`void`	`setRegion(Region region)` An alternative to `AmazonCloudDirectory.setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest request)` API for adding tags to a resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` API for removing tags from a resource.
`UpdateFacetResult`	`updateFacet(UpdateFacetRequest request)` Does the following:
`UpdateObjectAttributesResult`	`updateObjectAttributes(UpdateObjectAttributesRequest request)` Updates a given object's attributes.
`UpdateSchemaResult`	`updateSchema(UpdateSchemaRequest request)` Updates the schema name with a new name.

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

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: AmazonCloudDirectory
    
    Overrides the default endpoint for this client ("clouddirectory.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    Callers can pass in just the endpoint (ex: "clouddirectory.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "clouddirectory.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
    This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setEndpoint in interface AmazonCloudDirectory
    
    Parameters:
    
    endpoint - The endpoint (ex: "clouddirectory.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "clouddirectory.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: AmazonCloudDirectory
    
    An alternative to AmazonCloudDirectory.setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.
    By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.
    This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setRegion in interface AmazonCloudDirectory
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - addFacetToObject
```
public AddFacetToObjectResult addFacetToObject(AddFacetToObjectRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Adds a new Facet to an object.
    
    Specified by:
    
    addFacetToObject in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the AddFacetToObject operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - applySchema
```
public ApplySchemaResult applySchema(ApplySchemaRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Copies input published schema into Directory with same name and version as that of published schema .
    
    Specified by:
    
    applySchema in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the ApplySchema operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - attachObject
```
public AttachObjectResult attachObject(AttachObjectRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    Attaches an existing object to another object. An object can be accessed in two ways:
    1. Using the path
    2. Using ObjectIdentifier
    Specified by:
    
    attachObject in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the AttachObject operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - attachPolicy
```
public AttachPolicyResult attachPolicy(AttachPolicyRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Attaches a policy object to a regular object. An object can have a limited number of attached policies.
    
    Specified by:
    
    attachPolicy in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the AttachPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - attachToIndex
```
public AttachToIndexResult attachToIndex(AttachToIndexRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Attaches the specified object to the specified index.
    
    Specified by:
    
    attachToIndex in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the AttachToIndex operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchRead
```
public BatchReadResult batchRead(BatchReadRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Performs all the read operations in a batch.
    
    Specified by:
    
    batchRead in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the BatchRead operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchWrite
```
public BatchWriteResult batchWrite(BatchWriteRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Performs all the write operations in a batch. Either all the operations succeed or none. Batch writes supports only object-related operations.
    
    Specified by:
    
    batchWrite in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the BatchWrite operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDirectory
```
public CreateDirectoryResult createDirectory(CreateDirectoryRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Creates a Directory by copying the published schema into the directory. A directory cannot be created without a schema.
    
    Specified by:
    
    createDirectory in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the CreateDirectory operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createFacet
```
public CreateFacetResult createFacet(CreateFacetRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Creates a new Facet in a schema. Facet creation is allowed only in development or applied schemas.
    
    Specified by:
    
    createFacet in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the CreateFacet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createIndex
```
public CreateIndexResult createIndex(CreateIndexRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Creates an index object. See Indexing for more information.
    
    Specified by:
    
    createIndex in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the CreateIndex operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createObject
```
public CreateObjectResult createObject(CreateObjectRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Creates an object in a Directory. Additionally attaches the object to a parent, if a parent reference and LinkName is specified. An object is simply a collection of Facet attributes. You can also use this API call to create a policy object, if the facet from which you create the object is a policy facet.
    
    Specified by:
    
    createObject in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the CreateObject operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createSchema
```
public CreateSchemaResult createSchema(CreateSchemaRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    Creates a new schema in a development state. A schema can exist in three phases:
    - Development: This is a mutable phase of the schema. All new schemas are in the development phase. Once the schema is finalized, it can be published.
    - Published: Published schemas are immutable and have a version associated with them.
    - Applied: Applied schemas are mutable in a way that allows you to add new schema facets. You can also add new, nonrequired attributes to existing schema facets. You can apply only published schemas to directories.
    Specified by:
    
    createSchema in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the CreateSchema operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteDirectory
```
public DeleteDirectoryResult deleteDirectory(DeleteDirectoryRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories.
    
    Specified by:
    
    deleteDirectory in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the DeleteDirectory operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteFacet
```
public DeleteFacetResult deleteFacet(DeleteFacetRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Deletes a given Facet. All attributes and Rules associated with the facet will be deleted. Only development schema facets are allowed deletion.
    
    Specified by:
    
    deleteFacet in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the DeleteFacet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteObject
```
public DeleteObjectResult deleteObject(DeleteObjectRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Deletes an object and its associated attributes. Only objects with no children and no parents can be deleted.
    
    Specified by:
    
    deleteObject in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the DeleteObject operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteSchema
```
public DeleteSchemaResult deleteSchema(DeleteSchemaRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Deletes a given schema. Schemas in a development and published state can only be deleted.
    
    Specified by:
    
    deleteSchema in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the DeleteSchema operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - detachFromIndex
```
public DetachFromIndexResult detachFromIndex(DetachFromIndexRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Detaches the specified object from the specified index.
    
    Specified by:
    
    detachFromIndex in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the DetachFromIndex operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - detachObject
```
public DetachObjectResult detachObject(DetachObjectRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Detaches a given object from the parent object. The object that is to be detached from the parent is specified by the link name.
    
    Specified by:
    
    detachObject in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the DetachObject operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - detachPolicy
```
public DetachPolicyResult detachPolicy(DetachPolicyRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Detaches a policy from an object.
    
    Specified by:
    
    detachPolicy in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the DetachPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - disableDirectory
```
public DisableDirectoryResult disableDirectory(DisableDirectoryRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled.
    
    Specified by:
    
    disableDirectory in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the DisableDirectory operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - enableDirectory
```
public EnableDirectoryResult enableDirectory(EnableDirectoryRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to.
    
    Specified by:
    
    enableDirectory in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the EnableDirectory operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDirectory
```
public GetDirectoryResult getDirectory(GetDirectoryRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Retrieves metadata about a directory.
    
    Specified by:
    
    getDirectory in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the GetDirectory operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getFacet
```
public GetFacetResult getFacet(GetFacetRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Gets details of the Facet, such as Facet Name, Attributes, Rules, or ObjectType. You can call this on all kinds of schema facets -- published, development, or applied.
    
    Specified by:
    
    getFacet in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the GetFacet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getObjectInformation
```
public GetObjectInformationResult getObjectInformation(GetObjectInformationRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Retrieves metadata about an object.
    
    Specified by:
    
    getObjectInformation in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the GetObjectInformation operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getSchemaAsJson
```
public GetSchemaAsJsonResult getSchemaAsJson(GetSchemaAsJsonRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Retrieves a JSON representation of the schema. See JSON Schema Format for more information.
    
    Specified by:
    
    getSchemaAsJson in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the GetSchemaAsJson operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAppliedSchemaArns
```
public ListAppliedSchemaArnsResult listAppliedSchemaArns(ListAppliedSchemaArnsRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Lists schemas applied to a directory.
    
    Specified by:
    
    listAppliedSchemaArns in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the ListAppliedSchemaArns operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAttachedIndices
```
public ListAttachedIndicesResult listAttachedIndices(ListAttachedIndicesRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Lists indices attached to an object.
    
    Specified by:
    
    listAttachedIndices in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the ListAttachedIndices operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDevelopmentSchemaArns
```
public ListDevelopmentSchemaArnsResult listDevelopmentSchemaArns(ListDevelopmentSchemaArnsRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Retrieves the ARNs of schemas in the development state.
    
    Specified by:
    
    listDevelopmentSchemaArns in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the ListDevelopmentSchemaArns operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDirectories
```
public ListDirectoriesResult listDirectories(ListDirectoriesRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Lists directories created within an account.
    
    Specified by:
    
    listDirectories in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the ListDirectories operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listFacetAttributes
```
public ListFacetAttributesResult listFacetAttributes(ListFacetAttributesRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Retrieves attributes attached to the facet.
    
    Specified by:
    
    listFacetAttributes in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the ListFacetAttributes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listFacetNames
```
public ListFacetNamesResult listFacetNames(ListFacetNamesRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Retrieves the names of facets that exist in a schema.
    
    Specified by:
    
    listFacetNames in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the ListFacetNames operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listIndex
```
public ListIndexResult listIndex(ListIndexRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Lists objects attached to the specified index.
    
    Specified by:
    
    listIndex in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the ListIndex operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listObjectAttributes
```
public ListObjectAttributesResult listObjectAttributes(ListObjectAttributesRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Lists all attributes associated with an object.
    
    Specified by:
    
    listObjectAttributes in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the ListObjectAttributes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listObjectChildren
```
public ListObjectChildrenResult listObjectChildren(ListObjectChildrenRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Returns a paginated list of child objects associated with a given object.
    
    Specified by:
    
    listObjectChildren in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the ListObjectChildren operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listObjectParentPaths
```
public ListObjectParentPathsResult listObjectParentPaths(ListObjectParentPathsRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    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.
    
    Use this API to evaluate all parents for an object. The call returns all objects from the root of the directory up to the requested object. The API returns the number of paths based on user-defined MaxResults, in case there are multiple paths to the parent. The order of the paths and nodes returned is consistent among multiple API calls unless the objects are deleted or moved. Paths not leading to directory root are ignored from the target object.
    
    Specified by:
    
    listObjectParentPaths in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the ListObjectParentPaths operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listObjectParents
```
public ListObjectParentsResult listObjectParents(ListObjectParentsRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Lists parent objects associated with a given object in pagination fashion.
    
    Specified by:
    
    listObjectParents in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the ListObjectParents operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listObjectPolicies
```
public ListObjectPoliciesResult listObjectPolicies(ListObjectPoliciesRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Returns policies attached to an object in pagination fashion.
    
    Specified by:
    
    listObjectPolicies in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the ListObjectPolicies operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listPolicyAttachments
```
public ListPolicyAttachmentsResult listPolicyAttachments(ListPolicyAttachmentsRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Returns all of the ObjectIdentifiers to which a given policy is attached.
    
    Specified by:
    
    listPolicyAttachments in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the ListPolicyAttachments operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listPublishedSchemaArns
```
public ListPublishedSchemaArnsResult listPublishedSchemaArns(ListPublishedSchemaArnsRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Retrieves published schema ARNs.
    
    Specified by:
    
    listPublishedSchemaArns in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the ListPublishedSchemaArns operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Returns tags for a resource. Tagging is currently supported only for directories with a limit of 50 tags per directory. All 50 tags are returned for a given directory with this API call.
    
    Specified by:
    
    listTagsForResource in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - lookupPolicy
```
public LookupPolicyResult lookupPolicy(LookupPolicyRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    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.
    
    Specified by:
    
    lookupPolicy in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the LookupPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - publishSchema
```
public PublishSchemaResult publishSchema(PublishSchemaRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Publishes a development schema with a version. If description and attributes are specified, PublishSchema overrides the development schema description and attributes. If not, the development schema description and attributes are used.
    
    Specified by:
    
    publishSchema in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the PublishSchema operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putSchemaFromJson
```
public PutSchemaFromJsonResult putSchemaFromJson(PutSchemaFromJsonRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Allows a schema to be updated using JSON upload. Only available for development schemas. See JSON Schema Format for more information.
    
    Specified by:
    
    putSchemaFromJson in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the PutSchemaFromJson operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - removeFacetFromObject
```
public RemoveFacetFromObjectResult removeFacetFromObject(RemoveFacetFromObjectRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Removes the specified facet from the specified object.
    
    Specified by:
    
    removeFacetFromObject in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the RemoveFacetFromObject operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    API for adding tags to a resource.
    
    Specified by:
    
    tagResource in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    API for removing tags from a resource.
    
    Specified by:
    
    untagResource in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateFacet
```
public UpdateFacetResult updateFacet(UpdateFacetRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    Does the following:
    1. Adds new Attributes, Rules, or ObjectTypes.
    2. Updates existing Attributes, Rules, or ObjectTypes.
    3. Deletes existing Attributes, Rules, or ObjectTypes.
    Specified by:
    
    updateFacet in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the UpdateFacet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateObjectAttributes
```
public UpdateObjectAttributesResult updateObjectAttributes(UpdateObjectAttributesRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Updates a given object's attributes.
    
    Specified by:
    
    updateObjectAttributes in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the UpdateObjectAttributes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateSchema
```
public UpdateSchemaResult updateSchema(UpdateSchemaRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Updates the schema name with a new name. Only development schema names can be updated.
    
    Specified by:
    
    updateSchema in interface AmazonCloudDirectory
    
    Returns:
    
    Result of the UpdateSchema operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonCloudDirectory
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonCloudDirectory
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonCloudDirectory
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonCloudDirectory
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAmazonCloudDirectory

Field Summary

Fields inherited from interface com.amazonaws.services.clouddirectory.AmazonCloudDirectory

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

addFacetToObject

applySchema

attachObject

attachPolicy

attachToIndex

batchRead

batchWrite

createDirectory

createFacet

createIndex

createObject

createSchema

deleteDirectory

deleteFacet

deleteObject

deleteSchema

detachFromIndex

detachObject

detachPolicy

disableDirectory

enableDirectory

getDirectory

getFacet

getObjectInformation

getSchemaAsJson

listAppliedSchemaArns

listAttachedIndices

listDevelopmentSchemaArns

listDirectories

listFacetAttributes

listFacetNames

listIndex

listObjectAttributes

listObjectChildren

listObjectParentPaths

listObjectParents

listObjectPolicies

listPolicyAttachments

listPublishedSchemaArns

listTagsForResource

lookupPolicy

publishSchema

putSchemaFromJson

removeFacetFromObject

tagResource

untagResource

updateFacet

updateObjectAttributes

updateSchema

shutdown

getCachedResponseMetadata