Skip to content

Head

Head operations.

Obstore provides two API designs for your convenience.

Method API

obstore.store.ObjectStoreMethods.head 

head(path: str) -> ObjectMeta

Return the metadata for the specified location.

Refer to the documentation for head.

obstore.store.ObjectStoreMethods.head_async async 

head_async(path: str) -> ObjectMeta

Call head asynchronously.

Refer to the documentation for head_async.

Functional API

obstore.head 

head(store: ObjectStore, path: str) -> ObjectMeta

Return the metadata for the specified location.

Parameters:

  • store (ObjectStore) –

    The ObjectStore instance to use.

  • path (str) –

    The path within ObjectStore to retrieve.

Returns:

obstore.head_async async 

head_async(store: ObjectStore, path: str) -> ObjectMeta

Call head asynchronously.

Refer to the documentation for head.