Class: GetApiKeysRequest
cloudservice.v1.GetApiKeysRequest
Represents a GetApiKeysRequest.
Properties
ownerId
• ownerId: string
Filter api keys by owner id - optional.
ownerType
• ownerType: OwnerType
Filter api keys by owner type - optional. temporal:enums:replaces=owner_type_deprecated
ownerTypeDeprecated
• ownerTypeDeprecated: string
Filter api keys by owner type - optional. Possible values: user, service-account temporal:versioning:max_version=v0.3.0
pageSize
• pageSize: number
The requested size of the page to retrieve - optional. Cannot exceed 1000. Defaults to 100.
pageToken
• pageToken: string
The page token if this is continuing from another response - optional.
Methods
toJSON
▸ toJSON(): Object
Converts this GetApiKeysRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): GetApiKeysRequest & $Properties
Creates a new GetApiKeysRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
GetApiKeysRequest & $Properties
GetApiKeysRequest instance
▸ create(properties?): GetApiKeysRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): GetApiKeysRequest & $Properties
Decodes a GetApiKeysRequest 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
GetApiKeysRequest & $Properties
GetApiKeysRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): GetApiKeysRequest & $Properties
Decodes a GetApiKeysRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
GetApiKeysRequest & $Properties
GetApiKeysRequest
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 GetApiKeysRequest message. Does not implicitly temporal.api.cloud.cloudservice.v1.GetApiKeysRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | GetApiKeysRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified GetApiKeysRequest message, length delimited. Does not implicitly temporal.api.cloud.cloudservice.v1.GetApiKeysRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | GetApiKeysRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): GetApiKeysRequest
Creates a GetApiKeysRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
GetApiKeysRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from a GetApiKeysRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | GetApiKeysRequest | GetApiKeysRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object