createUploadDescription method

Future<String> createUploadDescription(
  1. String cloudProjectId, {
  2. String? serverpodVersion,
  3. String? dartVersion,
  4. String? commitHash,
  5. String? commitMessage,
  6. String? branch,
  7. bool? resumable,
  8. int? archiveSize,
})

Starts a deploy attempt and returns the upload description: a resumable session (type: resumable) for exactly archiveSize bytes when resumable is set, otherwise a single signed PUT (type: binary).

Throws InvalidValueException if resumable is set without a positive archiveSize. Throws UploadTooLargeException if a resumable upload's archiveSize exceeds the upload limit. Without resumable, archiveSize is ignored and the signed PUT carries the limit. Throws ProjectSuspendedException if the project is suspended.

Implementation

_ida.Future<String> createUploadDescription(
  String cloudProjectId, {
  String? serverpodVersion,
  String? dartVersion,
  String? commitHash,
  String? commitMessage,
  String? branch,
  bool? resumable,
  int? archiveSize,
}) => caller.callServerEndpoint<String>('deploy', 'createUploadDescription', {
  'cloudProjectId': cloudProjectId,
  'serverpodVersion': serverpodVersion,
  'dartVersion': dartVersion,
  'commitHash': commitHash,
  'commitMessage': commitMessage,
  'branch': branch,
  'resumable': resumable,
  'archiveSize': archiveSize,
});