Class: BillingReportSpec
Represents a BillingReportSpec.
Properties
description
• description: string
The description for the billing report. Optional, default is empty.
downloadUrlExpirationDuration
• Optional downloadUrlExpirationDuration: null | $Properties
The duration after which the download url will expire. Optional, default is 5 minutes and maximum is 1 hour.
endTimeExclusive
• Optional endTimeExclusive: null | $Properties
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: null | $Properties
The start time of the billing report (in UTC).
Methods
toJSON
▸ toJSON(): Object
Converts this BillingReportSpec to JSON.
Returns
Object
JSON object
create
▸ create(properties?): BillingReportSpec & $Properties
Creates a new BillingReportSpec instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
BillingReportSpec & $Properties
BillingReportSpec instance
▸ create(properties?): BillingReportSpec
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): BillingReportSpec & $Properties
Decodes a BillingReportSpec 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
BillingReportSpec & $Properties
BillingReportSpec
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): BillingReportSpec & $Properties
Decodes a BillingReportSpec message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | 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
▸ encode(message, writer?): Writer
Encodes the specified BillingReportSpec message. Does not implicitly temporal.api.cloud.billing.v1.BillingReportSpec.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | BillingReportSpec message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified BillingReportSpec message, length delimited. Does not implicitly temporal.api.cloud.billing.v1.BillingReportSpec.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | BillingReportSpec message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): BillingReportSpec
Creates a BillingReportSpec message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
BillingReportSpec
toObject
▸ toObject(message, options?): Object
Creates a plain object from a BillingReportSpec message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | BillingReportSpec | BillingReportSpec |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object