Class: GetUsageRequest
cloudservice.v1.GetUsageRequest
Represents a GetUsageRequest.
Properties
endTimeExclusive
• Optional endTimeExclusive: null | $Properties
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: null | $Properties
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
▸ create(properties?): GetUsageRequest & $Properties
Creates a new GetUsageRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
GetUsageRequest instance
▸ create(properties?): GetUsageRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): GetUsageRequest & $Properties
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
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): GetUsageRequest & $Properties
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
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 | $Properties | 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 | $Properties | 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
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