SDK for PHP V3

S3TransferManagerConfig
in package

FinalYes

Table of Contents

Constants

DEFAULT_CONCURRENCY  = 5
DEFAULT_MULTIPART_DOWNLOAD_TYPE  = 'part'
DEFAULT_MULTIPART_UPLOAD_THRESHOLD_BYTES  = 16777216
DEFAULT_REQUEST_CHECKSUM_CALCULATION  = 'when_supported'
DEFAULT_RESPONSE_CHECKSUM_VALIDATION  = 'when_supported'
DEFAULT_TARGET_PART_SIZE_BYTES  = 8388608

Methods

__construct()  : mixed
fromArray()  : self
$config: - target_part_size_bytes: (int, default=(8388608 `8MB`)) The minimum part size to be used in a multipart upload/download.
getConcurrency()  : int
getDefaultRegion()  : string|null
getMultipartDownloadType()  : string
getMultipartUploadThresholdBytes()  : int
getRequestChecksumCalculation()  : string
getResponseChecksumValidation()  : string
getTargetPartSizeBytes()  : int
isTrackProgress()  : bool
toArray()  : array<string|int, mixed>

Constants

DEFAULT_CONCURRENCY

public mixed DEFAULT_CONCURRENCY = 5

DEFAULT_MULTIPART_DOWNLOAD_TYPE

public mixed DEFAULT_MULTIPART_DOWNLOAD_TYPE = 'part'

DEFAULT_MULTIPART_UPLOAD_THRESHOLD_BYTES

public mixed DEFAULT_MULTIPART_UPLOAD_THRESHOLD_BYTES = 16777216

DEFAULT_REQUEST_CHECKSUM_CALCULATION

public mixed DEFAULT_REQUEST_CHECKSUM_CALCULATION = 'when_supported'

DEFAULT_RESPONSE_CHECKSUM_VALIDATION

public mixed DEFAULT_RESPONSE_CHECKSUM_VALIDATION = 'when_supported'

DEFAULT_TARGET_PART_SIZE_BYTES

public mixed DEFAULT_TARGET_PART_SIZE_BYTES = 8388608

Methods

__construct()

public __construct(int $targetPartSizeBytes, int $multipartUploadThresholdBytes, string $requestChecksumCalculation, string $responseChecksumValidation, string $multipartDownloadType, int $concurrency, bool $trackProgress, string|null $defaultRegion) : mixed
Parameters
$targetPartSizeBytes : int
$multipartUploadThresholdBytes : int
$requestChecksumCalculation : string
$responseChecksumValidation : string
$multipartDownloadType : string
$concurrency : int
$trackProgress : bool
$defaultRegion : string|null

fromArray()

$config: - target_part_size_bytes: (int, default=(8388608 `8MB`)) The minimum part size to be used in a multipart upload/download.

public static fromArray(array<string|int, mixed> $config) : self
  • multipart_upload_threshold_bytes: (int, default=(16777216 16 MB)) The threshold to decided whether a multipart upload is needed.
  • request_checksum_calculation: (string, default=when_supported) To decide whether a checksum validation will be applied to the response.
  • response_checksum_validation: (string, default=when_supported)
  • multipart_download_type: (string, default='part') The download type to be used in a multipart download.
  • concurrency: (int, default=5) Maximum number of concurrent operations allowed during a multipart upload/download.
  • track_progress: (bool, default=false) To enable progress tracker in a multipart upload/download, and or a directory upload/download operation.
  • default_region: (string, default="us-east-2")
Parameters
$config : array<string|int, mixed>
Return values
self

getConcurrency()

public getConcurrency() : int
Return values
int

getDefaultRegion()

public getDefaultRegion() : string|null
Return values
string|null

getMultipartDownloadType()

public getMultipartDownloadType() : string
Return values
string

getMultipartUploadThresholdBytes()

public getMultipartUploadThresholdBytes() : int
Return values
int

getRequestChecksumCalculation()

public getRequestChecksumCalculation() : string
Return values
string

getResponseChecksumValidation()

public getResponseChecksumValidation() : string
Return values
string

getTargetPartSizeBytes()

public getTargetPartSizeBytes() : int
Return values
int

isTrackProgress()

public isTrackProgress() : bool
Return values
bool

toArray()

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>
<-- modeled_exceptions -->
On this page