Initializes new client with specific authentication method.
Authentication object,
containing either client_id
and client_secret
properties (for 2-legged authentication),
or a single token
property (for 2-legged or 3-legged authentication with pre-generated access token).
Finalizes the upload of a file to OSS.
Bucket key.
Object key.
Upload key returned by {@see getUploadUrls}.
Details of the uploaded object in OSS.
Creates a new bucket (docs).
Bucket key.
Data retention policy for objects uploaded to this bucket.
Bucket details, with properties "bucketKey", "bucketOwner", "createdDate", "permissions", and "policyKey".
Creates signed URL for specific object (docs).
Bucket key.
Object key.
Description of the new signed URL resource.
Deletes bucket.
Bucket key.
Deletes object (docs).
Bucket key.
Name of object to delete.
Downloads a specific OSS object.
Bucket key.
Object key.
Object content.
Downloads content stream of a specific bucket object.
Bucket key.
Object name.
Object content stream.
Gets details of a specific bucket (docs).
Bucket key.
Bucket details, with properties "bucketKey", "bucketOwner", "createdDate", "permissions", and "policyKey".
Generates a signed URL that can be used to download a file from OSS.
Bucket key.
Object key.
Download URLs and potentially other helpful information.
Bucket key.
Name of uploaded object.
Resumable session ID.
List of range objects, with each object specifying 'start' and 'end' byte offsets of data that has already been uploaded.
Generates one or more signed URLs that can be used to upload a file (or its parts) to OSS, and an upload key that is used to generate additional URLs or in {@see completeUpload} after all the parts have been uploaded successfully.
The URLs are valid for 60min.
Note that if you are uploading in multiple parts, each part except for the final one must be of size at least 5MB, otherwise the call to {@see completeUpload} will fail.
Bucket key.
Object key.
Signed URLs for uploading chunks of the file to AWS S3 (valid for 60min), and a unique upload key used to generate additional URLs or to complete the upload.
Uploads content to a specific bucket object.
Bucket key.
Name of uploaded object.
Object content.
Object description containing 'bucketKey', 'objectKey', 'objectId', 'sha1', 'size', 'location', and 'contentType'.
Bucket key.
Name of uploaded object.
Object content.
Byte offset of the uploaded blob in the target object.
Total byte size of the target object.
Resumable session ID.
Uploads content stream to a specific bucket object.
Bucket key.
Name of uploaded object.
Object description containing 'bucketKey', 'objectKey', 'objectId', 'sha1', 'size', 'location', and 'contentType'.
Bucket key.
Name of uploaded object.
Object content stream.
Byte size of the stream to be uploaded.
Byte offset of the uploaded blob in the target object.
Total byte size of the target object.
Resumable session ID.
Generated using TypeDoc
Client providing access to APS Data Management API (https://aps.autodesk.com/en/docs/data/v2/reference/http/).
data-management