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