Class: ApiKey
Represents an ApiKey.
Properties
asyncOperationId
• asyncOperationId: string
The id of the async operation that is creating/updating/deleting the API key, if any.
createdTime
• Optional createdTime: null | $Properties
The date and time when the API key was created.
id
• id: string
The id of the API Key.
lastModifiedTime
• Optional lastModifiedTime: null | $Properties
The date and time when the API key was last modified. Will not be set if the API key has never been modified.
resourceVersion
• resourceVersion: string
The current version of the API key specification. The next update operation will have to include this version.
spec
• Optional spec: null | $Properties
The API key specification.
state
• state: ResourceState
The current state of the API key. temporal:versioning:min_version=v0.3.0 temporal:enums:replaces=state_deprecated
stateDeprecated
• stateDeprecated: string
The current state of the API key. Possible values: activating, activationfailed, active, updating, updatefailed, deleting, deletefailed, deleted, suspending, suspendfailed, suspended. For any failed state, reach out to Temporal Cloud support for remediation. Deprecated: Not supported after v0.3.0 api version. Use state instead. temporal:versioning:max_version=v0.3.0
Methods
toJSON
▸ toJSON(): Object
Converts this ApiKey to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ApiKey & $Properties
Creates a new ApiKey instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
ApiKey instance
▸ create(properties?): ApiKey
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): ApiKey & $Properties
Decodes an ApiKey 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
ApiKey
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ApiKey & $Properties
Decodes an ApiKey message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ApiKey
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 ApiKey message. Does not implicitly temporal.api.cloud.identity.v1.ApiKey.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ApiKey message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ApiKey message, length delimited. Does not implicitly temporal.api.cloud.identity.v1.ApiKey.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ApiKey message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ApiKey
Creates an ApiKey message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ApiKey
toObject
▸ toObject(message, options?): Object
Creates a plain object from an ApiKey message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ApiKey | ApiKey |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object