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