Skip to main content

Class: BillingReportSpec

Represents a BillingReportSpec.

Properties​

description​

description: string

The description for the billing report. Optional, default is empty.

downloadUrlExpirationDuration?​

optional downloadUrlExpirationDuration?: $Properties | null

The duration after which the download url will expire. Optional, default is 5 minutes and maximum is 1 hour.

endTimeExclusive?​

optional endTimeExclusive?: $Properties | null

The end time of the billing report (in UTC).

granularity​

granularity: BillingReportGranularity

The data granularity of the billing report. Optional, default is hourly. temporal:versioning:min_version=v0.16.0

startTimeInclusive?​

optional startTimeInclusive?: $Properties | null

The start time of the billing report (in UTC).

Methods​

toJSON()​

toJSON(): object

Converts this BillingReportSpec to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): BillingReportSpec & $Properties

Creates a new BillingReportSpec instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

BillingReportSpec & $Properties

BillingReportSpec instance

Call Signature​

static create(properties?): BillingReportSpec

Creates a new BillingReportSpec instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

BillingReportSpec

BillingReportSpec instance

decode()​

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

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

BillingReportSpec & $Properties

BillingReportSpec

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): BillingReportSpec & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

BillingReportSpec & $Properties

BillingReportSpec

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

Parameters​

message​

$Properties

BillingReportSpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

BillingReportSpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): BillingReportSpec

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

BillingReportSpec

BillingReportSpec

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

BillingReportSpec

BillingReportSpec

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object