Class Upload (3.6.0)

Inheritance

Pumpify > Upload

Package

gcs-resumable-upload

Constructors

(constructor)(cfg)

constructor(cfg: UploadConfig);

Constructs a new instance of the Upload class

Parameter
NameDescription
cfg UploadConfig

Properties

apiEndpoint

apiEndpoint: string;
Property Value
TypeDescription
string

authClient

authClient: {
        request: <T = any>(opts: GaxiosOptions) => Promise<GaxiosResponse<T>> | GaxiosPromise<T>;
    };
Property Value
TypeDescription
{ request: <T = any>(opts: GaxiosOptions) => Promise<GaxiosResponse<T>> | GaxiosPromise<T>; }

authConfig

authConfig?: {
        scopes?: string[];
    };
Property Value
TypeDescription
{ scopes?: string[]; }

baseURI

baseURI: string;
Property Value
TypeDescription
string

bucket

bucket: string;
Property Value
TypeDescription
string

cacheKey

cacheKey: string;
Property Value
TypeDescription
string

configStore

configStore: ConfigStore;
Property Value
TypeDescription
ConfigStore

contentLength

contentLength: number | '*';
Property Value
TypeDescription
number | '*'

customRequestOptions

customRequestOptions: GaxiosOptions;
Property Value
TypeDescription
GaxiosOptions

encryption

encryption?: Encryption;
Property Value
TypeDescription
Encryption

file

file: string;
Property Value
TypeDescription
string

generation

generation?: number;
Property Value
TypeDescription
number

key

key?: string | Buffer;
Property Value
TypeDescription
string | __global.Buffer

kmsKeyName

kmsKeyName?: string;
Property Value
TypeDescription
string

maxRetryDelay

maxRetryDelay: number;
Property Value
TypeDescription
number

maxRetryTotalTimeout

maxRetryTotalTimeout: number;
Property Value
TypeDescription
number

metadata

metadata: ConfigMetadata;
Property Value
TypeDescription
ConfigMetadata

numBytesWritten

numBytesWritten: number;
Property Value
TypeDescription
number

numRetries

numRetries: number;
Property Value
TypeDescription
number

offset

offset?: number;
Property Value
TypeDescription
number

origin

origin?: string;
Property Value
TypeDescription
string

params

params: QueryParameters;
Property Value
TypeDescription
QueryParameters

predefinedAcl

predefinedAcl?: PredefinedAcl;
Property Value
TypeDescription
PredefinedAcl

private

private?: boolean;
Property Value
TypeDescription
boolean

public

public?: boolean;
Property Value
TypeDescription
boolean

retryableErrorFn

retryableErrorFn?: (err: ApiError) => boolean;
Property Value
TypeDescription
(err: ApiError) => boolean

retryDelayMultiplier

retryDelayMultiplier: number;
Property Value
TypeDescription
number

retryLimit

retryLimit: number;
Property Value
TypeDescription
number

timeOfFirstRequest

timeOfFirstRequest: number;
Property Value
TypeDescription
number

uri

uri?: string;
Property Value
TypeDescription
string

uriProvidedManually

uriProvidedManually: boolean;
Property Value
TypeDescription
boolean

userProject

userProject?: string;
Property Value
TypeDescription
string

Methods

createURI()

createURI(): Promise<string>;
Returns
TypeDescription
Promise<string>

createURI(callback)

createURI(callback: CreateUriCallback): void;
Parameter
NameDescription
callback CreateUriCallback
Returns
TypeDescription
void

createURIAsync()

protected createURIAsync(): Promise<string>;
Returns
TypeDescription
Promise<string>

deleteConfig()

deleteConfig(): void;
Returns
TypeDescription
void