Class: ApiKey

identity.v1.ApiKey

Represents an ApiKey.

Implements

• IApiKey

Constructors

constructor

• new ApiKey(properties?): ApiKey

Constructs a new ApiKey.

Parameters

Name	Type	Description
properties?	IApiKey	Properties to set

Returns

ApiKey

Properties

asyncOperationId

• asyncOperationId: string

The id of the async operation that is creating/updating/deleting the API key, if any.

Implementation of

IApiKey.asyncOperationId

---

createdTime

• Optional createdTime: null | ITimestamp

The date and time when the API key was created.

Implementation of

IApiKey.createdTime

---

id

• id: string

The id of the API Key.

Implementation of

IApiKey.id

---

lastModifiedTime

• Optional lastModifiedTime: null | ITimestamp

The date and time when the API key was last modified. Will not be set if the API key has never been modified.

Implementation of

IApiKey.lastModifiedTime

---

resourceVersion

• resourceVersion: string

The current version of the API key specification. The next update operation will have to include this version.

Implementation of

IApiKey.resourceVersion

---

spec

• Optional spec: null | IApiKeySpec

The API key specification.

Implementation of

IApiKey.spec

---

state

• state: 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.

Implementation of

IApiKey.state

Methods

toJSON

▸ toJSON(): Object

Converts this ApiKey to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): ApiKey

Creates a new ApiKey instance using the specified properties.

Parameters

Name	Type	Description
properties?	IApiKey	Properties to set

Returns

ApiKey

ApiKey instance

---

decode

▸ decode(reader, length?): ApiKey

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

ApiKey

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): ApiKey

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

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	IApiKey	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	IApiKey	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

ApiKey

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ApiKey

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 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