files.com 1.1.812 → 1.1.814

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (462) hide show
  1. checksums.yaml +4 -4
  2. data/_VERSION +1 -1
  3. data/doc/Files/APIConnectionError.html +1 -1
  4. data/doc/Files/APIError.html +1 -1
  5. data/doc/Files/AccountAlreadyExistsError.html +1 -1
  6. data/doc/Files/AccountLineItem.html +1 -1
  7. data/doc/Files/AccountOverdueError.html +1 -1
  8. data/doc/Files/Action.html +1 -1
  9. data/doc/Files/ActionLog.html +1 -1
  10. data/doc/Files/ActionNotificationExport.html +1 -1
  11. data/doc/Files/ActionNotificationExportResult.html +1 -1
  12. data/doc/Files/AdditionalAuthenticationRequiredError.html +1 -1
  13. data/doc/Files/AgentNode.html +1 -1
  14. data/doc/Files/AgentNodeConnection.html +1 -1
  15. data/doc/Files/AgentNodeInstance.html +1 -1
  16. data/doc/Files/AgentPushUpdate.html +1 -1
  17. data/doc/Files/AgentPushUpdateBlockedError.html +1 -1
  18. data/doc/Files/AgentUnavailableError.html +1 -1
  19. data/doc/Files/AgentUpgradeRequiredError.html +1 -1
  20. data/doc/Files/AiAssistantPersonality.html +1 -1
  21. data/doc/Files/AiTask.html +1 -1
  22. data/doc/Files/AiTaskCannotBeRunManuallyError.html +1 -1
  23. data/doc/Files/AlreadyCompletedError.html +1 -1
  24. data/doc/Files/Api.html +20 -13
  25. data/doc/Files/ApiClient/RequestLogContext.html +29 -29
  26. data/doc/Files/ApiClient/TransferSettings.html +721 -0
  27. data/doc/Files/ApiClient.html +756 -204
  28. data/doc/Files/ApiKey.html +1 -1
  29. data/doc/Files/ApiKeyIsDisabledError.html +1 -1
  30. data/doc/Files/ApiKeyIsPathRestrictedError.html +1 -1
  31. data/doc/Files/ApiKeyNotFoundError.html +1 -1
  32. data/doc/Files/ApiKeyOnlyForDesktopAppError.html +1 -1
  33. data/doc/Files/ApiKeyOnlyForFileOperationsError.html +1 -1
  34. data/doc/Files/ApiKeyOnlyForMobileAppError.html +1 -1
  35. data/doc/Files/ApiKeyOnlyForOfficeIntegrationError.html +1 -1
  36. data/doc/Files/ApiKeySessionsNotSupportedError.html +1 -1
  37. data/doc/Files/ApiRequestLog.html +1 -1
  38. data/doc/Files/App.html +1 -1
  39. data/doc/Files/As2IncomingMessage.html +1 -1
  40. data/doc/Files/As2OutgoingMessage.html +1 -1
  41. data/doc/Files/As2Partner.html +1 -1
  42. data/doc/Files/As2Station.html +1 -1
  43. data/doc/Files/AttachmentTooLargeError.html +1 -1
  44. data/doc/Files/AuthenticationError.html +1 -1
  45. data/doc/Files/AuthenticationRequiredError.html +1 -1
  46. data/doc/Files/Auto.html +1 -1
  47. data/doc/Files/Automation.html +1 -1
  48. data/doc/Files/AutomationAuthoringSchema.html +1 -1
  49. data/doc/Files/AutomationCannotBeRunManuallyError.html +1 -1
  50. data/doc/Files/AutomationExecutionNode.html +1 -1
  51. data/doc/Files/AutomationLog.html +1 -1
  52. data/doc/Files/AutomationRun.html +1 -1
  53. data/doc/Files/AutomationsUnavailableError.html +1 -1
  54. data/doc/Files/BadRequestError.html +1 -1
  55. data/doc/Files/BandwidthSnapshot.html +1 -1
  56. data/doc/Files/Behavior.html +1 -1
  57. data/doc/Files/BehaviorNotAllowedOnRemoteServerError.html +1 -1
  58. data/doc/Files/BillingInformationHiddenError.html +1 -1
  59. data/doc/Files/BillingPermissionRequiredError.html +1 -1
  60. data/doc/Files/BufferedUploadDisabledForThisDestinationError.html +1 -1
  61. data/doc/Files/Bundle.html +1 -1
  62. data/doc/Files/BundleAction.html +1 -1
  63. data/doc/Files/BundleDownload.html +1 -1
  64. data/doc/Files/BundleMaximumUsesReachedError.html +1 -1
  65. data/doc/Files/BundleNotification.html +1 -1
  66. data/doc/Files/BundleOnlyAllowsPreviewsError.html +1 -1
  67. data/doc/Files/BundleOperationRequiresSubfolderError.html +1 -1
  68. data/doc/Files/BundlePath.html +1 -1
  69. data/doc/Files/BundlePathNotFoundError.html +1 -1
  70. data/doc/Files/BundlePermissionRequiredError.html +1 -1
  71. data/doc/Files/BundleRecipient.html +1 -1
  72. data/doc/Files/BundleRegistration.html +1 -1
  73. data/doc/Files/BundleRegistrationCodeFailedError.html +1 -1
  74. data/doc/Files/BundleRegistrationNotFoundError.html +1 -1
  75. data/doc/Files/CannotAdministerHigherLevelUserError.html +1 -1
  76. data/doc/Files/CannotDownloadDirectoryError.html +1 -1
  77. data/doc/Files/CannotLoginWhileUsingKeyError.html +1 -1
  78. data/doc/Files/CantActForOtherUserError.html +1 -1
  79. data/doc/Files/CantMoveWithMultipleLocationsError.html +1 -1
  80. data/doc/Files/ChatMessage.html +1 -1
  81. data/doc/Files/ChatSession.html +1 -1
  82. data/doc/Files/ChildSiteManagementPolicy.html +1 -1
  83. data/doc/Files/Clickwrap.html +1 -1
  84. data/doc/Files/CodeNotFoundError.html +1 -1
  85. data/doc/Files/ConfigurationLockedPathError.html +1 -1
  86. data/doc/Files/ContactAdminForPasswordChangeHelpError.html +1 -1
  87. data/doc/Files/CouldNotCreateParentError.html +1 -1
  88. data/doc/Files/CustomDomain.html +1 -1
  89. data/doc/Files/DatetimeParseError.html +1 -1
  90. data/doc/Files/DesktopConfigurationProfile.html +1 -1
  91. data/doc/Files/DestinationExistsError.html +1 -1
  92. data/doc/Files/DestinationFolderLimitedError.html +1 -1
  93. data/doc/Files/DestinationParentConflictError.html +1 -1
  94. data/doc/Files/DestinationParentDoesNotExistError.html +1 -1
  95. data/doc/Files/DestinationSameError.html +1 -1
  96. data/doc/Files/DestinationSiteMismatchError.html +1 -1
  97. data/doc/Files/DirectConnectionInfo.html +1 -1
  98. data/doc/Files/DnsRecord.html +1 -1
  99. data/doc/Files/DoesNotSupportSortingError.html +1 -1
  100. data/doc/Files/DuplicateShareRecipientError.html +1 -1
  101. data/doc/Files/EmailIncomingMessage.html +1 -1
  102. data/doc/Files/EmailLog.html +1 -1
  103. data/doc/Files/Error.html +2 -2
  104. data/doc/Files/Errors.html +1 -1
  105. data/doc/Files/EventChannel.html +1 -1
  106. data/doc/Files/EventDeliveryAttempt.html +1 -1
  107. data/doc/Files/EventRecord.html +1 -1
  108. data/doc/Files/EventSubscription.html +1 -1
  109. data/doc/Files/EventTarget.html +1 -1
  110. data/doc/Files/ExavaultApiRequestLog.html +1 -1
  111. data/doc/Files/ExceededRuntimeLimitError.html +1 -1
  112. data/doc/Files/Expectation.html +1 -1
  113. data/doc/Files/ExpectationAlreadyHasOpenWindowError.html +1 -1
  114. data/doc/Files/ExpectationEvaluation.html +1 -1
  115. data/doc/Files/ExpectationIncident.html +1 -1
  116. data/doc/Files/ExpectationNotManualTriggerError.html +1 -1
  117. data/doc/Files/ExpiredPrivateKeyError.html +1 -1
  118. data/doc/Files/ExpiredPublicKeyError.html +1 -1
  119. data/doc/Files/ExportFailureError.html +1 -1
  120. data/doc/Files/ExportNotReadyError.html +1 -1
  121. data/doc/Files/ExternalEvent.html +1 -1
  122. data/doc/Files/FailedToChangePasswordError.html +1 -1
  123. data/doc/Files/File.html +2019 -1515
  124. data/doc/Files/FileAction.html +1 -1
  125. data/doc/Files/FileActionError.html +1 -1
  126. data/doc/Files/FileComment.html +1 -1
  127. data/doc/Files/FileCommentReaction.html +1 -1
  128. data/doc/Files/FileLockedError.html +1 -1
  129. data/doc/Files/FileMigration.html +1 -1
  130. data/doc/Files/FileMigrationLog.html +1 -1
  131. data/doc/Files/FileNotFoundError.html +1 -1
  132. data/doc/Files/FileNotUploadedError.html +1 -1
  133. data/doc/Files/FilePendingProcessingError.html +1 -1
  134. data/doc/Files/FileProcessingErrorError.html +1 -1
  135. data/doc/Files/FileTooBigToDecryptError.html +1 -1
  136. data/doc/Files/FileTooBigToEncryptError.html +1 -1
  137. data/doc/Files/FileUploadNotFoundError.html +1 -1
  138. data/doc/Files/FileUploadPart.html +1 -1
  139. data/doc/Files/FileUploadedToWrongRegionError.html +1 -1
  140. data/doc/Files/FileUtils.html +1 -1
  141. data/doc/Files/FilenameTooLongError.html +1 -1
  142. data/doc/Files/FilesAgentFailedAuthorizationError.html +1 -1
  143. data/doc/Files/FilesNativeStorageOverloadedError.html +1 -1
  144. data/doc/Files/Folder.html +1 -1
  145. data/doc/Files/FolderAdminOrBillingPermissionRequiredError.html +1 -1
  146. data/doc/Files/FolderAdminPermissionRequiredError.html +1 -1
  147. data/doc/Files/FolderLockedError.html +1 -1
  148. data/doc/Files/FolderMustNotBeAFileError.html +1 -1
  149. data/doc/Files/FolderNotEmptyError.html +1 -1
  150. data/doc/Files/FoldersNotAllowedError.html +1 -1
  151. data/doc/Files/FormField.html +1 -1
  152. data/doc/Files/FormFieldSet.html +1 -1
  153. data/doc/Files/FtpActionLog.html +1 -1
  154. data/doc/Files/FullPermissionRequiredError.html +1 -1
  155. data/doc/Files/GpgKey.html +1 -1
  156. data/doc/Files/Group.html +1 -1
  157. data/doc/Files/GroupNotFoundError.html +1 -1
  158. data/doc/Files/GroupUser.html +1 -1
  159. data/doc/Files/History.html +1 -1
  160. data/doc/Files/HistoryExport.html +1 -1
  161. data/doc/Files/HistoryExportResult.html +1 -1
  162. data/doc/Files/HistoryPermissionRequiredError.html +1 -1
  163. data/doc/Files/HistoryUnavailableError.html +1 -1
  164. data/doc/Files/HolidayCalendar.html +1 -1
  165. data/doc/Files/HolidayRegion.html +1 -1
  166. data/doc/Files/Image.html +1 -1
  167. data/doc/Files/InAppAiAssistantUnavailableError.html +1 -1
  168. data/doc/Files/InboundS3Log.html +1 -1
  169. data/doc/Files/InboxNotFoundError.html +1 -1
  170. data/doc/Files/InboxRecipient.html +1 -1
  171. data/doc/Files/InboxRegistration.html +1 -1
  172. data/doc/Files/InboxRegistrationCodeFailedError.html +1 -1
  173. data/doc/Files/InboxUpload.html +1 -1
  174. data/doc/Files/InsufficientPermissionForParamsError.html +1 -1
  175. data/doc/Files/InsufficientPermissionForSiteError.html +1 -1
  176. data/doc/Files/IntegrationCentricProfile.html +1 -1
  177. data/doc/Files/InternalGeneralErrorError.html +1 -1
  178. data/doc/Files/InvalidBodyError.html +1 -1
  179. data/doc/Files/InvalidBundleCodeError.html +1 -1
  180. data/doc/Files/InvalidCredentialsError.html +1 -1
  181. data/doc/Files/InvalidCursorError.html +1 -1
  182. data/doc/Files/InvalidCursorTypeForSortError.html +1 -1
  183. data/doc/Files/InvalidEtagsError.html +1 -1
  184. data/doc/Files/InvalidFileTypeError.html +1 -1
  185. data/doc/Files/InvalidFilenameError.html +1 -1
  186. data/doc/Files/InvalidFilterAliasCombinationError.html +1 -1
  187. data/doc/Files/InvalidFilterFieldError.html +1 -1
  188. data/doc/Files/InvalidFilterParamError.html +1 -1
  189. data/doc/Files/InvalidFilterParamFormatError.html +1 -1
  190. data/doc/Files/InvalidFilterParamValueError.html +1 -1
  191. data/doc/Files/InvalidInputEncodingError.html +1 -1
  192. data/doc/Files/InvalidInterfaceError.html +1 -1
  193. data/doc/Files/InvalidOauthError.html +1 -1
  194. data/doc/Files/InvalidOauthProviderError.html +1 -1
  195. data/doc/Files/InvalidOrExpiredCodeError.html +1 -1
  196. data/doc/Files/InvalidParameterError.html +5 -1
  197. data/doc/Files/InvalidPathError.html +1 -1
  198. data/doc/Files/InvalidPriorityColorError.html +1 -1
  199. data/doc/Files/InvalidRangeError.html +1 -1
  200. data/doc/Files/InvalidReturnToUrlError.html +1 -1
  201. data/doc/Files/InvalidSearchQueryError.html +1 -1
  202. data/doc/Files/InvalidSessionError.html +1 -1
  203. data/doc/Files/InvalidSiteError.html +1 -1
  204. data/doc/Files/InvalidSortFieldError.html +1 -1
  205. data/doc/Files/InvalidSortFilterCombinationError.html +1 -1
  206. data/doc/Files/InvalidUploadOffsetError.html +1 -1
  207. data/doc/Files/InvalidUploadPartGapError.html +1 -1
  208. data/doc/Files/InvalidUploadPartSizeError.html +1 -1
  209. data/doc/Files/InvalidUsernameOrPasswordError.html +1 -1
  210. data/doc/Files/InvalidWorkspaceIdHeaderError.html +1 -1
  211. data/doc/Files/InvalidZipFileError.html +1 -1
  212. data/doc/Files/Invoice.html +1 -1
  213. data/doc/Files/InvoiceLineItem.html +1 -1
  214. data/doc/Files/IpAddress.html +1 -1
  215. data/doc/Files/KeyLifecycleRule.html +1 -1
  216. data/doc/Files/List.html +1 -1
  217. data/doc/Files/Lock.html +1 -1
  218. data/doc/Files/LockOperationBusyError.html +1 -1
  219. data/doc/Files/LockedOutError.html +1 -1
  220. data/doc/Files/LockoutRegionMismatchError.html +1 -1
  221. data/doc/Files/MetadataCategory.html +1 -1
  222. data/doc/Files/MetadataNotSupportedOnRemotesError.html +1 -1
  223. data/doc/Files/MethodNotAllowedError.html +1 -1
  224. data/doc/Files/MigrationInProgressError.html +1 -1
  225. data/doc/Files/MissingParameterError.html +1 -1
  226. data/doc/Files/ModelSaveErrorError.html +1 -1
  227. data/doc/Files/MoverAccessDeniedError.html +1 -1
  228. data/doc/Files/MoverPackageRequiredError.html +1 -1
  229. data/doc/Files/MultipleProcessingErrorsError.html +1 -1
  230. data/doc/Files/MultipleSortParamsNotAllowedError.html +1 -1
  231. data/doc/Files/MustAuthenticateWithApiKeyError.html +1 -1
  232. data/doc/Files/NeedAdminPermissionForInboxError.html +1 -1
  233. data/doc/Files/NestedNotFoundError.html +1 -1
  234. data/doc/Files/NoAccountForSiteError.html +1 -1
  235. data/doc/Files/NoValidInputParamsError.html +1 -1
  236. data/doc/Files/NonAdminsMustQueryByFolderOrPathError.html +1 -1
  237. data/doc/Files/NotAllowedToCreateBundleError.html +1 -1
  238. data/doc/Files/NotAuthenticatedError.html +1 -1
  239. data/doc/Files/NotAuthorizedError.html +1 -1
  240. data/doc/Files/NotEnqueuableSyncError.html +1 -1
  241. data/doc/Files/NotFoundError.html +1 -1
  242. data/doc/Files/NotImplementedError.html +1 -1
  243. data/doc/Files/Notification.html +1 -1
  244. data/doc/Files/OffsetUploadNotAllowedWithMalwareScanningError.html +1 -1
  245. data/doc/Files/OneTimePasswordIncorrectError.html +1 -1
  246. data/doc/Files/OutboundConnectionLog.html +1 -1
  247. data/doc/Files/PartNumberTooLargeError.html +1 -1
  248. data/doc/Files/Partner.html +1 -1
  249. data/doc/Files/PartnerChannel.html +1 -1
  250. data/doc/Files/PartnerChannelTemplate.html +1 -1
  251. data/doc/Files/PartnerConnection.html +1 -1
  252. data/doc/Files/PartnerSite.html +1 -1
  253. data/doc/Files/PartnerSiteRequest.html +1 -1
  254. data/doc/Files/PasswordChangeNotRequiredError.html +1 -1
  255. data/doc/Files/PasswordChangeRequiredError.html +1 -1
  256. data/doc/Files/PathCannotHaveTrailingWhitespaceError.html +1 -1
  257. data/doc/Files/PathTooLongError.html +1 -1
  258. data/doc/Files/PathUtil.html +1 -1
  259. data/doc/Files/Payment.html +1 -1
  260. data/doc/Files/PaymentLineItem.html +1 -1
  261. data/doc/Files/PaymentMethodErrorError.html +1 -1
  262. data/doc/Files/PendingWorkEvent.html +1 -1
  263. data/doc/Files/Permission.html +1 -1
  264. data/doc/Files/PlanNotFoundError.html +1 -1
  265. data/doc/Files/Preview.html +1 -1
  266. data/doc/Files/PreviewOnlyPermissionCannotDownloadError.html +1 -1
  267. data/doc/Files/ProcessingFailureError.html +1 -1
  268. data/doc/Files/PublicHostingRequestLog.html +1 -1
  269. data/doc/Files/PublicIpAddress.html +1 -1
  270. data/doc/Files/PublicKey.html +1 -1
  271. data/doc/Files/RateLimitedError.html +1 -1
  272. data/doc/Files/ReadOnlySessionError.html +1 -1
  273. data/doc/Files/ReadPermissionRequiredError.html +1 -1
  274. data/doc/Files/ReauthenticationFailedError.html +1 -1
  275. data/doc/Files/ReauthenticationFailedFinalError.html +1 -1
  276. data/doc/Files/ReauthenticationNeededActionError.html +1 -1
  277. data/doc/Files/ReauthenticationNeededFieldsError.html +1 -1
  278. data/doc/Files/ReauthenticationRateLimitedError.html +1 -1
  279. data/doc/Files/RecaptchaFailedError.html +1 -1
  280. data/doc/Files/RecipientAlreadySharedError.html +1 -1
  281. data/doc/Files/RemoteBandwidthSnapshot.html +1 -1
  282. data/doc/Files/RemoteDesktopDebugLoggingDisabledError.html +1 -1
  283. data/doc/Files/RemoteEntryReadOnlyError.html +1 -1
  284. data/doc/Files/RemoteMountBackend.html +1 -1
  285. data/doc/Files/RemoteServer.html +1 -1
  286. data/doc/Files/RemoteServerConfigurationFile.html +1 -1
  287. data/doc/Files/RemoteServerCredential.html +1 -1
  288. data/doc/Files/RemoteServerErrorError.html +1 -1
  289. data/doc/Files/Request.html +1 -1
  290. data/doc/Files/RequestBodyTooLargeError.html +1 -1
  291. data/doc/Files/RequestParamsContainInvalidCharacterError.html +1 -1
  292. data/doc/Files/RequestParamsInvalidError.html +1 -1
  293. data/doc/Files/RequestParamsRequiredError.html +1 -1
  294. data/doc/Files/ResourceBelongsToParentSiteError.html +1 -1
  295. data/doc/Files/ResourceLockedError.html +1 -1
  296. data/doc/Files/Response.html +1 -1
  297. data/doc/Files/Restore.html +1 -1
  298. data/doc/Files/RootFolderBehaviorSiteAdminRequiredError.html +1 -1
  299. data/doc/Files/RootFolderBehaviorSkipSiteAdminRequiredError.html +1 -1
  300. data/doc/Files/Schedule.html +1 -1
  301. data/doc/Files/ScheduledExport.html +1 -1
  302. data/doc/Files/ScimLog.html +1 -1
  303. data/doc/Files/SearchAllOnChildPathError.html +1 -1
  304. data/doc/Files/SearchUnavailableError.html +1 -1
  305. data/doc/Files/Secret.html +1 -1
  306. data/doc/Files/SelfManagedRequiredError.html +1 -1
  307. data/doc/Files/ServiceUnavailableError.html +1 -1
  308. data/doc/Files/Session.html +1 -1
  309. data/doc/Files/SettingsChange.html +1 -1
  310. data/doc/Files/SftpActionLog.html +1 -1
  311. data/doc/Files/SftpHostKey.html +1 -1
  312. data/doc/Files/ShareGroup.html +1 -1
  313. data/doc/Files/ShareGroupMember.html +1 -1
  314. data/doc/Files/SiemHttpDestination.html +1 -1
  315. data/doc/Files/SiemHttpDestinationEvent.html +1 -1
  316. data/doc/Files/Site.html +1 -1
  317. data/doc/Files/SiteAdminOrPartnerAdminPermissionRequiredError.html +1 -1
  318. data/doc/Files/SiteAdminOrWorkspaceAdminOrFolderAdminPermissionRequiredError.html +1 -1
  319. data/doc/Files/SiteAdminOrWorkspaceAdminOrPartnerAdminOrFolderAdminPermissionRequiredError.html +1 -1
  320. data/doc/Files/SiteAdminOrWorkspaceAdminOrPartnerAdminPermissionRequiredError.html +1 -1
  321. data/doc/Files/SiteAdminOrWorkspaceAdminPermissionRequiredError.html +1 -1
  322. data/doc/Files/SiteAdminRequiredError.html +1 -1
  323. data/doc/Files/SiteConfigurationError.html +1 -1
  324. data/doc/Files/SiteDisabledError.html +1 -1
  325. data/doc/Files/SiteFilesAreImmutableError.html +1 -1
  326. data/doc/Files/SiteNotFoundError.html +1 -1
  327. data/doc/Files/SiteSubdomainRedirect.html +1 -1
  328. data/doc/Files/SiteWasRemovedError.html +1 -1
  329. data/doc/Files/SizableIO.html +43 -41
  330. data/doc/Files/Snapshot.html +1 -1
  331. data/doc/Files/SsoEvent.html +1 -1
  332. data/doc/Files/SsoStrategy.html +1 -1
  333. data/doc/Files/Status.html +1 -1
  334. data/doc/Files/Style.html +1 -1
  335. data/doc/Files/SubfolderLockedError.html +1 -1
  336. data/doc/Files/Sync.html +1 -1
  337. data/doc/Files/SyncInProgressError.html +1 -1
  338. data/doc/Files/SyncLog.html +1 -1
  339. data/doc/Files/SyncRun.html +1 -1
  340. data/doc/Files/SyncRunLiveTransfer.html +1 -1
  341. data/doc/Files/SystemProfiler.html +1 -1
  342. data/doc/Files/TooManyConcurrentLoginsError.html +1 -1
  343. data/doc/Files/TooManyConcurrentRequestsError.html +1 -1
  344. data/doc/Files/TooManyLoginAttemptsError.html +1 -1
  345. data/doc/Files/TooManyRequestsError.html +1 -1
  346. data/doc/Files/TooManySharesError.html +1 -1
  347. data/doc/Files/Transfer/BufferLimitError.html +175 -0
  348. data/doc/Files/Transfer/ByteBudget/Reservation.html +301 -0
  349. data/doc/Files/Transfer/ByteBudget.html +748 -0
  350. data/doc/Files/Transfer/CancelledError.html +235 -0
  351. data/doc/Files/Transfer/Checkpoint.html +1371 -0
  352. data/doc/Files/Transfer/CheckpointError.html +173 -0
  353. data/doc/Files/Transfer/ClientTransport/ClientResponse.html +661 -0
  354. data/doc/Files/Transfer/ClientTransport/Reader.html +530 -0
  355. data/doc/Files/Transfer/ClientTransport.html +675 -0
  356. data/doc/Files/Transfer/Clock.html +189 -0
  357. data/doc/Files/Transfer/Control.html +667 -0
  358. data/doc/Files/Transfer/Controller/Attempt.html +465 -0
  359. data/doc/Files/Transfer/Controller.html +1166 -0
  360. data/doc/Files/Transfer/Coordinator/Timing.html +568 -0
  361. data/doc/Files/Transfer/Coordinator.html +534 -0
  362. data/doc/Files/Transfer/DownloadCoordinator/FileSink.html +976 -0
  363. data/doc/Files/Transfer/DownloadCoordinator/IoSink.html +1168 -0
  364. data/doc/Files/Transfer/DownloadCoordinator/Piece.html +875 -0
  365. data/doc/Files/Transfer/DownloadCoordinator.html +728 -0
  366. data/doc/Files/Transfer/FileSlots.html +480 -0
  367. data/doc/Files/Transfer/FrontendResponseError.html +235 -0
  368. data/doc/Files/Transfer/Holds.html +505 -0
  369. data/doc/Files/Transfer/HttpTransport.html +579 -0
  370. data/doc/Files/Transfer/Job.html +2338 -0
  371. data/doc/Files/Transfer/Options.html +924 -0
  372. data/doc/Files/Transfer/PausedError.html +319 -0
  373. data/doc/Files/Transfer/Policy.html +1642 -0
  374. data/doc/Files/Transfer/RequestPermits.html +160 -0
  375. data/doc/Files/Transfer/SourceChangedError.html +235 -0
  376. data/doc/Files/Transfer/StorageResponse.html +546 -0
  377. data/doc/Files/Transfer/StorageRetry.html +1098 -0
  378. data/doc/Files/Transfer/UploadCoordinator/Grant.html +1048 -0
  379. data/doc/Files/Transfer/UploadCoordinator/Part.html +1048 -0
  380. data/doc/Files/Transfer/UploadCoordinator/Region.html +295 -0
  381. data/doc/Files/Transfer/UploadCoordinator/Segments.html +299 -0
  382. data/doc/Files/Transfer/UploadCoordinator/Source.html +725 -0
  383. data/doc/Files/Transfer/UploadCoordinator/StreamSource.html +664 -0
  384. data/doc/Files/Transfer/UploadCoordinator.html +546 -0
  385. data/doc/Files/Transfer/UploadPlan.html +522 -0
  386. data/doc/Files/Transfer/VersionChangedError.html +235 -0
  387. data/doc/Files/Transfer.html +134 -0
  388. data/doc/Files/TrialExpiredError.html +1 -1
  389. data/doc/Files/TrialLockedError.html +1 -1
  390. data/doc/Files/TwoFactorAuthenticationCodeAlreadySentError.html +1 -1
  391. data/doc/Files/TwoFactorAuthenticationCountryBlacklistedError.html +1 -1
  392. data/doc/Files/TwoFactorAuthenticationErrorError.html +1 -1
  393. data/doc/Files/TwoFactorAuthenticationGeneralErrorError.html +1 -1
  394. data/doc/Files/TwoFactorAuthenticationMethodUnsupportedErrorError.html +1 -1
  395. data/doc/Files/TwoFactorAuthenticationRequiredError.html +1 -1
  396. data/doc/Files/TwoFactorAuthenticationSetupExpiredError.html +1 -1
  397. data/doc/Files/TwoFactorAuthenticationUnsubscribedRecipientError.html +1 -1
  398. data/doc/Files/URI.html +1 -1
  399. data/doc/Files/UnrecognizedSortIndexError.html +1 -1
  400. data/doc/Files/UnsupportedCurrencyError.html +1 -1
  401. data/doc/Files/UnsupportedHttpResponseFormatError.html +1 -1
  402. data/doc/Files/UnsupportedMediaTypeError.html +1 -1
  403. data/doc/Files/UpdatesNotAllowedForRemotesError.html +1 -1
  404. data/doc/Files/UploadsUnavailableError.html +1 -1
  405. data/doc/Files/UsageByTopLevelDir.html +1 -1
  406. data/doc/Files/UsageDailySnapshot.html +1 -1
  407. data/doc/Files/UsageSnapshot.html +1 -1
  408. data/doc/Files/User.html +1 -1
  409. data/doc/Files/UserAdditionalEmailRecipient.html +1 -1
  410. data/doc/Files/UserCipherUse.html +1 -1
  411. data/doc/Files/UserIdInvalidError.html +1 -1
  412. data/doc/Files/UserIdOnUserEndpointError.html +1 -1
  413. data/doc/Files/UserIdWithoutSiteAdminError.html +1 -1
  414. data/doc/Files/UserLifecycleRule.html +1 -1
  415. data/doc/Files/UserNotFoundError.html +1 -1
  416. data/doc/Files/UserRequest.html +1 -1
  417. data/doc/Files/UserRequestsEnabledRequiredError.html +1 -1
  418. data/doc/Files/UserRequiredError.html +1 -1
  419. data/doc/Files/UserSecurityEvent.html +1 -1
  420. data/doc/Files/UserSftpClientUse.html +1 -1
  421. data/doc/Files/Util/LogSettings.html +1 -1
  422. data/doc/Files/Util.html +1 -1
  423. data/doc/Files/WebDavActionLog.html +1 -1
  424. data/doc/Files/WebhookTest.html +1 -1
  425. data/doc/Files/Workspace.html +1 -1
  426. data/doc/Files/WriteAndBundlePermissionRequiredError.html +1 -1
  427. data/doc/Files/WritePermissionRequiredError.html +1 -1
  428. data/doc/Files/ZipListEntry.html +1 -1
  429. data/doc/Files.html +116 -116
  430. data/doc/_index.html +314 -4
  431. data/doc/class_list.html +1 -1
  432. data/doc/file.README.html +1 -1
  433. data/doc/index.html +1 -1
  434. data/doc/method_list.html +4703 -2415
  435. data/doc/top-level-namespace.html +1 -1
  436. data/docs/file.md +346 -0
  437. data/lib/files.com/api.rb +6 -1
  438. data/lib/files.com/api_client.rb +220 -32
  439. data/lib/files.com/models/file.rb +124 -17
  440. data/lib/files.com/sizable_io.rb +1 -0
  441. data/lib/files.com/transfer/budgets.rb +123 -0
  442. data/lib/files.com/transfer/checkpoint.rb +113 -0
  443. data/lib/files.com/transfer/clock.rb +14 -0
  444. data/lib/files.com/transfer/controller.rb +549 -0
  445. data/lib/files.com/transfer/download_coordinator.rb +906 -0
  446. data/lib/files.com/transfer/errors.rb +100 -0
  447. data/lib/files.com/transfer/http_transport.rb +337 -0
  448. data/lib/files.com/transfer/job.rb +778 -0
  449. data/lib/files.com/transfer/options.rb +126 -0
  450. data/lib/files.com/transfer/policy.rb +91 -0
  451. data/lib/files.com/transfer/storage_retry.rb +169 -0
  452. data/lib/files.com/transfer/upload_coordinator.rb +657 -0
  453. data/lib/files.com/transfer/upload_plan.rb +157 -0
  454. data/lib/files.com.rb +13 -0
  455. data/spec/lib/api_client_spec.rb +125 -3
  456. data/spec/models/file_transfer_spec.rb +70 -4
  457. data/spec/support/transfer_server.rb +113 -14
  458. data/spec/transfer/adaptive_download_spec.rb +1102 -0
  459. data/spec/transfer/adaptive_upload_spec.rb +1602 -0
  460. data/spec/transfer/concurrency_controller_spec.rb +382 -0
  461. data/spec/workspace_id_spec.rb +19 -14
  462. metadata +59 -1
