Skip to main content

Class: Download

Represents a Download.

Properties​

fileFormat​

fileFormat: FileFormat

The file format of the billing report

fileSizeBytes​

fileSizeBytes: Long

The size of the file in bytes. Useful for pre-allocating space, progress indicators, etc.

url​

url: string

The download url.

urlExpirationTime?​

optional urlExpirationTime?: $Properties | null

The time when the download url will expire.

Methods​

toJSON()​

toJSON(): object

Converts this Download to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): Download & $Properties

Creates a new Download instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Download & $Properties

Download instance

Call Signature​

static create(properties?): Download

Creates a new Download instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Download

Download instance

decode()​

static decode(reader, length?): Download & $Properties

Decodes a Download message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

Download & $Properties

Download

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Download & $Properties

Decodes a Download message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

Download & $Properties

Download

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified Download message. Does not implicitly temporal.api.cloud.billing.v1.BillingReport.Download.verify|verify messages.

Parameters​

message​

$Properties

Download message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified Download message, length delimited. Does not implicitly temporal.api.cloud.billing.v1.BillingReport.Download.verify|verify messages.

Parameters​

message​

$Properties

Download message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Download

Creates a Download message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

Download

Download

toObject()​

static toObject(message, options?): object

Creates a plain object from a Download message. Also converts values to other types if specified.

Parameters​

message​

Download

Download

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object