Skip to main content

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?: $Properties | null

The date and time when the billing report generation completed.

id​

id: string

The id of the billing report.

requestedTime?​

optional requestedTime?: $Properties | null

The date and time when the billing report was requested.

spec?​

optional spec?: $Properties | null

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()​

Call Signature​

static create(properties?): BillingReport & $Properties

Creates a new BillingReport instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

BillingReport & $Properties

BillingReport instance

Call Signature​

static create(properties?): BillingReport

Creates a new BillingReport instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

BillingReport

BillingReport instance

decode()​

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

Decodes a BillingReport 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​

BillingReport & $Properties

BillingReport

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): BillingReport & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

BillingReport & $Properties

BillingReport

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 BillingReport message. Does not implicitly temporal.api.cloud.billing.v1.BillingReport.verify|verify messages.

Parameters​

message​

$Properties

BillingReport message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

BillingReport message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): BillingReport

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

BillingReport

BillingReport

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

BillingReport

BillingReport

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object