data/doc/Files/Transfer/Policy.html ADDED
@@ -0,0 +1,1642 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: Files::Transfer::Policy
8
+
9
+ &mdash; Documentation by YARD 0.9.45
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css">
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css">
16
+
17
+ <script type="text/javascript">
18
+ pathId = "Files::Transfer::Policy";
19
+ relpath = '../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div id="main_progress" aria-hidden="true"></div>
31
+
32
+ <div class="nav_wrap">
33
+ <iframe id="nav" src="../../class_list.html?1"></iframe>
34
+ <div id="resizer"></div>
35
+ </div>
36
+
37
+ <div id="main" tabindex="-1">
38
+ <div id="header">
39
+ <div id="menu">
40
+
41
+ <a href="../../_index.html">Index (P)</a> &raquo;
42
+ <span class='title'><span class='object_link'><a href="../../Files.html" title="Files (module)">Files</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Transfer.html" title="Files::Transfer (module)">Transfer</a></span></span>
43
+ &raquo;
44
+ <span class="title">Policy</span>
45
+
46
+ </div>
47
+
48
+ <div id="search">
49
+
50
+ <a class="full_list_link" id="class_list_link"
51
+ href="../../class_list.html">
52
+
53
+ <svg width="24" height="24">
54
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
55
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
56
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
57
+ </svg>
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <div id="content"><h1>Class: Files::Transfer::Policy
65
+
66
+
67
+
68
+ </h1>
69
+ <div class="box_info">
70
+
71
+ <dl>
72
+ <dt>Inherits:</dt>
73
+ <dd>
74
+ <span class="inheritName">Object</span>
75
+
76
+ <ul class="fullTree">
77
+ <li>Object</li>
78
+
79
+ <li class="next">Files::Transfer::Policy</li>
80
+
81
+ </ul>
82
+ <a href="#" class="inheritanceTree">show all</a>
83
+
84
+ </dd>
85
+ </dl>
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+ <dl>
98
+ <dt>Defined in:</dt>
99
+ <dd>lib/files.com/transfer/policy.rb
100
+ </dd>
101
+ </dl>
102
+
103
+ </div>
104
+
105
+ <h2>Overview</h2><div class="docstring">
106
+ <div class="discussion">
107
+ <p>The numbers a Controller works within for one kind of destination. Every count is capped at max, so a caller's
108
+ max_concurrency, or a fixed concurrency, always dominates.</p>
109
+
110
+ </div>
111
+ </div>
112
+ <div class="tags">
113
+
114
+
115
+ </div>
116
+
117
+ <h2>
118
+ Constant Summary
119
+ <small><a href="#" class="constants_summary_toggle">collapse</a></small>
120
+ </h2>
121
+
122
+ <dl class="constants">
123
+
124
+ <dt id="MIB-constant" class="">MIB =
125
+
126
+ </dt>
127
+ <dd><pre class="code"><span class='int'>1024</span> <span class='op'>*</span> <span class='int'>1024</span></pre></dd>
128
+
129
+ <dt id="FAST_LINK_BYTES_PER_SECOND-constant" class="">FAST_LINK_BYTES_PER_SECOND =
130
+ <div class="docstring">
131
+ <div class="discussion">
132
+ <p>A warm-start window at least this fast ends an upload's warm start at the start concurrency.</p>
133
+
134
+ </div>
135
+ </div>
136
+ <div class="tags">
137
+
138
+
139
+ </div>
140
+ </dt>
141
+ <dd><pre class="code"><span class='int'>96</span> <span class='op'>*</span> <span class='const'><span class='object_link'><a href="#MIB-constant" title="Files::Transfer::Policy::MIB (constant)">MIB</a></span></span></pre></dd>
142
+
143
+ <dt id="ELIGIBLE_OCCUPANCY-constant" class="">ELIGIBLE_OCCUPANCY =
144
+ <div class="docstring">
145
+ <div class="discussion">
146
+ <p>A window is judged only when its requests in flight averaged at least this share of the limit.</p>
147
+
148
+ </div>
149
+ </div>
150
+ <div class="tags">
151
+
152
+
153
+ </div>
154
+ </dt>
155
+ <dd><pre class="code"><span class='float'>0.75</span></pre></dd>
156
+
157
+ <dt id="FAILURE_SHRINK-constant" class="">FAILURE_SHRINK =
158
+ <div class="docstring">
159
+ <div class="discussion">
160
+ <p>A failure, a throttle and a growing queue shrink the limit by these shares, once per epoch.</p>
161
+
162
+ </div>
163
+ </div>
164
+ <div class="tags">
165
+
166
+
167
+ </div>
168
+ </dt>
169
+ <dd><pre class="code"><span class='float'>0.35</span></pre></dd>
170
+
171
+ <dt id="THROTTLE_SHRINK-constant" class="">THROTTLE_SHRINK =
172
+
173
+ </dt>
174
+ <dd><pre class="code"><span class='float'>0.10</span></pre></dd>
175
+
176
+ <dt id="LATENCY_SHRINK-constant" class="">LATENCY_SHRINK =
177
+
178
+ </dt>
179
+ <dd><pre class="code"><span class='float'>0.08</span></pre></dd>
180
+
181
+ <dt id="PROBE_GAIN-constant" class="">PROBE_GAIN =
182
+ <div class="docstring">
183
+ <div class="discussion">
184
+ <p>A probe is kept when a window's throughput beats the one before it by this share, and given up after this many
185
+ windows that do not; the limit then holds for HOLD_WINDOWS windows.</p>
186
+
187
+ </div>
188
+ </div>
189
+ <div class="tags">
190
+
191
+
192
+ </div>
193
+ </dt>
194
+ <dd><pre class="code"><span class='float'>0.01</span></pre></dd>
195
+
196
+ <dt id="PROBE_WINDOWS-constant" class="">PROBE_WINDOWS =
197
+
198
+ </dt>
199
+ <dd><pre class="code"><span class='int'>2</span></pre></dd>
200
+
201
+ <dt id="HOLD_WINDOWS-constant" class="">HOLD_WINDOWS =
202
+
203
+ </dt>
204
+ <dd><pre class="code"><span class='int'>1</span></pre></dd>
205
+
206
+ <dt id="GROWTH_INTERVAL_WINDOWS-constant" class="">GROWTH_INTERVAL_WINDOWS =
207
+ <div class="docstring">
208
+ <div class="discussion">
209
+ <p>After a rejected warm-start probe, the windows to rest before probing again by one.</p>
210
+
211
+ </div>
212
+ </div>
213
+ <div class="tags">
214
+
215
+
216
+ </div>
217
+ </dt>
218
+ <dd><pre class="code"><span class='int'>1</span></pre></dd>
219
+
220
+ <dt id="WARM_REJECTIONS-constant" class="">WARM_REJECTIONS =
221
+
222
+ </dt>
223
+ <dd><pre class="code"><span class='int'>2</span></pre></dd>
224
+
225
+ <dt id="THROTTLE_COOLDOWN-constant" class="">THROTTLE_COOLDOWN =
226
+ <div class="docstring">
227
+ <div class="discussion">
228
+ <p>Seconds after a throttle, or its Retry-After when longer, during which completions are not measured.</p>
229
+
230
+ </div>
231
+ </div>
232
+ <div class="tags">
233
+
234
+
235
+ </div>
236
+ </dt>
237
+ <dd><pre class="code"><span class='float'>1.0</span></pre></dd>
238
+
239
+ <dt id="DOWNLOAD_RANGE_BYTES-constant" class="">DOWNLOAD_RANGE_BYTES =
240
+
241
+ </dt>
242
+ <dd><pre class="code"><span class='int'>8</span> <span class='op'>*</span> <span class='const'><span class='object_link'><a href="#MIB-constant" title="Files::Transfer::Policy::MIB (constant)">MIB</a></span></span></pre></dd>
243
+
244
+ <dt id="UPLOAD_BATCH_PARTS-constant" class="">UPLOAD_BATCH_PARTS =
245
+ <div class="docstring">
246
+ <div class="discussion">
247
+ <p>Parts asked for in one begin_upload.</p>
248
+
249
+ </div>
250
+ </div>
251
+ <div class="tags">
252
+
253
+
254
+ </div>
255
+ </dt>
256
+ <dd><pre class="code"><span class='int'>5</span></pre></dd>
257
+
258
+ <dt id="DEFAULT_MAX-constant" class="">DEFAULT_MAX =
259
+ <div class="docstring">
260
+ <div class="discussion">
261
+ <p>The most requests cloud storage and downloads have in flight, and a job across all its transfers, unless the
262
+ caller's max_concurrency or fixed concurrency says otherwise.</p>
263
+
264
+ </div>
265
+ </div>
266
+ <div class="tags">
267
+
268
+
269
+ </div>
270
+ </dt>
271
+ <dd><pre class="code"><span class='int'>64</span></pre></dd>
272
+
273
+ </dl>
274
+
275
+
276
+
277
+
278
+
279
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
280
+ <ul class="summary">
281
+
282
+ <li class="public ">
283
+ <span class="summary_signature">
284
+
285
+ <a href="#growth_step-instance_method" title="#growth_step (instance method)">#<strong>growth_step</strong> &#x21d2; Object </a>
286
+
287
+
288
+
289
+ </span>
290
+
291
+
292
+
293
+
294
+ <span class="note title readonly">readonly</span>
295
+
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute growth_step.</p></div></span>
305
+
306
+ </li>
307
+
308
+
309
+ <li class="public ">
310
+ <span class="summary_signature">
311
+
312
+ <a href="#initial-instance_method" title="#initial (instance method)">#<strong>initial</strong> &#x21d2; Object </a>
313
+
314
+
315
+
316
+ </span>
317
+
318
+
319
+
320
+
321
+ <span class="note title readonly">readonly</span>
322
+
323
+
324
+
325
+
326
+
327
+
328
+
329
+
330
+
331
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute initial.</p></div></span>
332
+
333
+ </li>
334
+
335
+
336
+ <li class="public ">
337
+ <span class="summary_signature">
338
+
339
+ <a href="#latency_floor-instance_method" title="#latency_floor (instance method)">#<strong>latency_floor</strong> &#x21d2; Object </a>
340
+
341
+
342
+
343
+ </span>
344
+
345
+
346
+
347
+
348
+ <span class="note title readonly">readonly</span>
349
+
350
+
351
+
352
+
353
+
354
+
355
+
356
+
357
+
358
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute latency_floor.</p></div></span>
359
+
360
+ </li>
361
+
362
+
363
+ <li class="public ">
364
+ <span class="summary_signature">
365
+
366
+ <a href="#max-instance_method" title="#max (instance method)">#<strong>max</strong> &#x21d2; Object </a>
367
+
368
+
369
+
370
+ </span>
371
+
372
+
373
+
374
+
375
+ <span class="note title readonly">readonly</span>
376
+
377
+
378
+
379
+
380
+
381
+
382
+
383
+
384
+
385
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute max.</p></div></span>
386
+
387
+ </li>
388
+
389
+
390
+ <li class="public ">
391
+ <span class="summary_signature">
392
+
393
+ <a href="#min-instance_method" title="#min (instance method)">#<strong>min</strong> &#x21d2; Object </a>
394
+
395
+
396
+
397
+ </span>
398
+
399
+
400
+
401
+
402
+ <span class="note title readonly">readonly</span>
403
+
404
+
405
+
406
+
407
+
408
+
409
+
410
+
411
+
412
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute min.</p></div></span>
413
+
414
+ </li>
415
+
416
+
417
+ <li class="public ">
418
+ <span class="summary_signature">
419
+
420
+ <a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong> &#x21d2; Object </a>
421
+
422
+
423
+
424
+ </span>
425
+
426
+
427
+
428
+
429
+ <span class="note title readonly">readonly</span>
430
+
431
+
432
+
433
+
434
+
435
+
436
+
437
+
438
+
439
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute name.</p></div></span>
440
+
441
+ </li>
442
+
443
+
444
+ <li class="public ">
445
+ <span class="summary_signature">
446
+
447
+ <a href="#queue_backoff-instance_method" title="#queue_backoff (instance method)">#<strong>queue_backoff</strong> &#x21d2; Object </a>
448
+
449
+
450
+
451
+ </span>
452
+
453
+
454
+
455
+
456
+ <span class="note title readonly">readonly</span>
457
+
458
+
459
+
460
+
461
+
462
+
463
+
464
+
465
+
466
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute queue_backoff.</p></div></span>
467
+
468
+ </li>
469
+
470
+
471
+ <li class="public ">
472
+ <span class="summary_signature">
473
+
474
+ <a href="#queue_suppress-instance_method" title="#queue_suppress (instance method)">#<strong>queue_suppress</strong> &#x21d2; Object </a>
475
+
476
+
477
+
478
+ </span>
479
+
480
+
481
+
482
+
483
+ <span class="note title readonly">readonly</span>
484
+
485
+
486
+
487
+
488
+
489
+
490
+
491
+
492
+
493
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute queue_suppress.</p></div></span>
494
+
495
+ </li>
496
+
497
+
498
+ <li class="public ">
499
+ <span class="summary_signature">
500
+
501
+ <a href="#rejected_floor-instance_method" title="#rejected_floor (instance method)">#<strong>rejected_floor</strong> &#x21d2; Object </a>
502
+
503
+
504
+
505
+ </span>
506
+
507
+
508
+
509
+
510
+ <span class="note title readonly">readonly</span>
511
+
512
+
513
+
514
+
515
+
516
+
517
+
518
+
519
+
520
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute rejected_floor.</p></div></span>
521
+
522
+ </li>
523
+
524
+
525
+ <li class="public ">
526
+ <span class="summary_signature">
527
+
528
+ <a href="#soft-instance_method" title="#soft (instance method)">#<strong>soft</strong> &#x21d2; Object </a>
529
+
530
+
531
+
532
+ </span>
533
+
534
+
535
+
536
+
537
+ <span class="note title readonly">readonly</span>
538
+
539
+
540
+
541
+
542
+
543
+
544
+
545
+
546
+
547
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute soft.</p></div></span>
548
+
549
+ </li>
550
+
551
+
552
+ <li class="public ">
553
+ <span class="summary_signature">
554
+
555
+ <a href="#start-instance_method" title="#start (instance method)">#<strong>start</strong> &#x21d2; Object </a>
556
+
557
+
558
+
559
+ </span>
560
+
561
+
562
+
563
+
564
+ <span class="note title readonly">readonly</span>
565
+
566
+
567
+
568
+
569
+
570
+
571
+
572
+
573
+
574
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute start.</p></div></span>
575
+
576
+ </li>
577
+
578
+
579
+ <li class="public ">
580
+ <span class="summary_signature">
581
+
582
+ <a href="#window_attempts-instance_method" title="#window_attempts (instance method)">#<strong>window_attempts</strong> &#x21d2; Object </a>
583
+
584
+
585
+
586
+ </span>
587
+
588
+
589
+
590
+
591
+ <span class="note title readonly">readonly</span>
592
+
593
+
594
+
595
+
596
+
597
+
598
+
599
+
600
+
601
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute window_attempts.</p></div></span>
602
+
603
+ </li>
604
+
605
+
606
+ </ul>
607
+
608
+
609
+
610
+
611
+
612
+ <h2>
613
+ Class Method Summary
614
+ <small><a href="#" class="summary_toggle">collapse</a></small>
615
+ </h2>
616
+
617
+ <ul class="summary">
618
+
619
+ <li class="public ">
620
+ <span class="summary_signature">
621
+
622
+ <a href="#direct_upload-class_method" title="direct_upload (class method)">.<strong>direct_upload</strong>(max_concurrency: nil) &#x21d2; Object </a>
623
+
624
+
625
+
626
+ </span>
627
+
628
+
629
+
630
+
631
+
632
+
633
+
634
+
635
+
636
+ <span class="summary_desc"><div class='inline'><p>A destination the API reports a direct connection for, such as an agent.</p></div></span>
637
+
638
+ </li>
639
+
640
+
641
+ <li class="public ">
642
+ <span class="summary_signature">
643
+
644
+ <a href="#download-class_method" title="download (class method)">.<strong>download</strong>(max_concurrency: nil) &#x21d2; Object </a>
645
+
646
+
647
+
648
+ </span>
649
+
650
+
651
+
652
+
653
+
654
+
655
+
656
+
657
+
658
+ <span class="summary_desc"><div class='inline'></div></span>
659
+
660
+ </li>
661
+
662
+
663
+ <li class="public ">
664
+ <span class="summary_signature">
665
+
666
+ <a href="#fixed-class_method" title="fixed (class method)">.<strong>fixed</strong>(concurrency) &#x21d2; Object </a>
667
+
668
+
669
+
670
+ </span>
671
+
672
+
673
+
674
+
675
+
676
+
677
+
678
+
679
+
680
+ <span class="summary_desc"><div class='inline'></div></span>
681
+
682
+ </li>
683
+
684
+
685
+ <li class="public ">
686
+ <span class="summary_signature">
687
+
688
+ <a href="#storage_upload-class_method" title="storage_upload (class method)">.<strong>storage_upload</strong>(startup: :default, max_concurrency: nil) &#x21d2; Object </a>
689
+
690
+
691
+
692
+ </span>
693
+
694
+
695
+
696
+
697
+
698
+
699
+
700
+
701
+
702
+ <span class="summary_desc"><div class='inline'><p>Cloud storage, such as S3.</p></div></span>
703
+
704
+ </li>
705
+
706
+
707
+ </ul>
708
+
709
+
710
+ <h2>
711
+ Instance Method Summary
712
+ <small><a href="#" class="summary_toggle">collapse</a></small>
713
+ </h2>
714
+
715
+ <ul class="summary">
716
+
717
+ <li class="public ">
718
+ <span class="summary_signature">
719
+
720
+ <a href="#fixed%3F-instance_method" title="#fixed? (instance method)">#<strong>fixed?</strong> &#x21d2; Boolean </a>
721
+
722
+
723
+
724
+ </span>
725
+
726
+
727
+
728
+
729
+
730
+
731
+
732
+
733
+
734
+ <span class="summary_desc"><div class='inline'></div></span>
735
+
736
+ </li>
737
+
738
+
739
+ <li class="public ">
740
+ <span class="summary_signature">
741
+
742
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(name:, initial:, start:, min:, soft:, max:, growth_step:, queue_suppress:, queue_backoff:, latency_floor:, rejected_floor:, window_attempts: 16, warm: false, fixed: false) &#x21d2; Policy </a>
743
+
744
+
745
+
746
+ </span>
747
+
748
+
749
+ <span class="note title constructor">constructor</span>
750
+
751
+
752
+
753
+
754
+
755
+
756
+
757
+
758
+ <span class="summary_desc"><div class='inline'><p>A new instance of Policy.</p></div></span>
759
+
760
+ </li>
761
+
762
+
763
+ <li class="public ">
764
+ <span class="summary_signature">
765
+
766
+ <a href="#warm%3F-instance_method" title="#warm? (instance method)">#<strong>warm?</strong> &#x21d2; Boolean </a>
767
+
768
+
769
+
770
+ </span>
771
+
772
+
773
+
774
+
775
+
776
+
777
+
778
+
779
+
780
+ <span class="summary_desc"><div class='inline'></div></span>
781
+
782
+ </li>
783
+
784
+
785
+ </ul>
786
+
787
+
788
+
789
+ <div id="constructor_details" class="method_details_list">
790
+ <h2>Constructor Details</h2>
791
+
792
+ <div class="method_details first">
793
+ <h3 class="signature first" id="initialize-instance_method">
794
+
795
+ #<strong>initialize</strong>(name:, initial:, start:, min:, soft:, max:, growth_step:, queue_suppress:, queue_backoff:, latency_floor:, rejected_floor:, window_attempts: 16, warm: false, fixed: false) &#x21d2; <tt><span class='object_link'><a href="" title="Files::Transfer::Policy (class)">Policy</a></span></tt>
796
+
797
+
798
+
799
+
800
+
801
+ </h3><div class="docstring">
802
+ <div class="discussion">
803
+ <p>Returns a new instance of Policy.</p>
804
+
805
+ </div>
806
+ </div>
807
+ <div class="tags">
808
+
809
+
810
+ </div><table class="source_code">
811
+ <tr>
812
+ <td>
813
+ <pre class="lines">
814
+
815
+
816
+ 63
817
+ 64
818
+ 65
819
+ 66
820
+ 67
821
+ 68
822
+ 69
823
+ 70
824
+ 71
825
+ 72
826
+ 73
827
+ 74
828
+ 75
829
+ 76
830
+ 77
831
+ 78
832
+ 79
833
+ 80</pre>
834
+ </td>
835
+ <td>
836
+ <pre class="code"><span class="info file"># File 'lib/files.com/transfer/policy.rb', line 63</span>
837
+
838
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>name:</span><span class='comma'>,</span> <span class='label'>initial:</span><span class='comma'>,</span> <span class='label'>start:</span><span class='comma'>,</span> <span class='label'>min:</span><span class='comma'>,</span> <span class='label'>soft:</span><span class='comma'>,</span> <span class='label'>max:</span><span class='comma'>,</span> <span class='label'>growth_step:</span><span class='comma'>,</span> <span class='label'>queue_suppress:</span><span class='comma'>,</span> <span class='label'>queue_backoff:</span><span class='comma'>,</span> <span class='label'>latency_floor:</span><span class='comma'>,</span> <span class='label'>rejected_floor:</span><span class='comma'>,</span>
839
+ <span class='label'>window_attempts:</span> <span class='int'>16</span><span class='comma'>,</span> <span class='label'>warm:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>fixed:</span> <span class='kw'>false</span><span class='rparen'>)</span>
840
+ <span class='ivar'>@name</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span>
841
+ <span class='ivar'>@max</span> <span class='op'>=</span> <span class='id identifier rubyid_max'>max</span>
842
+ <span class='ivar'>@initial</span> <span class='op'>=</span> <span class='lbracket'>[</span> <span class='id identifier rubyid_initial'>initial</span><span class='comma'>,</span> <span class='id identifier rubyid_max'>max</span> <span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_min'>min</span>
843
+ <span class='ivar'>@start</span> <span class='op'>=</span> <span class='lbracket'>[</span> <span class='id identifier rubyid_start'>start</span><span class='comma'>,</span> <span class='id identifier rubyid_max'>max</span> <span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_min'>min</span>
844
+ <span class='ivar'>@min</span> <span class='op'>=</span> <span class='lbracket'>[</span> <span class='id identifier rubyid_min'>min</span><span class='comma'>,</span> <span class='id identifier rubyid_max'>max</span> <span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_min'>min</span>
845
+ <span class='ivar'>@soft</span> <span class='op'>=</span> <span class='lbracket'>[</span> <span class='id identifier rubyid_soft'>soft</span><span class='comma'>,</span> <span class='id identifier rubyid_max'>max</span> <span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_min'>min</span>
846
+ <span class='ivar'>@window_attempts</span> <span class='op'>=</span> <span class='id identifier rubyid_window_attempts'>window_attempts</span>
847
+ <span class='ivar'>@growth_step</span> <span class='op'>=</span> <span class='id identifier rubyid_growth_step'>growth_step</span>
848
+ <span class='ivar'>@queue_suppress</span> <span class='op'>=</span> <span class='id identifier rubyid_queue_suppress'>queue_suppress</span>
849
+ <span class='ivar'>@queue_backoff</span> <span class='op'>=</span> <span class='id identifier rubyid_queue_backoff'>queue_backoff</span>
850
+ <span class='ivar'>@latency_floor</span> <span class='op'>=</span> <span class='lbracket'>[</span> <span class='id identifier rubyid_latency_floor'>latency_floor</span><span class='comma'>,</span> <span class='id identifier rubyid_max'>max</span> <span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_min'>min</span>
851
+ <span class='ivar'>@rejected_floor</span> <span class='op'>=</span> <span class='lbracket'>[</span> <span class='id identifier rubyid_rejected_floor'>rejected_floor</span><span class='comma'>,</span> <span class='id identifier rubyid_max'>max</span> <span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_min'>min</span>
852
+ <span class='ivar'>@warm</span> <span class='op'>=</span> <span class='id identifier rubyid_warm'>warm</span> <span class='op'>&amp;&amp;</span> <span class='ivar'>@initial</span> <span class='op'>&lt;</span> <span class='ivar'>@start</span>
853
+ <span class='ivar'>@fixed</span> <span class='op'>=</span> <span class='id identifier rubyid_fixed'>fixed</span>
854
+ <span class='id identifier rubyid_freeze'>freeze</span>
855
+ <span class='kw'>end</span></pre>
856
+ </td>
857
+ </tr>
858
+ </table>
859
+ </div>
860
+
861
+ </div>
862
+
863
+ <div id="instance_attr_details" class="attr_details">
864
+ <h2>Instance Attribute Details</h2>
865
+
866
+
867
+ <span id=""></span>
868
+ <div class="method_details first">
869
+ <h3 class="signature first" id="growth_step-instance_method">
870
+
871
+ #<strong>growth_step</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
872
+
873
+
874
+
875
+
876
+
877
+ </h3><div class="docstring">
878
+ <div class="discussion">
879
+ <p>Returns the value of attribute growth_step.</p>
880
+
881
+ </div>
882
+ </div>
883
+ <div class="tags">
884
+
885
+
886
+ </div><table class="source_code">
887
+ <tr>
888
+ <td>
889
+ <pre class="lines">
890
+
891
+
892
+ 34
893
+ 35
894
+ 36</pre>
895
+ </td>
896
+ <td>
897
+ <pre class="code"><span class="info file"># File 'lib/files.com/transfer/policy.rb', line 34</span>
898
+
899
+ <span class='kw'>def</span> <span class='id identifier rubyid_growth_step'>growth_step</span>
900
+ <span class='ivar'>@growth_step</span>
901
+ <span class='kw'>end</span></pre>
902
+ </td>
903
+ </tr>
904
+ </table>
905
+ </div>
906
+
907
+
908
+ <span id=""></span>
909
+ <div class="method_details ">
910
+ <h3 class="signature " id="initial-instance_method">
911
+
912
+ #<strong>initial</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
913
+
914
+
915
+
916
+
917
+
918
+ </h3><div class="docstring">
919
+ <div class="discussion">
920
+ <p>Returns the value of attribute initial.</p>
921
+
922
+ </div>
923
+ </div>
924
+ <div class="tags">
925
+
926
+
927
+ </div><table class="source_code">
928
+ <tr>
929
+ <td>
930
+ <pre class="lines">
931
+
932
+
933
+ 34
934
+ 35
935
+ 36</pre>
936
+ </td>
937
+ <td>
938
+ <pre class="code"><span class="info file"># File 'lib/files.com/transfer/policy.rb', line 34</span>
939
+
940
+ <span class='kw'>def</span> <span class='id identifier rubyid_initial'>initial</span>
941
+ <span class='ivar'>@initial</span>
942
+ <span class='kw'>end</span></pre>
943
+ </td>
944
+ </tr>
945
+ </table>
946
+ </div>
947
+
948
+
949
+ <span id=""></span>
950
+ <div class="method_details ">
951
+ <h3 class="signature " id="latency_floor-instance_method">
952
+
953
+ #<strong>latency_floor</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
954
+
955
+
956
+
957
+
958
+
959
+ </h3><div class="docstring">
960
+ <div class="discussion">
961
+ <p>Returns the value of attribute latency_floor.</p>
962
+
963
+ </div>
964
+ </div>
965
+ <div class="tags">
966
+
967
+
968
+ </div><table class="source_code">
969
+ <tr>
970
+ <td>
971
+ <pre class="lines">
972
+
973
+
974
+ 34
975
+ 35
976
+ 36</pre>
977
+ </td>
978
+ <td>
979
+ <pre class="code"><span class="info file"># File 'lib/files.com/transfer/policy.rb', line 34</span>
980
+
981
+ <span class='kw'>def</span> <span class='id identifier rubyid_latency_floor'>latency_floor</span>
982
+ <span class='ivar'>@latency_floor</span>
983
+ <span class='kw'>end</span></pre>
984
+ </td>
985
+ </tr>
986
+ </table>
987
+ </div>
988
+
989
+
990
+ <span id=""></span>
991
+ <div class="method_details ">
992
+ <h3 class="signature " id="max-instance_method">
993
+
994
+ #<strong>max</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
995
+
996
+
997
+
998
+
999
+
1000
+ </h3><div class="docstring">
1001
+ <div class="discussion">
1002
+ <p>Returns the value of attribute max.</p>
1003
+
1004
+ </div>
1005
+ </div>
1006
+ <div class="tags">
1007
+
1008
+
1009
+ </div><table class="source_code">
1010
+ <tr>
1011
+ <td>
1012
+ <pre class="lines">
1013
+
1014
+
1015
+ 34
1016
+ 35
1017
+ 36</pre>
1018
+ </td>
1019
+ <td>
1020
+ <pre class="code"><span class="info file"># File 'lib/files.com/transfer/policy.rb', line 34</span>
1021
+
1022
+ <span class='kw'>def</span> <span class='id identifier rubyid_max'>max</span>
1023
+ <span class='ivar'>@max</span>
1024
+ <span class='kw'>end</span></pre>
1025
+ </td>
1026
+ </tr>
1027
+ </table>
1028
+ </div>
1029
+
1030
+
1031
+ <span id=""></span>
1032
+ <div class="method_details ">
1033
+ <h3 class="signature " id="min-instance_method">
1034
+
1035
+ #<strong>min</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
1036
+
1037
+
1038
+
1039
+
1040
+
1041
+ </h3><div class="docstring">
1042
+ <div class="discussion">
1043
+ <p>Returns the value of attribute min.</p>
1044
+
1045
+ </div>
1046
+ </div>
1047
+ <div class="tags">
1048
+
1049
+
1050
+ </div><table class="source_code">
1051
+ <tr>
1052
+ <td>
1053
+ <pre class="lines">
1054
+
1055
+
1056
+ 34
1057
+ 35
1058
+ 36</pre>
1059
+ </td>
1060
+ <td>
1061
+ <pre class="code"><span class="info file"># File 'lib/files.com/transfer/policy.rb', line 34</span>
1062
+
1063
+ <span class='kw'>def</span> <span class='id identifier rubyid_min'>min</span>
1064
+ <span class='ivar'>@min</span>
1065
+ <span class='kw'>end</span></pre>
1066
+ </td>
1067
+ </tr>
1068
+ </table>
1069
+ </div>
1070
+
1071
+
1072
+ <span id=""></span>
1073
+ <div class="method_details ">
1074
+ <h3 class="signature " id="name-instance_method">
1075
+
1076
+ #<strong>name</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
1077
+
1078
+
1079
+
1080
+
1081
+
1082
+ </h3><div class="docstring">
1083
+ <div class="discussion">
1084
+ <p>Returns the value of attribute name.</p>
1085
+
1086
+ </div>
1087
+ </div>
1088
+ <div class="tags">
1089
+
1090
+
1091
+ </div><table class="source_code">
1092
+ <tr>
1093
+ <td>
1094
+ <pre class="lines">
1095
+
1096
+
1097
+ 34
1098
+ 35
1099
+ 36</pre>
1100
+ </td>
1101
+ <td>
1102
+ <pre class="code"><span class="info file"># File 'lib/files.com/transfer/policy.rb', line 34</span>
1103
+
1104
+ <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
1105
+ <span class='ivar'>@name</span>
1106
+ <span class='kw'>end</span></pre>
1107
+ </td>
1108
+ </tr>
1109
+ </table>
1110
+ </div>
1111
+
1112
+
1113
+ <span id=""></span>
1114
+ <div class="method_details ">
1115
+ <h3 class="signature " id="queue_backoff-instance_method">
1116
+
1117
+ #<strong>queue_backoff</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
1118
+
1119
+
1120
+
1121
+
1122
+
1123
+ </h3><div class="docstring">
1124
+ <div class="discussion">
1125
+ <p>Returns the value of attribute queue_backoff.</p>
1126
+
1127
+ </div>
1128
+ </div>
1129
+ <div class="tags">
1130
+
1131
+
1132
+ </div><table class="source_code">
1133
+ <tr>
1134
+ <td>
1135
+ <pre class="lines">
1136
+
1137
+
1138
+ 34
1139
+ 35
1140
+ 36</pre>
1141
+ </td>
1142
+ <td>
1143
+ <pre class="code"><span class="info file"># File 'lib/files.com/transfer/policy.rb', line 34</span>
1144
+
1145
+ <span class='kw'>def</span> <span class='id identifier rubyid_queue_backoff'>queue_backoff</span>
1146
+ <span class='ivar'>@queue_backoff</span>
1147
+ <span class='kw'>end</span></pre>
1148
+ </td>
1149
+ </tr>
1150
+ </table>
1151
+ </div>
1152
+
1153
+
1154
+ <span id=""></span>
1155
+ <div class="method_details ">
1156
+ <h3 class="signature " id="queue_suppress-instance_method">
1157
+
1158
+ #<strong>queue_suppress</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
1159
+
1160
+
1161
+
1162
+
1163
+
1164
+ </h3><div class="docstring">
1165
+ <div class="discussion">
1166
+ <p>Returns the value of attribute queue_suppress.</p>
1167
+
1168
+ </div>
1169
+ </div>
1170
+ <div class="tags">
1171
+
1172
+
1173
+ </div><table class="source_code">
1174
+ <tr>
1175
+ <td>
1176
+ <pre class="lines">
1177
+
1178
+
1179
+ 34
1180
+ 35
1181
+ 36</pre>
1182
+ </td>
1183
+ <td>
1184
+ <pre class="code"><span class="info file"># File 'lib/files.com/transfer/policy.rb', line 34</span>
1185
+
1186
+ <span class='kw'>def</span> <span class='id identifier rubyid_queue_suppress'>queue_suppress</span>
1187
+ <span class='ivar'>@queue_suppress</span>
1188
+ <span class='kw'>end</span></pre>
1189
+ </td>
1190
+ </tr>
1191
+ </table>
1192
+ </div>
1193
+
1194
+
1195
+ <span id=""></span>
1196
+ <div class="method_details ">
1197
+ <h3 class="signature " id="rejected_floor-instance_method">
1198
+
1199
+ #<strong>rejected_floor</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
1200
+
1201
+
1202
+
1203
+
1204
+
1205
+ </h3><div class="docstring">
1206
+ <div class="discussion">
1207
+ <p>Returns the value of attribute rejected_floor.</p>
1208
+
1209
+ </div>
1210
+ </div>
1211
+ <div class="tags">
1212
+
1213
+
1214
+ </div><table class="source_code">
1215
+ <tr>
1216
+ <td>
1217
+ <pre class="lines">
1218
+
1219
+
1220
+ 34
1221
+ 35
1222
+ 36</pre>
1223
+ </td>
1224
+ <td>
1225
+ <pre class="code"><span class="info file"># File 'lib/files.com/transfer/policy.rb', line 34</span>
1226
+
1227
+ <span class='kw'>def</span> <span class='id identifier rubyid_rejected_floor'>rejected_floor</span>
1228
+ <span class='ivar'>@rejected_floor</span>
1229
+ <span class='kw'>end</span></pre>
1230
+ </td>
1231
+ </tr>
1232
+ </table>
1233
+ </div>
1234
+
1235
+
1236
+ <span id=""></span>
1237
+ <div class="method_details ">
1238
+ <h3 class="signature " id="soft-instance_method">
1239
+
1240
+ #<strong>soft</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
1241
+
1242
+
1243
+
1244
+
1245
+
1246
+ </h3><div class="docstring">
1247
+ <div class="discussion">
1248
+ <p>Returns the value of attribute soft.</p>
1249
+
1250
+ </div>
1251
+ </div>
1252
+ <div class="tags">
1253
+
1254
+
1255
+ </div><table class="source_code">
1256
+ <tr>
1257
+ <td>
1258
+ <pre class="lines">
1259
+
1260
+
1261
+ 34
1262
+ 35
1263
+ 36</pre>
1264
+ </td>
1265
+ <td>
1266
+ <pre class="code"><span class="info file"># File 'lib/files.com/transfer/policy.rb', line 34</span>
1267
+
1268
+ <span class='kw'>def</span> <span class='id identifier rubyid_soft'>soft</span>
1269
+ <span class='ivar'>@soft</span>
1270
+ <span class='kw'>end</span></pre>
1271
+ </td>
1272
+ </tr>
1273
+ </table>
1274
+ </div>
1275
+
1276
+
1277
+ <span id=""></span>
1278
+ <div class="method_details ">
1279
+ <h3 class="signature " id="start-instance_method">
1280
+
1281
+ #<strong>start</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
1282
+
1283
+
1284
+
1285
+
1286
+
1287
+ </h3><div class="docstring">
1288
+ <div class="discussion">
1289
+ <p>Returns the value of attribute start.</p>
1290
+
1291
+ </div>
1292
+ </div>
1293
+ <div class="tags">
1294
+
1295
+
1296
+ </div><table class="source_code">
1297
+ <tr>
1298
+ <td>
1299
+ <pre class="lines">
1300
+
1301
+
1302
+ 34
1303
+ 35
1304
+ 36</pre>
1305
+ </td>
1306
+ <td>
1307
+ <pre class="code"><span class="info file"># File 'lib/files.com/transfer/policy.rb', line 34</span>
1308
+
1309
+ <span class='kw'>def</span> <span class='id identifier rubyid_start'>start</span>
1310
+ <span class='ivar'>@start</span>
1311
+ <span class='kw'>end</span></pre>
1312
+ </td>
1313
+ </tr>
1314
+ </table>
1315
+ </div>
1316
+
1317
+
1318
+ <span id=""></span>
1319
+ <div class="method_details ">
1320
+ <h3 class="signature " id="window_attempts-instance_method">
1321
+
1322
+ #<strong>window_attempts</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
1323
+
1324
+
1325
+
1326
+
1327
+
1328
+ </h3><div class="docstring">
1329
+ <div class="discussion">
1330
+ <p>Returns the value of attribute window_attempts.</p>
1331
+
1332
+ </div>
1333
+ </div>
1334
+ <div class="tags">
1335
+
1336
+
1337
+ </div><table class="source_code">
1338
+ <tr>
1339
+ <td>
1340
+ <pre class="lines">
1341
+
1342
+
1343
+ 34
1344
+ 35
1345
+ 36</pre>
1346
+ </td>
1347
+ <td>
1348
+ <pre class="code"><span class="info file"># File 'lib/files.com/transfer/policy.rb', line 34</span>
1349
+
1350
+ <span class='kw'>def</span> <span class='id identifier rubyid_window_attempts'>window_attempts</span>
1351
+ <span class='ivar'>@window_attempts</span>
1352
+ <span class='kw'>end</span></pre>
1353
+ </td>
1354
+ </tr>
1355
+ </table>
1356
+ </div>
1357
+
1358
+ </div>
1359
+
1360
+
1361
+ <div id="class_method_details" class="method_details_list">
1362
+ <h2>Class Method Details</h2>
1363
+
1364
+
1365
+ <div class="method_details first">
1366
+ <h3 class="signature first" id="direct_upload-class_method">
1367
+
1368
+ .<strong>direct_upload</strong>(max_concurrency: nil) &#x21d2; <tt>Object</tt>
1369
+
1370
+
1371
+
1372
+
1373
+
1374
+ </h3><div class="docstring">
1375
+ <div class="discussion">
1376
+ <p>A destination the API reports a direct connection for, such as an agent. Its queue thresholds are cloud
1377
+ storage's 20 and 34, scaled to its maximum of 16.</p>
1378
+
1379
+ </div>
1380
+ </div>
1381
+ <div class="tags">
1382
+
1383
+
1384
+ </div><table class="source_code">
1385
+ <tr>
1386
+ <td>
1387
+ <pre class="lines">
1388
+
1389
+
1390
+ 45
1391
+ 46
1392
+ 47
1393
+ 48
1394
+ 49</pre>
1395
+ </td>
1396
+ <td>
1397
+ <pre class="code"><span class="info file"># File 'lib/files.com/transfer/policy.rb', line 45</span>
1398
+
1399
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_direct_upload'>direct_upload</span><span class='lparen'>(</span><span class='label'>max_concurrency:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1400
+ <span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>name:</span> <span class='symbol'>:direct</span><span class='comma'>,</span> <span class='label'>initial:</span> <span class='int'>4</span><span class='comma'>,</span> <span class='label'>start:</span> <span class='int'>4</span><span class='comma'>,</span> <span class='label'>min:</span> <span class='int'>1</span><span class='comma'>,</span> <span class='label'>soft:</span> <span class='int'>16</span><span class='comma'>,</span> <span class='label'>max:</span> <span class='lbracket'>[</span> <span class='int'>16</span><span class='comma'>,</span> <span class='id identifier rubyid_max_concurrency'>max_concurrency</span> <span class='op'>||</span> <span class='int'>16</span> <span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_min'>min</span><span class='comma'>,</span>
1401
+ <span class='label'>growth_step:</span> <span class='int'>1</span><span class='comma'>,</span> <span class='label'>queue_suppress:</span> <span class='int'>5</span><span class='comma'>,</span> <span class='label'>queue_backoff:</span> <span class='int'>9</span><span class='comma'>,</span> <span class='label'>latency_floor:</span> <span class='int'>1</span><span class='comma'>,</span> <span class='label'>rejected_floor:</span> <span class='int'>1</span>
1402
+ <span class='rparen'>)</span>
1403
+ <span class='kw'>end</span></pre>
1404
+ </td>
1405
+ </tr>
1406
+ </table>
1407
+ </div>
1408
+
1409
+ <div class="method_details ">
1410
+ <h3 class="signature " id="download-class_method">
1411
+
1412
+ .<strong>download</strong>(max_concurrency: nil) &#x21d2; <tt>Object</tt>
1413
+
1414
+
1415
+
1416
+
1417
+
1418
+ </h3><table class="source_code">
1419
+ <tr>
1420
+ <td>
1421
+ <pre class="lines">
1422
+
1423
+
1424
+ 51
1425
+ 52
1426
+ 53
1427
+ 54
1428
+ 55</pre>
1429
+ </td>
1430
+ <td>
1431
+ <pre class="code"><span class="info file"># File 'lib/files.com/transfer/policy.rb', line 51</span>
1432
+
1433
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_download'>download</span><span class='lparen'>(</span><span class='label'>max_concurrency:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1434
+ <span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>name:</span> <span class='symbol'>:download</span><span class='comma'>,</span> <span class='label'>initial:</span> <span class='int'>32</span><span class='comma'>,</span> <span class='label'>start:</span> <span class='int'>32</span><span class='comma'>,</span> <span class='label'>min:</span> <span class='int'>4</span><span class='comma'>,</span> <span class='label'>soft:</span> <span class='int'>32</span><span class='comma'>,</span> <span class='label'>max:</span> <span class='id identifier rubyid_max_concurrency'>max_concurrency</span> <span class='op'>||</span> <span class='const'><span class='object_link'><a href="#DEFAULT_MAX-constant" title="Files::Transfer::Policy::DEFAULT_MAX (constant)">DEFAULT_MAX</a></span></span><span class='comma'>,</span>
1435
+ <span class='label'>growth_step:</span> <span class='int'>2</span><span class='comma'>,</span> <span class='label'>queue_suppress:</span> <span class='int'>20</span><span class='comma'>,</span> <span class='label'>queue_backoff:</span> <span class='int'>34</span><span class='comma'>,</span> <span class='label'>latency_floor:</span> <span class='int'>12</span><span class='comma'>,</span> <span class='label'>rejected_floor:</span> <span class='int'>12</span>
1436
+ <span class='rparen'>)</span>
1437
+ <span class='kw'>end</span></pre>
1438
+ </td>
1439
+ </tr>
1440
+ </table>
1441
+ </div>
1442
+
1443
+ <div class="method_details ">
1444
+ <h3 class="signature " id="fixed-class_method">
1445
+
1446
+ .<strong>fixed</strong>(concurrency) &#x21d2; <tt>Object</tt>
1447
+
1448
+
1449
+
1450
+
1451
+
1452
+ </h3><table class="source_code">
1453
+ <tr>
1454
+ <td>
1455
+ <pre class="lines">
1456
+
1457
+
1458
+ 57
1459
+ 58
1460
+ 59
1461
+ 60
1462
+ 61</pre>
1463
+ </td>
1464
+ <td>
1465
+ <pre class="code"><span class="info file"># File 'lib/files.com/transfer/policy.rb', line 57</span>
1466
+
1467
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_fixed'>fixed</span><span class='lparen'>(</span><span class='id identifier rubyid_concurrency'>concurrency</span><span class='rparen'>)</span>
1468
+ <span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>name:</span> <span class='symbol'>:fixed</span><span class='comma'>,</span> <span class='label'>initial:</span> <span class='id identifier rubyid_concurrency'>concurrency</span><span class='comma'>,</span> <span class='label'>start:</span> <span class='id identifier rubyid_concurrency'>concurrency</span><span class='comma'>,</span> <span class='label'>min:</span> <span class='id identifier rubyid_concurrency'>concurrency</span><span class='comma'>,</span> <span class='label'>soft:</span> <span class='id identifier rubyid_concurrency'>concurrency</span><span class='comma'>,</span> <span class='label'>max:</span> <span class='id identifier rubyid_concurrency'>concurrency</span><span class='comma'>,</span>
1469
+ <span class='label'>growth_step:</span> <span class='int'>0</span><span class='comma'>,</span> <span class='label'>queue_suppress:</span> <span class='id identifier rubyid_concurrency'>concurrency</span><span class='comma'>,</span> <span class='label'>queue_backoff:</span> <span class='id identifier rubyid_concurrency'>concurrency</span><span class='comma'>,</span> <span class='label'>latency_floor:</span> <span class='id identifier rubyid_concurrency'>concurrency</span><span class='comma'>,</span> <span class='label'>rejected_floor:</span> <span class='id identifier rubyid_concurrency'>concurrency</span><span class='comma'>,</span> <span class='label'>fixed:</span> <span class='kw'>true</span>
1470
+ <span class='rparen'>)</span>
1471
+ <span class='kw'>end</span></pre>
1472
+ </td>
1473
+ </tr>
1474
+ </table>
1475
+ </div>
1476
+
1477
+ <div class="method_details ">
1478
+ <h3 class="signature " id="storage_upload-class_method">
1479
+
1480
+ .<strong>storage_upload</strong>(startup: :default, max_concurrency: nil) &#x21d2; <tt>Object</tt>
1481
+
1482
+
1483
+
1484
+
1485
+
1486
+ </h3><div class="docstring">
1487
+ <div class="discussion">
1488
+ <p>Cloud storage, such as S3. :default starts at one request and warms up toward 32; :aggressive starts at 32.</p>
1489
+
1490
+ </div>
1491
+ </div>
1492
+ <div class="tags">
1493
+
1494
+
1495
+ </div><table class="source_code">
1496
+ <tr>
1497
+ <td>
1498
+ <pre class="lines">
1499
+
1500
+
1501
+ 37
1502
+ 38
1503
+ 39
1504
+ 40
1505
+ 41</pre>
1506
+ </td>
1507
+ <td>
1508
+ <pre class="code"><span class="info file"># File 'lib/files.com/transfer/policy.rb', line 37</span>
1509
+
1510
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_storage_upload'>storage_upload</span><span class='lparen'>(</span><span class='label'>startup:</span> <span class='symbol'>:default</span><span class='comma'>,</span> <span class='label'>max_concurrency:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1511
+ <span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>name:</span> <span class='symbol'>:storage</span><span class='comma'>,</span> <span class='label'>initial:</span> <span class='id identifier rubyid_startup'>startup</span> <span class='op'>==</span> <span class='symbol'>:aggressive</span> <span class='op'>?</span> <span class='int'>32</span> <span class='op'>:</span> <span class='int'>1</span><span class='comma'>,</span> <span class='label'>start:</span> <span class='int'>32</span><span class='comma'>,</span> <span class='label'>min:</span> <span class='int'>4</span><span class='comma'>,</span> <span class='label'>soft:</span> <span class='int'>32</span><span class='comma'>,</span> <span class='label'>max:</span> <span class='id identifier rubyid_max_concurrency'>max_concurrency</span> <span class='op'>||</span> <span class='const'><span class='object_link'><a href="#DEFAULT_MAX-constant" title="Files::Transfer::Policy::DEFAULT_MAX (constant)">DEFAULT_MAX</a></span></span><span class='comma'>,</span>
1512
+ <span class='label'>growth_step:</span> <span class='int'>2</span><span class='comma'>,</span> <span class='label'>queue_suppress:</span> <span class='int'>20</span><span class='comma'>,</span> <span class='label'>queue_backoff:</span> <span class='int'>34</span><span class='comma'>,</span> <span class='label'>latency_floor:</span> <span class='int'>12</span><span class='comma'>,</span> <span class='label'>rejected_floor:</span> <span class='int'>12</span><span class='comma'>,</span> <span class='label'>warm:</span> <span class='id identifier rubyid_startup'>startup</span> <span class='op'>==</span> <span class='symbol'>:default</span>
1513
+ <span class='rparen'>)</span>
1514
+ <span class='kw'>end</span></pre>
1515
+ </td>
1516
+ </tr>
1517
+ </table>
1518
+ </div>
1519
+
1520
+ </div>
1521
+
1522
+ <div id="instance_method_details" class="method_details_list">
1523
+ <h2>Instance Method Details</h2>
1524
+
1525
+
1526
+ <div class="method_details first">
1527
+ <h3 class="signature first" id="fixed?-instance_method">
1528
+
1529
+ #<strong>fixed?</strong> &#x21d2; <tt>Boolean</tt>
1530
+
1531
+
1532
+
1533
+
1534
+
1535
+ </h3><div class="docstring">
1536
+ <div class="discussion">
1537
+
1538
+
1539
+ </div>
1540
+ </div>
1541
+ <div class="tags">
1542
+
1543
+ <p class="tag_title">Returns:</p>
1544
+ <ul class="return">
1545
+
1546
+ <li>
1547
+
1548
+
1549
+ <span class='type'>(<tt>Boolean</tt>)</span>
1550
+
1551
+
1552
+
1553
+ </li>
1554
+
1555
+ </ul>
1556
+
1557
+ </div><table class="source_code">
1558
+ <tr>
1559
+ <td>
1560
+ <pre class="lines">
1561
+
1562
+
1563
+ 86
1564
+ 87
1565
+ 88</pre>
1566
+ </td>
1567
+ <td>
1568
+ <pre class="code"><span class="info file"># File 'lib/files.com/transfer/policy.rb', line 86</span>
1569
+
1570
+ <span class='kw'>def</span> <span class='id identifier rubyid_fixed?'>fixed?</span>
1571
+ <span class='ivar'>@fixed</span>
1572
+ <span class='kw'>end</span></pre>
1573
+ </td>
1574
+ </tr>
1575
+ </table>
1576
+ </div>
1577
+
1578
+ <div class="method_details ">
1579
+ <h3 class="signature " id="warm?-instance_method">
1580
+
1581
+ #<strong>warm?</strong> &#x21d2; <tt>Boolean</tt>
1582
+
1583
+
1584
+
1585
+
1586
+
1587
+ </h3><div class="docstring">
1588
+ <div class="discussion">
1589
+
1590
+
1591
+ </div>
1592
+ </div>
1593
+ <div class="tags">
1594
+
1595
+ <p class="tag_title">Returns:</p>
1596
+ <ul class="return">
1597
+
1598
+ <li>
1599
+
1600
+
1601
+ <span class='type'>(<tt>Boolean</tt>)</span>
1602
+
1603
+
1604
+
1605
+ </li>
1606
+
1607
+ </ul>
1608
+
1609
+ </div><table class="source_code">
1610
+ <tr>
1611
+ <td>
1612
+ <pre class="lines">
1613
+
1614
+
1615
+ 82
1616
+ 83
1617
+ 84</pre>
1618
+ </td>
1619
+ <td>
1620
+ <pre class="code"><span class="info file"># File 'lib/files.com/transfer/policy.rb', line 82</span>
1621
+
1622
+ <span class='kw'>def</span> <span class='id identifier rubyid_warm?'>warm?</span>
1623
+ <span class='ivar'>@warm</span>
1624
+ <span class='kw'>end</span></pre>
1625
+ </td>
1626
+ </tr>
1627
+ </table>
1628
+ </div>
1629
+
1630
+ </div>
1631
+
1632
+ </div>
1633
+
1634
+ <div id="footer">
1635
+ Generated on Tue Nov 3 18:04:05 2026 by
1636
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1637
+ 0.9.45 (ruby-4.0.9).
1638
+ </div>
1639
+
1640
+ </div>
1641
+ </body>
1642
+ </html>