Class: BillingReport
Represents a BillingReport.
Properties
asyncOperationId
• asyncOperationId: string
The async operation id associated with the billing report generation.
downloadInfo
• downloadInfo: $Properties[]
The download information for the billing report. For future-proofness this is repeated as we may return multiple files (e.g. csv+meta/json, split by size/date, etc.)
generatedTime
• Optional generatedTime: null | $Properties
The date and time when the billing report generation completed.
id
• id: string
The id of the billing report.
requestedTime
• Optional requestedTime: null | $Properties
The date and time when the billing report was requested.
spec
• Optional spec: null | $Properties
The spec used to generate this billing report.
state
• state: BillingReportState
The current state of the billing report.
Methods
toJSON
▸ toJSON(): Object
Converts this BillingReport to JSON.
Returns
Object
JSON object
create
▸ create(properties?): BillingReport & $Properties
Creates a new BillingReport instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
BillingReport instance
▸ create(properties?): BillingReport
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): BillingReport & $Properties
Decodes a BillingReport 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
BillingReport
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): BillingReport & $Properties
Decodes a BillingReport message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
BillingReport
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 BillingReport message. Does not implicitly temporal.api.cloud.billing.v1.BillingReport.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | BillingReport message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified BillingReport message, length delimited. Does not implicitly temporal.api.cloud.billing.v1.BillingReport.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | BillingReport message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): BillingReport
Creates a BillingReport message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
BillingReport
toObject
▸ toObject(message, options?): Object
Creates a plain object from a BillingReport message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | BillingReport | BillingReport |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object