Class: UpdateApiKeyRequest
cloudservice.v1.UpdateApiKeyRequest
Represents an UpdateApiKeyRequest.
Implements
Constructors
constructor
• new UpdateApiKeyRequest(properties?): UpdateApiKeyRequest
Constructs a new UpdateApiKeyRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUpdateApiKeyRequest | Properties to set |
Returns
Properties
asyncOperationId
• asyncOperationId: string
The id to use for this async operation - optional.
Implementation of
IUpdateApiKeyRequest.asyncOperationId
keyId
• keyId: string
The id of the api key to update.
Implementation of
resourceVersion
• resourceVersion: string
The version of the api key for which this update is intended for. The latest version can be found in the GetApiKey operation response.
Implementation of
IUpdateApiKeyRequest.resourceVersion
spec
• Optional spec: null | IApiKeySpec
The new api key specification.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this UpdateApiKeyRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): UpdateApiKeyRequest
Creates a new UpdateApiKeyRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUpdateApiKeyRequest | Properties to set |
Returns
UpdateApiKeyRequest instance
decode
▸ decode(reader, length?): UpdateApiKeyRequest
Decodes an UpdateApiKeyRequest 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
UpdateApiKeyRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): UpdateApiKeyRequest
Decodes an UpdateApiKeyRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
UpdateApiKeyRequest
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 UpdateApiKeyRequest message. Does not implicitly temporal.api.cloud.cloudservice.v1.UpdateApiKeyRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUpdateApiKeyRequest | UpdateApiKeyRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified UpdateApiKeyRequest message, length delimited. Does not implicitly temporal.api.cloud.cloudservice.v1.UpdateApiKeyRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUpdateApiKeyRequest | UpdateApiKeyRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): UpdateApiKeyRequest
Creates an UpdateApiKeyRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
UpdateApiKeyRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for UpdateApiKeyRequest
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 an UpdateApiKeyRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | UpdateApiKeyRequest | UpdateApiKeyRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object