Class: CreateApiKeyResponse
cloudservice.v1.CreateApiKeyResponse
Represents a CreateApiKeyResponse.
Implements
Constructors
constructor
• new CreateApiKeyResponse(properties?): CreateApiKeyResponse
Constructs a new CreateApiKeyResponse.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ICreateApiKeyResponse | Properties to set |
Returns
Properties
asyncOperation
• Optional asyncOperation: null | IAsyncOperation
The async operation.
Implementation of
ICreateApiKeyResponse.asyncOperation
keyId
• keyId: string
The id of the api key created.
Implementation of
token
• token: string
The token of the api key created. This is a secret and should be stored securely. It will not be retrievable after this response.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this CreateApiKeyResponse to JSON.
Returns
Object
JSON object
create
▸ create(properties?): CreateApiKeyResponse
Creates a new CreateApiKeyResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ICreateApiKeyResponse | Properties to set |
Returns
CreateApiKeyResponse instance
decode
▸ decode(reader, length?): CreateApiKeyResponse
Decodes a CreateApiKeyResponse 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
CreateApiKeyResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): CreateApiKeyResponse
Decodes a CreateApiKeyResponse message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
CreateApiKeyResponse
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 CreateApiKeyResponse message. Does not implicitly temporal.api.cloud.cloudservice.v1.CreateApiKeyResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ICreateApiKeyResponse | CreateApiKeyResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified CreateApiKeyResponse message, length delimited. Does not implicitly temporal.api.cloud.cloudservice.v1.CreateApiKeyResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ICreateApiKeyResponse | CreateApiKeyResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): CreateApiKeyResponse
Creates a CreateApiKeyResponse message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
CreateApiKeyResponse
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for CreateApiKeyResponse
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 a CreateApiKeyResponse message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | CreateApiKeyResponse | CreateApiKeyResponse |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object