Class GetObjectTorrentCommand

Example

Use a bare-bones client and the command you need to make an API call.

import { S3Client, GetObjectTorrentCommand } from "ibm-cos-sdk-v2"; // ES Modules import
// const { S3Client, GetObjectTorrentCommand } = require("ibm-cos-sdk-v2"); // CommonJS import
// import type { S3ClientConfig } from "ibm-cos-sdk-v2";
const config = {}; // type is S3ClientConfig
const client = new S3Client(config);
const input = { // GetObjectTorrentRequest
  Bucket: "STRING_VALUE", // required
  Key: "STRING_VALUE", // required
  RequestPayer: "requester",
  ExpectedBucketOwner: "STRING_VALUE",
};
const command = new GetObjectTorrentCommand(input);
const response = await client.send(command);
// consume or destroy the stream to free the socket.
const bytes = await response.Body.transformToByteArray();
// const str = await response.Body.transformToString();
// response.Body.destroy(); // only applicable to Node.js Readable streams.

// { // GetObjectTorrentOutput
//   Body: "<SdkStream>", // see \@smithy/types -> StreamingBlobPayloadOutputTypes
//   RequestCharged: "requester",
// };

Copy

Example: To retrieve torrent files for an object

// The following example retrieves torrent files of an object.
const input = {
  Bucket: "examplebucket",
  Key: "HappyFace.jpg"
};
const command = new GetObjectTorrentCommand(input);
const response = await client.send(command);
// consume or destroy the stream to free the socket.
const bytes = await response.Body.transformToByteArray();
// const str = await response.Body.transformToString();
// response.Body.destroy(); // only applicable to Node.js Readable streams.

/* response is
{ /* empty */ }
*/
Copy