Skip to main content

Class: BillingReportSpec

billing.v1.BillingReportSpec

Represents a BillingReportSpec.

Implements

Constructors

constructor

new BillingReportSpec(properties?): BillingReportSpec

Constructs a new BillingReportSpec.

Parameters

NameTypeDescription
properties?IBillingReportSpecProperties to set

Returns

BillingReportSpec

Properties

description

description: string

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

Implementation of

IBillingReportSpec.description


downloadUrlExpirationDuration

Optional downloadUrlExpirationDuration: null | IDuration

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

Implementation of

IBillingReportSpec.downloadUrlExpirationDuration


endTimeExclusive

Optional endTimeExclusive: null | ITimestamp

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

Implementation of

IBillingReportSpec.endTimeExclusive


startTimeInclusive

Optional startTimeInclusive: null | ITimestamp

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

Implementation of

IBillingReportSpec.startTimeInclusive

Methods

toJSON

toJSON(): Object

Converts this BillingReportSpec to JSON.

Returns

Object

JSON object


create

create(properties?): BillingReportSpec

Creates a new BillingReportSpec instance using the specified properties.

Parameters

NameTypeDescription
properties?IBillingReportSpecProperties to set

Returns

BillingReportSpec

BillingReportSpec instance


decode

decode(reader, length?): BillingReportSpec

Decodes a BillingReportSpec message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

BillingReportSpec

BillingReportSpec

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): BillingReportSpec

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

BillingReportSpec

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

NameTypeDescription
messageIBillingReportSpecBillingReportSpec message or plain object to encode
writer?WriterWriter 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

NameTypeDescription
messageIBillingReportSpecBillingReportSpec message or plain object to encode
writer?WriterWriter 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

NameTypeDescription
objectObjectPlain object

Returns

BillingReportSpec

BillingReportSpec


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for BillingReportSpec

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageBillingReportSpecBillingReportSpec
options?IConversionOptionsConversion options

Returns

Object

Plain object