GETOBJECTTORRENT()`¶

About GetObjectTorrent¶

This operation is not supported for directory buckets.

Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're distributing large files.

You can get torrent only for objects that are less than 5 GB in size, and that are not encrypted using server-side encryption with a customer-provided encryption key.

To use GET, you must have READ access to the object.

This functionality is not supported for Amazon S3 on Outposts.

The following action is related to GetObjectTorrent:

GetObject

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

Method Signature¶

METHODS /AWS1/IF_S3~GETOBJECTTORRENT
  IMPORTING
    !IV_BUCKET TYPE /AWS1/S3_BUCKETNAME OPTIONAL
    !IV_KEY TYPE /AWS1/S3_OBJECTKEY OPTIONAL
    !IV_REQUESTPAYER TYPE /AWS1/S3_REQUESTPAYER OPTIONAL
    !IV_EXPECTEDBUCKETOWNER TYPE /AWS1/S3_ACCOUNTID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_s3_getobjtorrentout
  RAISING
    /AWS1/CX_S3_CLIENTEXC
    /AWS1/CX_S3_SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_bucket` `TYPE /AWS1/S3_BUCKETNAME` `/AWS1/S3_BUCKETNAME`¶

The name of the bucket containing the object for which to get the torrent files.

`iv_key` `TYPE /AWS1/S3_OBJECTKEY` `/AWS1/S3_OBJECTKEY`¶

The object key for which to get the information.

Optional arguments:¶

`iv_requestpayer` `TYPE /AWS1/S3_REQUESTPAYER` `/AWS1/S3_REQUESTPAYER`¶

RequestPayer

`iv_expectedbucketowner` `TYPE /AWS1/S3_ACCOUNTID` `/AWS1/S3_ACCOUNTID`¶

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_s3_getobjtorrentout` `/AWS1/CL_S3_GETOBJTORRENTOUT`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->getobjecttorrent(
  iv_bucket = |string|
  iv_expectedbucketowner = |string|
  iv_key = |string|
  iv_requestpayer = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_streamingblob = lo_result->get_body( ).
  lv_requestcharged = lo_result->get_requestcharged( ).
ENDIF.

To retrieve torrent files for an object¶

The following example retrieves torrent files of an object.

DATA(lo_result) = lo_client->getobjecttorrent(
  iv_bucket = |examplebucket|
  iv_key = |HappyFace.jpg|
).

/AWS1/IF_S3=>GETOBJECTTORRENT()¶