Class: GetUsageRequest

cloudservice.v1.GetUsageRequest

Represents a GetUsageRequest.

Implements

• IGetUsageRequest

Constructors

constructor

• new GetUsageRequest(properties?): GetUsageRequest

Constructs a new GetUsageRequest.

Parameters

Name	Type	Description
properties?	IGetUsageRequest	Properties to set

Returns

GetUsageRequest

Properties

endTimeExclusive

• Optional endTimeExclusive: null | ITimestamp

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.

Implementation of

IGetUsageRequest.endTimeExclusive

---

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.

Implementation of

IGetUsageRequest.pageSize

---

pageToken

• pageToken: string

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

Implementation of

IGetUsageRequest.pageToken

---

startTimeInclusive

• Optional startTimeInclusive: null | ITimestamp

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.

Implementation of

IGetUsageRequest.startTimeInclusive

Methods

toJSON

▸ toJSON(): Object

Converts this GetUsageRequest to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): GetUsageRequest

Creates a new GetUsageRequest instance using the specified properties.

Parameters

Name	Type	Description
properties?	IGetUsageRequest	Properties to set

Returns

GetUsageRequest

GetUsageRequest instance

---

decode

▸ decode(reader, length?): GetUsageRequest

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

GetUsageRequest

GetUsageRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): GetUsageRequest

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

GetUsageRequest

GetUsageRequest

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

Parameters

Name	Type	Description
message	IGetUsageRequest	GetUsageRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IGetUsageRequest	GetUsageRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): GetUsageRequest

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

GetUsageRequest

GetUsageRequest

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for GetUsageRequest

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	GetUsageRequest	GetUsageRequest
options?	IConversionOptions	Conversion options

Returns

Object

Plain object