files.com 1.1.813 → 1.1.815
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.
- checksums.yaml +4 -4
- data/_VERSION +1 -1
- data/doc/Files/APIConnectionError.html +1 -1
- data/doc/Files/APIError.html +1 -1
- data/doc/Files/AccountAlreadyExistsError.html +1 -1
- data/doc/Files/AccountLineItem.html +1 -1
- data/doc/Files/AccountOverdueError.html +1 -1
- data/doc/Files/Action.html +1 -1
- data/doc/Files/ActionLog.html +1 -1
- data/doc/Files/ActionNotificationExport.html +1 -1
- data/doc/Files/ActionNotificationExportResult.html +1 -1
- data/doc/Files/AdditionalAuthenticationRequiredError.html +1 -1
- data/doc/Files/AgentNode.html +1 -1
- data/doc/Files/AgentNodeConnection.html +1 -1
- data/doc/Files/AgentNodeInstance.html +1 -1
- data/doc/Files/AgentPushUpdate.html +1 -1
- data/doc/Files/AgentPushUpdateBlockedError.html +1 -1
- data/doc/Files/AgentUnavailableError.html +1 -1
- data/doc/Files/AgentUpgradeRequiredError.html +1 -1
- data/doc/Files/AiAssistantPersonality.html +1 -1
- data/doc/Files/AiTask.html +1 -1
- data/doc/Files/AiTaskCannotBeRunManuallyError.html +1 -1
- data/doc/Files/AlreadyCompletedError.html +1 -1
- data/doc/Files/Api.html +20 -13
- data/doc/Files/ApiClient/RequestLogContext.html +29 -29
- data/doc/Files/ApiClient/TransferSettings.html +721 -0
- data/doc/Files/ApiClient.html +756 -204
- data/doc/Files/ApiKey.html +1 -1
- data/doc/Files/ApiKeyIsDisabledError.html +1 -1
- data/doc/Files/ApiKeyIsPathRestrictedError.html +1 -1
- data/doc/Files/ApiKeyNotFoundError.html +1 -1
- data/doc/Files/ApiKeyOnlyForDesktopAppError.html +1 -1
- data/doc/Files/ApiKeyOnlyForFileOperationsError.html +1 -1
- data/doc/Files/ApiKeyOnlyForMobileAppError.html +1 -1
- data/doc/Files/ApiKeyOnlyForOfficeIntegrationError.html +1 -1
- data/doc/Files/ApiKeySessionsNotSupportedError.html +1 -1
- data/doc/Files/ApiRequestLog.html +1 -1
- data/doc/Files/App.html +1 -1
- data/doc/Files/As2IncomingMessage.html +1 -1
- data/doc/Files/As2OutgoingMessage.html +1 -1
- data/doc/Files/As2Partner.html +1 -1
- data/doc/Files/As2Station.html +1 -1
- data/doc/Files/AttachmentTooLargeError.html +1 -1
- data/doc/Files/AuthenticationError.html +1 -1
- data/doc/Files/AuthenticationRequiredError.html +1 -1
- data/doc/Files/Auto.html +1 -1
- data/doc/Files/Automation.html +1 -1
- data/doc/Files/AutomationAuthoringSchema.html +1 -1
- data/doc/Files/AutomationCannotBeRunManuallyError.html +1 -1
- data/doc/Files/AutomationExecutionNode.html +1 -1
- data/doc/Files/AutomationLog.html +1 -1
- data/doc/Files/AutomationRun.html +1 -1
- data/doc/Files/AutomationsUnavailableError.html +1 -1
- data/doc/Files/BadRequestError.html +1 -1
- data/doc/Files/BandwidthSnapshot.html +1 -1
- data/doc/Files/Behavior.html +1 -1
- data/doc/Files/BehaviorNotAllowedOnRemoteServerError.html +1 -1
- data/doc/Files/BillingInformationHiddenError.html +1 -1
- data/doc/Files/BillingPermissionRequiredError.html +1 -1
- data/doc/Files/BufferedUploadDisabledForThisDestinationError.html +1 -1
- data/doc/Files/Bundle.html +1 -1
- data/doc/Files/BundleAction.html +1 -1
- data/doc/Files/BundleDownload.html +1 -1
- data/doc/Files/BundleMaximumUsesReachedError.html +1 -1
- data/doc/Files/BundleNotification.html +1 -1
- data/doc/Files/BundleOnlyAllowsPreviewsError.html +1 -1
- data/doc/Files/BundleOperationRequiresSubfolderError.html +1 -1
- data/doc/Files/BundlePath.html +1 -1
- data/doc/Files/BundlePathNotFoundError.html +1 -1
- data/doc/Files/BundlePermissionRequiredError.html +1 -1
- data/doc/Files/BundleRecipient.html +1 -1
- data/doc/Files/BundleRegistration.html +1 -1
- data/doc/Files/BundleRegistrationCodeFailedError.html +1 -1
- data/doc/Files/BundleRegistrationNotFoundError.html +1 -1
- data/doc/Files/CannotAdministerHigherLevelUserError.html +1 -1
- data/doc/Files/CannotDownloadDirectoryError.html +1 -1
- data/doc/Files/CannotLoginWhileUsingKeyError.html +1 -1
- data/doc/Files/CantActForOtherUserError.html +1 -1
- data/doc/Files/CantMoveWithMultipleLocationsError.html +1 -1
- data/doc/Files/ChatMessage.html +1 -1
- data/doc/Files/ChatSession.html +1 -1
- data/doc/Files/ChildSiteManagementPolicy.html +1 -1
- data/doc/Files/Clickwrap.html +1 -1
- data/doc/Files/CodeNotFoundError.html +1 -1
- data/doc/Files/ConfigurationLockedPathError.html +1 -1
- data/doc/Files/ContactAdminForPasswordChangeHelpError.html +1 -1
- data/doc/Files/CouldNotCreateParentError.html +1 -1
- data/doc/Files/CustomDomain.html +1 -1
- data/doc/Files/DatetimeParseError.html +1 -1
- data/doc/Files/DesktopConfigurationProfile.html +1 -1
- data/doc/Files/DestinationExistsError.html +1 -1
- data/doc/Files/DestinationFolderLimitedError.html +1 -1
- data/doc/Files/DestinationParentConflictError.html +1 -1
- data/doc/Files/DestinationParentDoesNotExistError.html +1 -1
- data/doc/Files/DestinationSameError.html +1 -1
- data/doc/Files/DestinationSiteMismatchError.html +1 -1
- data/doc/Files/DirectConnectionInfo.html +1 -1
- data/doc/Files/DnsRecord.html +1 -1
- data/doc/Files/DoesNotSupportSortingError.html +1 -1
- data/doc/Files/DuplicateShareRecipientError.html +1 -1
- data/doc/Files/EmailIncomingMessage.html +1 -1
- data/doc/Files/EmailLog.html +1 -1
- data/doc/Files/Error.html +2 -2
- data/doc/Files/Errors.html +1 -1
- data/doc/Files/EventChannel.html +1 -1
- data/doc/Files/EventDeliveryAttempt.html +1 -1
- data/doc/Files/EventRecord.html +1 -1
- data/doc/Files/EventSubscription.html +1 -1
- data/doc/Files/EventTarget.html +1 -1
- data/doc/Files/ExavaultApiRequestLog.html +1 -1
- data/doc/Files/ExceededRuntimeLimitError.html +1 -1
- data/doc/Files/Expectation.html +1 -1
- data/doc/Files/ExpectationAlreadyHasOpenWindowError.html +1 -1
- data/doc/Files/ExpectationEvaluation.html +1 -1
- data/doc/Files/ExpectationIncident.html +1 -1
- data/doc/Files/ExpectationNotManualTriggerError.html +1 -1
- data/doc/Files/ExpiredPrivateKeyError.html +1 -1
- data/doc/Files/ExpiredPublicKeyError.html +1 -1
- data/doc/Files/ExportFailureError.html +1 -1
- data/doc/Files/ExportNotReadyError.html +1 -1
- data/doc/Files/ExternalEvent.html +1 -1
- data/doc/Files/FailedToChangePasswordError.html +1 -1
- data/doc/Files/File.html +2019 -1515
- data/doc/Files/FileAction.html +1 -1
- data/doc/Files/FileActionError.html +1 -1
- data/doc/Files/FileComment.html +1 -1
- data/doc/Files/FileCommentReaction.html +1 -1
- data/doc/Files/FileLockedError.html +1 -1
- data/doc/Files/FileMigration.html +1 -1
- data/doc/Files/FileMigrationLog.html +1 -1
- data/doc/Files/FileNotFoundError.html +1 -1
- data/doc/Files/FileNotUploadedError.html +1 -1
- data/doc/Files/FilePendingProcessingError.html +1 -1
- data/doc/Files/FileProcessingErrorError.html +1 -1
- data/doc/Files/FileTooBigToDecryptError.html +1 -1
- data/doc/Files/FileTooBigToEncryptError.html +1 -1
- data/doc/Files/FileUploadNotFoundError.html +1 -1
- data/doc/Files/FileUploadPart.html +1 -1
- data/doc/Files/FileUploadedToWrongRegionError.html +1 -1
- data/doc/Files/FileUtils.html +1 -1
- data/doc/Files/FilenameTooLongError.html +1 -1
- data/doc/Files/FilesAgentFailedAuthorizationError.html +1 -1
- data/doc/Files/FilesNativeStorageOverloadedError.html +1 -1
- data/doc/Files/Folder.html +1 -1
- data/doc/Files/FolderAdminOrBillingPermissionRequiredError.html +1 -1
- data/doc/Files/FolderAdminPermissionRequiredError.html +1 -1
- data/doc/Files/FolderLockedError.html +1 -1
- data/doc/Files/FolderMustNotBeAFileError.html +1 -1
- data/doc/Files/FolderNotEmptyError.html +1 -1
- data/doc/Files/FoldersNotAllowedError.html +1 -1
- data/doc/Files/FormField.html +1 -1
- data/doc/Files/FormFieldSet.html +1 -1
- data/doc/Files/FtpActionLog.html +1 -1
- data/doc/Files/FullPermissionRequiredError.html +1 -1
- data/doc/Files/GpgKey.html +1 -1
- data/doc/Files/Group.html +1 -1
- data/doc/Files/GroupNotFoundError.html +1 -1
- data/doc/Files/GroupUser.html +1 -1
- data/doc/Files/History.html +1 -1
- data/doc/Files/HistoryExport.html +1 -1
- data/doc/Files/HistoryExportResult.html +1 -1
- data/doc/Files/HistoryPermissionRequiredError.html +1 -1
- data/doc/Files/HistoryUnavailableError.html +1 -1
- data/doc/Files/HolidayCalendar.html +1 -1
- data/doc/Files/HolidayRegion.html +1 -1
- data/doc/Files/Image.html +1 -1
- data/doc/Files/InAppAiAssistantUnavailableError.html +1 -1
- data/doc/Files/InboundS3Log.html +1 -1
- data/doc/Files/InboxNotFoundError.html +1 -1
- data/doc/Files/InboxRecipient.html +1 -1
- data/doc/Files/InboxRegistration.html +1 -1
- data/doc/Files/InboxRegistrationCodeFailedError.html +1 -1
- data/doc/Files/InboxUpload.html +1 -1
- data/doc/Files/InsufficientPermissionForParamsError.html +1 -1
- data/doc/Files/InsufficientPermissionForSiteError.html +1 -1
- data/doc/Files/IntegrationCentricProfile.html +1 -1
- data/doc/Files/InternalGeneralErrorError.html +1 -1
- data/doc/Files/InvalidBodyError.html +1 -1
- data/doc/Files/InvalidBundleCodeError.html +1 -1
- data/doc/Files/InvalidCredentialsError.html +1 -1
- data/doc/Files/InvalidCursorError.html +1 -1
- data/doc/Files/InvalidCursorTypeForSortError.html +1 -1
- data/doc/Files/InvalidEtagsError.html +1 -1
- data/doc/Files/InvalidFileTypeError.html +1 -1
- data/doc/Files/InvalidFilenameError.html +1 -1
- data/doc/Files/InvalidFilterAliasCombinationError.html +1 -1
- data/doc/Files/InvalidFilterFieldError.html +1 -1
- data/doc/Files/InvalidFilterParamError.html +1 -1
- data/doc/Files/InvalidFilterParamFormatError.html +1 -1
- data/doc/Files/InvalidFilterParamValueError.html +1 -1
- data/doc/Files/InvalidInputEncodingError.html +1 -1
- data/doc/Files/InvalidInterfaceError.html +1 -1
- data/doc/Files/InvalidOauthError.html +1 -1
- data/doc/Files/InvalidOauthProviderError.html +1 -1
- data/doc/Files/InvalidOrExpiredCodeError.html +1 -1
- data/doc/Files/InvalidParameterError.html +5 -1
- data/doc/Files/InvalidPathError.html +1 -1
- data/doc/Files/InvalidPriorityColorError.html +1 -1
- data/doc/Files/InvalidRangeError.html +1 -1
- data/doc/Files/InvalidReturnToUrlError.html +1 -1
- data/doc/Files/InvalidSearchQueryError.html +1 -1
- data/doc/Files/InvalidSessionError.html +1 -1
- data/doc/Files/InvalidSiteError.html +1 -1
- data/doc/Files/InvalidSortFieldError.html +1 -1
- data/doc/Files/InvalidSortFilterCombinationError.html +1 -1
- data/doc/Files/InvalidUploadOffsetError.html +1 -1
- data/doc/Files/InvalidUploadPartGapError.html +1 -1
- data/doc/Files/InvalidUploadPartSizeError.html +1 -1
- data/doc/Files/InvalidUsernameOrPasswordError.html +1 -1
- data/doc/Files/InvalidWorkspaceIdHeaderError.html +1 -1
- data/doc/Files/InvalidZipFileError.html +1 -1
- data/doc/Files/Invoice.html +1 -1
- data/doc/Files/InvoiceLineItem.html +1 -1
- data/doc/Files/IpAddress.html +1 -1
- data/doc/Files/KeyLifecycleRule.html +1 -1
- data/doc/Files/List.html +1 -1
- data/doc/Files/Lock.html +1 -1
- data/doc/Files/LockOperationBusyError.html +1 -1
- data/doc/Files/LockedOutError.html +1 -1
- data/doc/Files/LockoutRegionMismatchError.html +1 -1
- data/doc/Files/MetadataCategory.html +1 -1
- data/doc/Files/MetadataNotSupportedOnRemotesError.html +1 -1
- data/doc/Files/MethodNotAllowedError.html +1 -1
- data/doc/Files/MigrationInProgressError.html +1 -1
- data/doc/Files/MissingParameterError.html +1 -1
- data/doc/Files/ModelSaveErrorError.html +1 -1
- data/doc/Files/MoverAccessDeniedError.html +1 -1
- data/doc/Files/MoverPackageRequiredError.html +1 -1
- data/doc/Files/MultipleProcessingErrorsError.html +1 -1
- data/doc/Files/MultipleSortParamsNotAllowedError.html +1 -1
- data/doc/Files/MustAuthenticateWithApiKeyError.html +1 -1
- data/doc/Files/NeedAdminPermissionForInboxError.html +1 -1
- data/doc/Files/NestedNotFoundError.html +1 -1
- data/doc/Files/NoAccountForSiteError.html +1 -1
- data/doc/Files/NoValidInputParamsError.html +1 -1
- data/doc/Files/NonAdminsMustQueryByFolderOrPathError.html +1 -1
- data/doc/Files/NotAllowedToCreateBundleError.html +1 -1
- data/doc/Files/NotAuthenticatedError.html +1 -1
- data/doc/Files/NotAuthorizedError.html +1 -1
- data/doc/Files/NotEnqueuableSyncError.html +1 -1
- data/doc/Files/NotFoundError.html +1 -1
- data/doc/Files/NotImplementedError.html +1 -1
- data/doc/Files/Notification.html +1 -1
- data/doc/Files/OffsetUploadNotAllowedWithMalwareScanningError.html +1 -1
- data/doc/Files/OneTimePasswordIncorrectError.html +1 -1
- data/doc/Files/OutboundConnectionLog.html +1 -1
- data/doc/Files/PartNumberTooLargeError.html +1 -1
- data/doc/Files/Partner.html +1 -1
- data/doc/Files/PartnerChannel.html +1 -1
- data/doc/Files/PartnerChannelTemplate.html +1 -1
- data/doc/Files/PartnerConnection.html +1 -1
- data/doc/Files/PartnerSite.html +1 -1
- data/doc/Files/PartnerSiteRequest.html +1 -1
- data/doc/Files/PasswordChangeNotRequiredError.html +1 -1
- data/doc/Files/PasswordChangeRequiredError.html +1 -1
- data/doc/Files/PathCannotHaveTrailingWhitespaceError.html +1 -1
- data/doc/Files/PathTooLongError.html +1 -1
- data/doc/Files/PathUtil.html +1 -1
- data/doc/Files/Payment.html +1 -1
- data/doc/Files/PaymentLineItem.html +1 -1
- data/doc/Files/PaymentMethodErrorError.html +1 -1
- data/doc/Files/PendingWorkEvent.html +1 -1
- data/doc/Files/Permission.html +1 -1
- data/doc/Files/PlanNotFoundError.html +1 -1
- data/doc/Files/Preview.html +1 -1
- data/doc/Files/PreviewOnlyPermissionCannotDownloadError.html +1 -1
- data/doc/Files/ProcessingFailureError.html +1 -1
- data/doc/Files/PublicHostingRequestLog.html +1 -1
- data/doc/Files/PublicIpAddress.html +1 -1
- data/doc/Files/PublicKey.html +1 -1
- data/doc/Files/RateLimitedError.html +1 -1
- data/doc/Files/ReadOnlySessionError.html +1 -1
- data/doc/Files/ReadPermissionRequiredError.html +1 -1
- data/doc/Files/ReauthenticationFailedError.html +1 -1
- data/doc/Files/ReauthenticationFailedFinalError.html +1 -1
- data/doc/Files/ReauthenticationNeededActionError.html +1 -1
- data/doc/Files/ReauthenticationNeededFieldsError.html +1 -1
- data/doc/Files/ReauthenticationRateLimitedError.html +1 -1
- data/doc/Files/RecaptchaFailedError.html +1 -1
- data/doc/Files/RecipientAlreadySharedError.html +1 -1
- data/doc/Files/RemoteBandwidthSnapshot.html +1 -1
- data/doc/Files/RemoteDesktopDebugLoggingDisabledError.html +1 -1
- data/doc/Files/RemoteEntryReadOnlyError.html +1 -1
- data/doc/Files/RemoteMountBackend.html +1 -1
- data/doc/Files/RemoteServer.html +1 -1
- data/doc/Files/RemoteServerConfigurationFile.html +1 -1
- data/doc/Files/RemoteServerCredential.html +1 -1
- data/doc/Files/RemoteServerErrorError.html +1 -1
- data/doc/Files/Request.html +1 -1
- data/doc/Files/RequestBodyTooLargeError.html +1 -1
- data/doc/Files/RequestParamsContainInvalidCharacterError.html +1 -1
- data/doc/Files/RequestParamsInvalidError.html +1 -1
- data/doc/Files/RequestParamsRequiredError.html +1 -1
- data/doc/Files/ResourceBelongsToParentSiteError.html +1 -1
- data/doc/Files/ResourceLockedError.html +1 -1
- data/doc/Files/Response.html +1 -1
- data/doc/Files/Restore.html +1 -1
- data/doc/Files/RootFolderBehaviorSiteAdminRequiredError.html +1 -1
- data/doc/Files/RootFolderBehaviorSkipSiteAdminRequiredError.html +1 -1
- data/doc/Files/Schedule.html +1 -1
- data/doc/Files/ScheduledExport.html +1 -1
- data/doc/Files/ScimLog.html +1 -1
- data/doc/Files/SearchAllOnChildPathError.html +1 -1
- data/doc/Files/SearchUnavailableError.html +1 -1
- data/doc/Files/Secret.html +1 -1
- data/doc/Files/SelfManagedRequiredError.html +1 -1
- data/doc/Files/ServiceUnavailableError.html +1 -1
- data/doc/Files/Session.html +1 -1
- data/doc/Files/SettingsChange.html +1 -1
- data/doc/Files/SftpActionLog.html +1 -1
- data/doc/Files/SftpHostKey.html +1 -1
- data/doc/Files/ShareGroup.html +1 -1
- data/doc/Files/ShareGroupMember.html +1 -1
- data/doc/Files/SiemHttpDestination.html +1 -1
- data/doc/Files/SiemHttpDestinationEvent.html +1 -1
- data/doc/Files/Site.html +911 -731
- data/doc/Files/SiteAdminOrPartnerAdminPermissionRequiredError.html +1 -1
- data/doc/Files/SiteAdminOrWorkspaceAdminOrFolderAdminPermissionRequiredError.html +1 -1
- data/doc/Files/SiteAdminOrWorkspaceAdminOrPartnerAdminOrFolderAdminPermissionRequiredError.html +1 -1
- data/doc/Files/SiteAdminOrWorkspaceAdminOrPartnerAdminPermissionRequiredError.html +1 -1
- data/doc/Files/SiteAdminOrWorkspaceAdminPermissionRequiredError.html +1 -1
- data/doc/Files/SiteAdminRequiredError.html +1 -1
- data/doc/Files/SiteConfigurationError.html +1 -1
- data/doc/Files/SiteDisabledError.html +1 -1
- data/doc/Files/SiteFilesAreImmutableError.html +1 -1
- data/doc/Files/SiteNotFoundError.html +1 -1
- data/doc/Files/SiteSubdomainRedirect.html +1 -1
- data/doc/Files/SiteWasRemovedError.html +1 -1
- data/doc/Files/SizableIO.html +1 -1
- data/doc/Files/Snapshot.html +1 -1
- data/doc/Files/SsoEvent.html +1 -1
- data/doc/Files/SsoStrategy.html +1 -1
- data/doc/Files/Status.html +1 -1
- data/doc/Files/Style.html +1 -1
- data/doc/Files/SubfolderLockedError.html +1 -1
- data/doc/Files/Sync.html +1 -1
- data/doc/Files/SyncInProgressError.html +1 -1
- data/doc/Files/SyncLog.html +1 -1
- data/doc/Files/SyncRun.html +1 -1
- data/doc/Files/SyncRunLiveTransfer.html +1 -1
- data/doc/Files/SystemProfiler.html +1 -1
- data/doc/Files/TooManyConcurrentLoginsError.html +1 -1
- data/doc/Files/TooManyConcurrentRequestsError.html +1 -1
- data/doc/Files/TooManyLoginAttemptsError.html +1 -1
- data/doc/Files/TooManyRequestsError.html +1 -1
- data/doc/Files/TooManySharesError.html +1 -1
- data/doc/Files/Transfer/BufferLimitError.html +175 -0
- data/doc/Files/Transfer/ByteBudget/Reservation.html +301 -0
- data/doc/Files/Transfer/ByteBudget.html +748 -0
- data/doc/Files/Transfer/CancelledError.html +235 -0
- data/doc/Files/Transfer/Checkpoint.html +1371 -0
- data/doc/Files/Transfer/CheckpointError.html +173 -0
- data/doc/Files/Transfer/ClientTransport/ClientResponse.html +661 -0
- data/doc/Files/Transfer/ClientTransport/Reader.html +530 -0
- data/doc/Files/Transfer/ClientTransport.html +675 -0
- data/doc/Files/Transfer/Clock.html +189 -0
- data/doc/Files/Transfer/Control.html +667 -0
- data/doc/Files/Transfer/Controller/Attempt.html +465 -0
- data/doc/Files/Transfer/Controller.html +1166 -0
- data/doc/Files/Transfer/Coordinator/Timing.html +568 -0
- data/doc/Files/Transfer/Coordinator.html +534 -0
- data/doc/Files/Transfer/DownloadCoordinator/FileSink.html +976 -0
- data/doc/Files/Transfer/DownloadCoordinator/IoSink.html +1168 -0
- data/doc/Files/Transfer/DownloadCoordinator/Piece.html +875 -0
- data/doc/Files/Transfer/DownloadCoordinator.html +728 -0
- data/doc/Files/Transfer/FileSlots.html +480 -0
- data/doc/Files/Transfer/FrontendResponseError.html +235 -0
- data/doc/Files/Transfer/Holds.html +505 -0
- data/doc/Files/Transfer/HttpTransport.html +579 -0
- data/doc/Files/Transfer/Job.html +2338 -0
- data/doc/Files/Transfer/Options.html +924 -0
- data/doc/Files/Transfer/PausedError.html +319 -0
- data/doc/Files/Transfer/Policy.html +1642 -0
- data/doc/Files/Transfer/RequestPermits.html +160 -0
- data/doc/Files/Transfer/SourceChangedError.html +235 -0
- data/doc/Files/Transfer/StorageResponse.html +546 -0
- data/doc/Files/Transfer/StorageRetry.html +1098 -0
- data/doc/Files/Transfer/UploadCoordinator/Grant.html +1048 -0
- data/doc/Files/Transfer/UploadCoordinator/Part.html +1048 -0
- data/doc/Files/Transfer/UploadCoordinator/Region.html +295 -0
- data/doc/Files/Transfer/UploadCoordinator/Segments.html +299 -0
- data/doc/Files/Transfer/UploadCoordinator/Source.html +725 -0
- data/doc/Files/Transfer/UploadCoordinator/StreamSource.html +664 -0
- data/doc/Files/Transfer/UploadCoordinator.html +546 -0
- data/doc/Files/Transfer/UploadPlan.html +522 -0
- data/doc/Files/Transfer/VersionChangedError.html +235 -0
- data/doc/Files/Transfer.html +134 -0
- data/doc/Files/TrialExpiredError.html +1 -1
- data/doc/Files/TrialLockedError.html +1 -1
- data/doc/Files/TwoFactorAuthenticationCodeAlreadySentError.html +1 -1
- data/doc/Files/TwoFactorAuthenticationCountryBlacklistedError.html +1 -1
- data/doc/Files/TwoFactorAuthenticationErrorError.html +1 -1
- data/doc/Files/TwoFactorAuthenticationGeneralErrorError.html +1 -1
- data/doc/Files/TwoFactorAuthenticationMethodUnsupportedErrorError.html +1 -1
- data/doc/Files/TwoFactorAuthenticationRequiredError.html +1 -1
- data/doc/Files/TwoFactorAuthenticationSetupExpiredError.html +1 -1
- data/doc/Files/TwoFactorAuthenticationUnsubscribedRecipientError.html +1 -1
- data/doc/Files/URI.html +1 -1
- data/doc/Files/UnrecognizedSortIndexError.html +1 -1
- data/doc/Files/UnsupportedCurrencyError.html +1 -1
- data/doc/Files/UnsupportedHttpResponseFormatError.html +1 -1
- data/doc/Files/UnsupportedMediaTypeError.html +1 -1
- data/doc/Files/UpdatesNotAllowedForRemotesError.html +1 -1
- data/doc/Files/UploadsUnavailableError.html +1 -1
- data/doc/Files/UsageByTopLevelDir.html +1 -1
- data/doc/Files/UsageDailySnapshot.html +1 -1
- data/doc/Files/UsageSnapshot.html +1 -1
- data/doc/Files/User.html +597 -386
- data/doc/Files/UserAdditionalEmailRecipient.html +1 -1
- data/doc/Files/UserCipherUse.html +1 -1
- data/doc/Files/UserIdInvalidError.html +1 -1
- data/doc/Files/UserIdOnUserEndpointError.html +1 -1
- data/doc/Files/UserIdWithoutSiteAdminError.html +1 -1
- data/doc/Files/UserLifecycleRule.html +1 -1
- data/doc/Files/UserNotFoundError.html +1 -1
- data/doc/Files/UserRequest.html +1 -1
- data/doc/Files/UserRequestsEnabledRequiredError.html +1 -1
- data/doc/Files/UserRequiredError.html +1 -1
- data/doc/Files/UserSecurityEvent.html +1 -1
- data/doc/Files/UserSftpClientUse.html +1 -1
- data/doc/Files/Util/LogSettings.html +1 -1
- data/doc/Files/Util.html +1 -1
- data/doc/Files/WebDavActionLog.html +1 -1
- data/doc/Files/WebhookTest.html +1 -1
- data/doc/Files/Workspace.html +1 -1
- data/doc/Files/WriteAndBundlePermissionRequiredError.html +1 -1
- data/doc/Files/WritePermissionRequiredError.html +1 -1
- data/doc/Files/ZipListEntry.html +1 -1
- data/doc/Files.html +116 -116
- data/doc/_index.html +314 -4
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +1 -1
- data/doc/index.html +1 -1
- data/doc/method_list.html +5368 -3048
- data/doc/top-level-namespace.html +1 -1
- data/docs/file.md +346 -0
- data/docs/site.md +10 -0
- data/docs/user.md +8 -0
- data/lib/files.com/api.rb +6 -1
- data/lib/files.com/api_client.rb +220 -32
- data/lib/files.com/models/file.rb +124 -17
- data/lib/files.com/models/site.rb +16 -0
- data/lib/files.com/models/user.rb +19 -0
- data/lib/files.com/transfer/budgets.rb +123 -0
- data/lib/files.com/transfer/checkpoint.rb +113 -0
- data/lib/files.com/transfer/clock.rb +14 -0
- data/lib/files.com/transfer/controller.rb +549 -0
- data/lib/files.com/transfer/download_coordinator.rb +906 -0
- data/lib/files.com/transfer/errors.rb +100 -0
- data/lib/files.com/transfer/http_transport.rb +337 -0
- data/lib/files.com/transfer/job.rb +778 -0
- data/lib/files.com/transfer/options.rb +126 -0
- data/lib/files.com/transfer/policy.rb +91 -0
- data/lib/files.com/transfer/storage_retry.rb +169 -0
- data/lib/files.com/transfer/upload_coordinator.rb +657 -0
- data/lib/files.com/transfer/upload_plan.rb +157 -0
- data/lib/files.com.rb +13 -0
- data/spec/lib/api_client_spec.rb +125 -3
- data/spec/models/file_transfer_spec.rb +53 -4
- data/spec/support/transfer_server.rb +113 -14
- data/spec/transfer/adaptive_download_spec.rb +1102 -0
- data/spec/transfer/adaptive_upload_spec.rb +1602 -0
- data/spec/transfer/concurrency_controller_spec.rb +382 -0
- data/spec/workspace_id_spec.rb +19 -14
- metadata +59 -1
|
@@ -0,0 +1,924 @@
|
|
|
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::Options
|
|
8
|
+
|
|
9
|
+
— 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::Options";
|
|
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 (O)</a> »
|
|
42
|
+
<span class='title'><span class='object_link'><a href="../../Files.html" title="Files (module)">Files</a></span></span> » <span class='title'><span class='object_link'><a href="../Transfer.html" title="Files::Transfer (module)">Transfer</a></span></span>
|
|
43
|
+
»
|
|
44
|
+
<span class="title">Options</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::Options
|
|
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::Options</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/options.rb
|
|
100
|
+
</dd>
|
|
101
|
+
</dl>
|
|
102
|
+
|
|
103
|
+
</div>
|
|
104
|
+
|
|
105
|
+
<h2>Overview</h2><div class="docstring">
|
|
106
|
+
<div class="discussion">
|
|
107
|
+
<p>What an adaptive transfer may use. The transfer: option takes these as a Hash, true for all the defaults, an
|
|
108
|
+
Options or a Job that several transfers share.</p>
|
|
109
|
+
<dl>
|
|
110
|
+
<dt>concurrency</dt>
|
|
111
|
+
<dd><p>:automatic (the default) tunes the requests in flight from what the link sustains; an Integer from
|
|
112
|
+
1 to 256 keeps exactly that many.</p></dd>
|
|
113
|
+
<dt>startup</dt>
|
|
114
|
+
<dd><p>With :automatic, :default starts an upload to cloud storage with one request and grows while each
|
|
115
|
+
step pays off; :aggressive starts at 32. Downloads and direct destinations ignore it.</p></dd>
|
|
116
|
+
<dt>max_concurrency</dt>
|
|
117
|
+
<dd><p>With :automatic, the most requests in flight, from 1 to 256. The default is 64 for cloud
|
|
118
|
+
storage and downloads and 16 for direct destinations, which it can only lower.</p></dd>
|
|
119
|
+
<dt>buffer_bytes</dt>
|
|
120
|
+
<dd><p>The most bytes held in memory at once for parts waiting to be sent or written, at least 65,536.
|
|
121
|
+
The default is 256 MiB.</p></dd>
|
|
122
|
+
<dt>max_files</dt>
|
|
123
|
+
<dd><p>How many files a shared Job transfers at once; more wait their turn. The default is 4.</p></dd>
|
|
124
|
+
<dt>control</dt>
|
|
125
|
+
<dd><p>A Control that cancels or pauses the transfer.</p></dd>
|
|
126
|
+
</dl>
|
|
127
|
+
|
|
128
|
+
</div>
|
|
129
|
+
</div>
|
|
130
|
+
<div class="tags">
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
</div>
|
|
134
|
+
|
|
135
|
+
<h2>
|
|
136
|
+
Constant Summary
|
|
137
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
|
138
|
+
</h2>
|
|
139
|
+
|
|
140
|
+
<dl class="constants">
|
|
141
|
+
|
|
142
|
+
<dt id="MAX_CONCURRENCY-constant" class="">MAX_CONCURRENCY =
|
|
143
|
+
|
|
144
|
+
</dt>
|
|
145
|
+
<dd><pre class="code"><span class='int'>256</span></pre></dd>
|
|
146
|
+
|
|
147
|
+
<dt id="DEFAULT_BUFFER_BYTES-constant" class="">DEFAULT_BUFFER_BYTES =
|
|
148
|
+
|
|
149
|
+
</dt>
|
|
150
|
+
<dd><pre class="code"><span class='int'>256</span> <span class='op'>*</span> <span class='int'>1024</span> <span class='op'>*</span> <span class='int'>1024</span></pre></dd>
|
|
151
|
+
|
|
152
|
+
<dt id="MIN_BUFFER_BYTES-constant" class="">MIN_BUFFER_BYTES =
|
|
153
|
+
|
|
154
|
+
</dt>
|
|
155
|
+
<dd><pre class="code"><span class='int'>64</span> <span class='op'>*</span> <span class='int'>1024</span></pre></dd>
|
|
156
|
+
|
|
157
|
+
<dt id="DEFAULT_MAX_FILES-constant" class="">DEFAULT_MAX_FILES =
|
|
158
|
+
|
|
159
|
+
</dt>
|
|
160
|
+
<dd><pre class="code"><span class='int'>4</span></pre></dd>
|
|
161
|
+
|
|
162
|
+
<dt id="KEYS-constant" class="">KEYS =
|
|
163
|
+
|
|
164
|
+
</dt>
|
|
165
|
+
<dd><pre class="code"><span class='qsymbols_beg'>%i[</span><span class='tstring_content'>concurrency</span><span class='words_sep'> </span><span class='tstring_content'>startup</span><span class='words_sep'> </span><span class='tstring_content'>max_concurrency</span><span class='words_sep'> </span><span class='tstring_content'>buffer_bytes</span><span class='words_sep'> </span><span class='tstring_content'>max_files</span><span class='words_sep'> </span><span class='tstring_content'>control</span><span class='tstring_end'>]</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
|
166
|
+
|
|
167
|
+
<dt id="STARTUPS-constant" class="">STARTUPS =
|
|
168
|
+
|
|
169
|
+
</dt>
|
|
170
|
+
<dd><pre class="code"><span class='qsymbols_beg'>%i[</span><span class='tstring_content'>default</span><span class='words_sep'> </span><span class='tstring_content'>aggressive</span><span class='tstring_end'>]</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
|
171
|
+
|
|
172
|
+
</dl>
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
179
|
+
<ul class="summary">
|
|
180
|
+
|
|
181
|
+
<li class="public ">
|
|
182
|
+
<span class="summary_signature">
|
|
183
|
+
|
|
184
|
+
<a href="#buffer_bytes-instance_method" title="#buffer_bytes (instance method)">#<strong>buffer_bytes</strong> ⇒ Object </a>
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
</span>
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
<span class="note title readonly">readonly</span>
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute buffer_bytes.</p></div></span>
|
|
204
|
+
|
|
205
|
+
</li>
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
<li class="public ">
|
|
209
|
+
<span class="summary_signature">
|
|
210
|
+
|
|
211
|
+
<a href="#concurrency-instance_method" title="#concurrency (instance method)">#<strong>concurrency</strong> ⇒ Object </a>
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
</span>
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
<span class="note title readonly">readonly</span>
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute concurrency.</p></div></span>
|
|
231
|
+
|
|
232
|
+
</li>
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
<li class="public ">
|
|
236
|
+
<span class="summary_signature">
|
|
237
|
+
|
|
238
|
+
<a href="#control-instance_method" title="#control (instance method)">#<strong>control</strong> ⇒ Object </a>
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
</span>
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
<span class="note title readonly">readonly</span>
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute control.</p></div></span>
|
|
258
|
+
|
|
259
|
+
</li>
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
<li class="public ">
|
|
263
|
+
<span class="summary_signature">
|
|
264
|
+
|
|
265
|
+
<a href="#max_concurrency-instance_method" title="#max_concurrency (instance method)">#<strong>max_concurrency</strong> ⇒ Object </a>
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
</span>
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
<span class="note title readonly">readonly</span>
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute max_concurrency.</p></div></span>
|
|
285
|
+
|
|
286
|
+
</li>
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
<li class="public ">
|
|
290
|
+
<span class="summary_signature">
|
|
291
|
+
|
|
292
|
+
<a href="#max_files-instance_method" title="#max_files (instance method)">#<strong>max_files</strong> ⇒ Object </a>
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
</span>
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
<span class="note title readonly">readonly</span>
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute max_files.</p></div></span>
|
|
312
|
+
|
|
313
|
+
</li>
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
<li class="public ">
|
|
317
|
+
<span class="summary_signature">
|
|
318
|
+
|
|
319
|
+
<a href="#startup-instance_method" title="#startup (instance method)">#<strong>startup</strong> ⇒ Object </a>
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
</span>
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
<span class="note title readonly">readonly</span>
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute startup.</p></div></span>
|
|
339
|
+
|
|
340
|
+
</li>
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
</ul>
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
<h2>
|
|
350
|
+
Class Method Summary
|
|
351
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
352
|
+
</h2>
|
|
353
|
+
|
|
354
|
+
<ul class="summary">
|
|
355
|
+
|
|
356
|
+
<li class="public ">
|
|
357
|
+
<span class="summary_signature">
|
|
358
|
+
|
|
359
|
+
<a href="#from-class_method" title="from (class method)">.<strong>from</strong>(value) ⇒ Object </a>
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
</span>
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
374
|
+
|
|
375
|
+
</li>
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
</ul>
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
<h2>
|
|
382
|
+
Instance Method Summary
|
|
383
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
384
|
+
</h2>
|
|
385
|
+
|
|
386
|
+
<ul class="summary">
|
|
387
|
+
|
|
388
|
+
<li class="public ">
|
|
389
|
+
<span class="summary_signature">
|
|
390
|
+
|
|
391
|
+
<a href="#automatic%3F-instance_method" title="#automatic? (instance method)">#<strong>automatic?</strong> ⇒ Boolean </a>
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
</span>
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
406
|
+
|
|
407
|
+
</li>
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
<li class="public ">
|
|
411
|
+
<span class="summary_signature">
|
|
412
|
+
|
|
413
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(concurrency: :automatic, startup: :default, max_concurrency: nil, buffer_bytes: DEFAULT_BUFFER_BYTES, max_files: DEFAULT_MAX_FILES, control: nil) ⇒ Options </a>
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
</span>
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
<span class="note title constructor">constructor</span>
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
<span class="summary_desc"><div class='inline'><p>A new instance of Options.</p></div></span>
|
|
430
|
+
|
|
431
|
+
</li>
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
<li class="public ">
|
|
435
|
+
<span class="summary_signature">
|
|
436
|
+
|
|
437
|
+
<a href="#to_h-instance_method" title="#to_h (instance method)">#<strong>to_h</strong> ⇒ Object </a>
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
</span>
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
452
|
+
|
|
453
|
+
</li>
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
</ul>
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
<div id="constructor_details" class="method_details_list">
|
|
461
|
+
<h2>Constructor Details</h2>
|
|
462
|
+
|
|
463
|
+
<div class="method_details first">
|
|
464
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
465
|
+
|
|
466
|
+
#<strong>initialize</strong>(concurrency: :automatic, startup: :default, max_concurrency: nil, buffer_bytes: DEFAULT_BUFFER_BYTES, max_files: DEFAULT_MAX_FILES, control: nil) ⇒ <tt><span class='object_link'><a href="" title="Files::Transfer::Options (class)">Options</a></span></tt>
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
</h3><div class="docstring">
|
|
473
|
+
<div class="discussion">
|
|
474
|
+
<p>Returns a new instance of Options.</p>
|
|
475
|
+
|
|
476
|
+
</div>
|
|
477
|
+
</div>
|
|
478
|
+
<div class="tags">
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
</div><table class="source_code">
|
|
482
|
+
<tr>
|
|
483
|
+
<td>
|
|
484
|
+
<pre class="lines">
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
92
|
|
488
|
+
93
|
|
489
|
+
94
|
|
490
|
+
95
|
|
491
|
+
96
|
|
492
|
+
97
|
|
493
|
+
98
|
|
494
|
+
99
|
|
495
|
+
100
|
|
496
|
+
101</pre>
|
|
497
|
+
</td>
|
|
498
|
+
<td>
|
|
499
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/options.rb', line 92</span>
|
|
500
|
+
|
|
501
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>concurrency:</span> <span class='symbol'>:automatic</span><span class='comma'>,</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='comma'>,</span> <span class='label'>buffer_bytes:</span> <span class='const'><span class='object_link'><a href="#DEFAULT_BUFFER_BYTES-constant" title="Files::Transfer::Options::DEFAULT_BUFFER_BYTES (constant)">DEFAULT_BUFFER_BYTES</a></span></span><span class='comma'>,</span> <span class='label'>max_files:</span> <span class='const'><span class='object_link'><a href="#DEFAULT_MAX_FILES-constant" title="Files::Transfer::Options::DEFAULT_MAX_FILES (constant)">DEFAULT_MAX_FILES</a></span></span><span class='comma'>,</span> <span class='label'>control:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
502
|
+
<span class='ivar'>@concurrency</span> <span class='op'>=</span> <span class='id identifier rubyid_concurrency'>concurrency</span>
|
|
503
|
+
<span class='ivar'>@startup</span> <span class='op'>=</span> <span class='id identifier rubyid_startup'>startup</span>
|
|
504
|
+
<span class='ivar'>@max_concurrency</span> <span class='op'>=</span> <span class='id identifier rubyid_max_concurrency'>max_concurrency</span>
|
|
505
|
+
<span class='ivar'>@buffer_bytes</span> <span class='op'>=</span> <span class='id identifier rubyid_buffer_bytes'>buffer_bytes</span>
|
|
506
|
+
<span class='ivar'>@max_files</span> <span class='op'>=</span> <span class='id identifier rubyid_max_files'>max_files</span>
|
|
507
|
+
<span class='ivar'>@control</span> <span class='op'>=</span> <span class='id identifier rubyid_control'>control</span>
|
|
508
|
+
<span class='id identifier rubyid_validate'>validate</span>
|
|
509
|
+
<span class='id identifier rubyid_freeze'>freeze</span>
|
|
510
|
+
<span class='kw'>end</span></pre>
|
|
511
|
+
</td>
|
|
512
|
+
</tr>
|
|
513
|
+
</table>
|
|
514
|
+
</div>
|
|
515
|
+
|
|
516
|
+
</div>
|
|
517
|
+
|
|
518
|
+
<div id="instance_attr_details" class="attr_details">
|
|
519
|
+
<h2>Instance Attribute Details</h2>
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
<span id=""></span>
|
|
523
|
+
<div class="method_details first">
|
|
524
|
+
<h3 class="signature first" id="buffer_bytes-instance_method">
|
|
525
|
+
|
|
526
|
+
#<strong>buffer_bytes</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
</h3><div class="docstring">
|
|
533
|
+
<div class="discussion">
|
|
534
|
+
<p>Returns the value of attribute buffer_bytes.</p>
|
|
535
|
+
|
|
536
|
+
</div>
|
|
537
|
+
</div>
|
|
538
|
+
<div class="tags">
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
</div><table class="source_code">
|
|
542
|
+
<tr>
|
|
543
|
+
<td>
|
|
544
|
+
<pre class="lines">
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
76
|
|
548
|
+
77
|
|
549
|
+
78</pre>
|
|
550
|
+
</td>
|
|
551
|
+
<td>
|
|
552
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/options.rb', line 76</span>
|
|
553
|
+
|
|
554
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_buffer_bytes'>buffer_bytes</span>
|
|
555
|
+
<span class='ivar'>@buffer_bytes</span>
|
|
556
|
+
<span class='kw'>end</span></pre>
|
|
557
|
+
</td>
|
|
558
|
+
</tr>
|
|
559
|
+
</table>
|
|
560
|
+
</div>
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
<span id=""></span>
|
|
564
|
+
<div class="method_details ">
|
|
565
|
+
<h3 class="signature " id="concurrency-instance_method">
|
|
566
|
+
|
|
567
|
+
#<strong>concurrency</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
568
|
+
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
|
|
572
|
+
|
|
573
|
+
</h3><div class="docstring">
|
|
574
|
+
<div class="discussion">
|
|
575
|
+
<p>Returns the value of attribute concurrency.</p>
|
|
576
|
+
|
|
577
|
+
</div>
|
|
578
|
+
</div>
|
|
579
|
+
<div class="tags">
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
</div><table class="source_code">
|
|
583
|
+
<tr>
|
|
584
|
+
<td>
|
|
585
|
+
<pre class="lines">
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
76
|
|
589
|
+
77
|
|
590
|
+
78</pre>
|
|
591
|
+
</td>
|
|
592
|
+
<td>
|
|
593
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/options.rb', line 76</span>
|
|
594
|
+
|
|
595
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_concurrency'>concurrency</span>
|
|
596
|
+
<span class='ivar'>@concurrency</span>
|
|
597
|
+
<span class='kw'>end</span></pre>
|
|
598
|
+
</td>
|
|
599
|
+
</tr>
|
|
600
|
+
</table>
|
|
601
|
+
</div>
|
|
602
|
+
|
|
603
|
+
|
|
604
|
+
<span id=""></span>
|
|
605
|
+
<div class="method_details ">
|
|
606
|
+
<h3 class="signature " id="control-instance_method">
|
|
607
|
+
|
|
608
|
+
#<strong>control</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
</h3><div class="docstring">
|
|
615
|
+
<div class="discussion">
|
|
616
|
+
<p>Returns the value of attribute control.</p>
|
|
617
|
+
|
|
618
|
+
</div>
|
|
619
|
+
</div>
|
|
620
|
+
<div class="tags">
|
|
621
|
+
|
|
622
|
+
|
|
623
|
+
</div><table class="source_code">
|
|
624
|
+
<tr>
|
|
625
|
+
<td>
|
|
626
|
+
<pre class="lines">
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
76
|
|
630
|
+
77
|
|
631
|
+
78</pre>
|
|
632
|
+
</td>
|
|
633
|
+
<td>
|
|
634
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/options.rb', line 76</span>
|
|
635
|
+
|
|
636
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_control'>control</span>
|
|
637
|
+
<span class='ivar'>@control</span>
|
|
638
|
+
<span class='kw'>end</span></pre>
|
|
639
|
+
</td>
|
|
640
|
+
</tr>
|
|
641
|
+
</table>
|
|
642
|
+
</div>
|
|
643
|
+
|
|
644
|
+
|
|
645
|
+
<span id=""></span>
|
|
646
|
+
<div class="method_details ">
|
|
647
|
+
<h3 class="signature " id="max_concurrency-instance_method">
|
|
648
|
+
|
|
649
|
+
#<strong>max_concurrency</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
</h3><div class="docstring">
|
|
656
|
+
<div class="discussion">
|
|
657
|
+
<p>Returns the value of attribute max_concurrency.</p>
|
|
658
|
+
|
|
659
|
+
</div>
|
|
660
|
+
</div>
|
|
661
|
+
<div class="tags">
|
|
662
|
+
|
|
663
|
+
|
|
664
|
+
</div><table class="source_code">
|
|
665
|
+
<tr>
|
|
666
|
+
<td>
|
|
667
|
+
<pre class="lines">
|
|
668
|
+
|
|
669
|
+
|
|
670
|
+
76
|
|
671
|
+
77
|
|
672
|
+
78</pre>
|
|
673
|
+
</td>
|
|
674
|
+
<td>
|
|
675
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/options.rb', line 76</span>
|
|
676
|
+
|
|
677
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_max_concurrency'>max_concurrency</span>
|
|
678
|
+
<span class='ivar'>@max_concurrency</span>
|
|
679
|
+
<span class='kw'>end</span></pre>
|
|
680
|
+
</td>
|
|
681
|
+
</tr>
|
|
682
|
+
</table>
|
|
683
|
+
</div>
|
|
684
|
+
|
|
685
|
+
|
|
686
|
+
<span id=""></span>
|
|
687
|
+
<div class="method_details ">
|
|
688
|
+
<h3 class="signature " id="max_files-instance_method">
|
|
689
|
+
|
|
690
|
+
#<strong>max_files</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
691
|
+
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
|
|
696
|
+
</h3><div class="docstring">
|
|
697
|
+
<div class="discussion">
|
|
698
|
+
<p>Returns the value of attribute max_files.</p>
|
|
699
|
+
|
|
700
|
+
</div>
|
|
701
|
+
</div>
|
|
702
|
+
<div class="tags">
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
</div><table class="source_code">
|
|
706
|
+
<tr>
|
|
707
|
+
<td>
|
|
708
|
+
<pre class="lines">
|
|
709
|
+
|
|
710
|
+
|
|
711
|
+
76
|
|
712
|
+
77
|
|
713
|
+
78</pre>
|
|
714
|
+
</td>
|
|
715
|
+
<td>
|
|
716
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/options.rb', line 76</span>
|
|
717
|
+
|
|
718
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_max_files'>max_files</span>
|
|
719
|
+
<span class='ivar'>@max_files</span>
|
|
720
|
+
<span class='kw'>end</span></pre>
|
|
721
|
+
</td>
|
|
722
|
+
</tr>
|
|
723
|
+
</table>
|
|
724
|
+
</div>
|
|
725
|
+
|
|
726
|
+
|
|
727
|
+
<span id=""></span>
|
|
728
|
+
<div class="method_details ">
|
|
729
|
+
<h3 class="signature " id="startup-instance_method">
|
|
730
|
+
|
|
731
|
+
#<strong>startup</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
|
|
737
|
+
</h3><div class="docstring">
|
|
738
|
+
<div class="discussion">
|
|
739
|
+
<p>Returns the value of attribute startup.</p>
|
|
740
|
+
|
|
741
|
+
</div>
|
|
742
|
+
</div>
|
|
743
|
+
<div class="tags">
|
|
744
|
+
|
|
745
|
+
|
|
746
|
+
</div><table class="source_code">
|
|
747
|
+
<tr>
|
|
748
|
+
<td>
|
|
749
|
+
<pre class="lines">
|
|
750
|
+
|
|
751
|
+
|
|
752
|
+
76
|
|
753
|
+
77
|
|
754
|
+
78</pre>
|
|
755
|
+
</td>
|
|
756
|
+
<td>
|
|
757
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/options.rb', line 76</span>
|
|
758
|
+
|
|
759
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_startup'>startup</span>
|
|
760
|
+
<span class='ivar'>@startup</span>
|
|
761
|
+
<span class='kw'>end</span></pre>
|
|
762
|
+
</td>
|
|
763
|
+
</tr>
|
|
764
|
+
</table>
|
|
765
|
+
</div>
|
|
766
|
+
|
|
767
|
+
</div>
|
|
768
|
+
|
|
769
|
+
|
|
770
|
+
<div id="class_method_details" class="method_details_list">
|
|
771
|
+
<h2>Class Method Details</h2>
|
|
772
|
+
|
|
773
|
+
|
|
774
|
+
<div class="method_details first">
|
|
775
|
+
<h3 class="signature first" id="from-class_method">
|
|
776
|
+
|
|
777
|
+
.<strong>from</strong>(value) ⇒ <tt>Object</tt>
|
|
778
|
+
|
|
779
|
+
|
|
780
|
+
|
|
781
|
+
|
|
782
|
+
|
|
783
|
+
</h3><table class="source_code">
|
|
784
|
+
<tr>
|
|
785
|
+
<td>
|
|
786
|
+
<pre class="lines">
|
|
787
|
+
|
|
788
|
+
|
|
789
|
+
78
|
|
790
|
+
79
|
|
791
|
+
80
|
|
792
|
+
81
|
|
793
|
+
82
|
|
794
|
+
83
|
|
795
|
+
84
|
|
796
|
+
85
|
|
797
|
+
86
|
|
798
|
+
87
|
|
799
|
+
88
|
|
800
|
+
89
|
|
801
|
+
90</pre>
|
|
802
|
+
</td>
|
|
803
|
+
<td>
|
|
804
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/options.rb', line 78</span>
|
|
805
|
+
|
|
806
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_from'>from</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
|
|
807
|
+
<span class='kw'>case</span> <span class='id identifier rubyid_value'>value</span>
|
|
808
|
+
<span class='kw'>when</span> <span class='const'><span class='object_link'><a href="" title="Files::Transfer::Options (class)">Options</a></span></span> <span class='kw'>then</span> <span class='id identifier rubyid_value'>value</span>
|
|
809
|
+
<span class='kw'>when</span> <span class='kw'>true</span> <span class='kw'>then</span> <span class='id identifier rubyid_new'>new</span>
|
|
810
|
+
<span class='kw'>when</span> <span class='const'>Hash</span>
|
|
811
|
+
<span class='id identifier rubyid_unknown'>unknown</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span> <span class='op'>-</span> <span class='const'><span class='object_link'><a href="#KEYS-constant" title="Files::Transfer::Options::KEYS (constant)">KEYS</a></span></span>
|
|
812
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="../InvalidParameterError.html" title="Files::InvalidParameterError (class)">InvalidParameterError</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Bad parameter: transfer does not take </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_unknown'>unknown</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:inspect</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>, </span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_unknown'>unknown</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
|
|
813
|
+
|
|
814
|
+
<span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='op'>**</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
|
|
815
|
+
<span class='kw'>else</span>
|
|
816
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="../InvalidParameterError.html" title="Files::InvalidParameterError (class)">InvalidParameterError</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Bad parameter: transfer must be true, a Hash of transfer options, a Files::Transfer::Options or a Files::Transfer::Job</span><span class='tstring_end'>"</span></span>
|
|
817
|
+
<span class='kw'>end</span>
|
|
818
|
+
<span class='kw'>end</span></pre>
|
|
819
|
+
</td>
|
|
820
|
+
</tr>
|
|
821
|
+
</table>
|
|
822
|
+
</div>
|
|
823
|
+
|
|
824
|
+
</div>
|
|
825
|
+
|
|
826
|
+
<div id="instance_method_details" class="method_details_list">
|
|
827
|
+
<h2>Instance Method Details</h2>
|
|
828
|
+
|
|
829
|
+
|
|
830
|
+
<div class="method_details first">
|
|
831
|
+
<h3 class="signature first" id="automatic?-instance_method">
|
|
832
|
+
|
|
833
|
+
#<strong>automatic?</strong> ⇒ <tt>Boolean</tt>
|
|
834
|
+
|
|
835
|
+
|
|
836
|
+
|
|
837
|
+
|
|
838
|
+
|
|
839
|
+
</h3><div class="docstring">
|
|
840
|
+
<div class="discussion">
|
|
841
|
+
|
|
842
|
+
|
|
843
|
+
</div>
|
|
844
|
+
</div>
|
|
845
|
+
<div class="tags">
|
|
846
|
+
|
|
847
|
+
<p class="tag_title">Returns:</p>
|
|
848
|
+
<ul class="return">
|
|
849
|
+
|
|
850
|
+
<li>
|
|
851
|
+
|
|
852
|
+
|
|
853
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
854
|
+
|
|
855
|
+
|
|
856
|
+
|
|
857
|
+
</li>
|
|
858
|
+
|
|
859
|
+
</ul>
|
|
860
|
+
|
|
861
|
+
</div><table class="source_code">
|
|
862
|
+
<tr>
|
|
863
|
+
<td>
|
|
864
|
+
<pre class="lines">
|
|
865
|
+
|
|
866
|
+
|
|
867
|
+
103
|
|
868
|
+
104
|
|
869
|
+
105</pre>
|
|
870
|
+
</td>
|
|
871
|
+
<td>
|
|
872
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/options.rb', line 103</span>
|
|
873
|
+
|
|
874
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_automatic?'>automatic?</span>
|
|
875
|
+
<span class='ivar'>@concurrency</span> <span class='op'>==</span> <span class='symbol'>:automatic</span>
|
|
876
|
+
<span class='kw'>end</span></pre>
|
|
877
|
+
</td>
|
|
878
|
+
</tr>
|
|
879
|
+
</table>
|
|
880
|
+
</div>
|
|
881
|
+
|
|
882
|
+
<div class="method_details ">
|
|
883
|
+
<h3 class="signature " id="to_h-instance_method">
|
|
884
|
+
|
|
885
|
+
#<strong>to_h</strong> ⇒ <tt>Object</tt>
|
|
886
|
+
|
|
887
|
+
|
|
888
|
+
|
|
889
|
+
|
|
890
|
+
|
|
891
|
+
</h3><table class="source_code">
|
|
892
|
+
<tr>
|
|
893
|
+
<td>
|
|
894
|
+
<pre class="lines">
|
|
895
|
+
|
|
896
|
+
|
|
897
|
+
107
|
|
898
|
+
108
|
|
899
|
+
109</pre>
|
|
900
|
+
</td>
|
|
901
|
+
<td>
|
|
902
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/options.rb', line 107</span>
|
|
903
|
+
|
|
904
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_to_h'>to_h</span>
|
|
905
|
+
<span class='const'><span class='object_link'><a href="#KEYS-constant" title="Files::Transfer::Options::KEYS (constant)">KEYS</a></span></span><span class='period'>.</span><span class='id identifier rubyid_to_h'>to_h</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='op'>|</span> <span class='lbracket'>[</span> <span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_public_send'>public_send</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span> <span class='rbracket'>]</span> <span class='rbrace'>}</span>
|
|
906
|
+
<span class='kw'>end</span></pre>
|
|
907
|
+
</td>
|
|
908
|
+
</tr>
|
|
909
|
+
</table>
|
|
910
|
+
</div>
|
|
911
|
+
|
|
912
|
+
</div>
|
|
913
|
+
|
|
914
|
+
</div>
|
|
915
|
+
|
|
916
|
+
<div id="footer">
|
|
917
|
+
Generated on Tue Nov 3 21:11:55 2026 by
|
|
918
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
919
|
+
0.9.45 (ruby-4.0.9).
|
|
920
|
+
</div>
|
|
921
|
+
|
|
922
|
+
</div>
|
|
923
|
+
</body>
|
|
924
|
+
</html>
|