Interface HeadObjectOptions

Options for getting the head (main metadata, without the content) of an object.

interface HeadObjectOptions {
    bucket: string;
    emptyMeansNotFound?: boolean;
    key: string;
    versionId?: string;
}

Properties

bucket: string

The bucket from which to acquire the file.

emptyMeansNotFound?: boolean

If set, the request will fail in case the object is empty (ContentLength === 0).

key: string

The complete filepath (within the bucket) from which to acquire the file.

versionId?: string

A version of the object, in a versioned bucket; default: the current one.