Class: Download
v1.BillingReport.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: null | $Properties
The time when the download url will expire.
Methods
toJSON
▸ toJSON(): Object
Converts this Download to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Download & $Properties
Creates a new Download instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
Download instance
▸ create(properties?): Download
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): Download & $Properties
Decodes a Download message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
Download
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Download & $Properties
Decodes a Download message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Download
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message, writer?): Writer
Encodes the specified Download message. Does not implicitly temporal.api.cloud.billing.v1.BillingReport.Download.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | Download message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ 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
| Name | Type | Description |
|---|---|---|
message | $Properties | Download message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Download
Creates a Download message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Download
toObject
▸ toObject(message, options?): Object
Creates a plain object from a Download message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Download | Download |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object