Skip to main content

Class: GetUsageRequest

Represents a GetUsageRequest.

Properties​

endTimeExclusive?​

optional endTimeExclusive?: $Properties | null

Filter for UTC time < - optional. Defaults to: start of the next UTC day. Must be: within the last 90 days from the current date. Must be: midnight UTC time.

pageSize​

pageSize: number

The requested size of the page to retrieve - optional. Each count corresponds to a single object - per day per namespace Cannot exceed 1000. Defaults to 100.

pageToken​

pageToken: string

The page token if this is continuing from another response - optional.

startTimeInclusive?​

optional startTimeInclusive?: $Properties | null

Filter for UTC time >= - optional. Defaults to: start of the current month. Must be: within the last 90 days from the current date. Must be: midnight UTC time.

Methods​

toJSON()​

toJSON(): object

Converts this GetUsageRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): GetUsageRequest & $Properties

Creates a new GetUsageRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

GetUsageRequest & $Properties

GetUsageRequest instance

Call Signature​

static create(properties?): GetUsageRequest

Creates a new GetUsageRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

GetUsageRequest

GetUsageRequest instance

decode()​

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

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

GetUsageRequest & $Properties

GetUsageRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): GetUsageRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

GetUsageRequest & $Properties

GetUsageRequest

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

Parameters​

message​

$Properties

GetUsageRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

GetUsageRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): GetUsageRequest

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

GetUsageRequest

GetUsageRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

GetUsageRequest

GetUsageRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object