Class: ApiKeyAuthSpec
Represents an ApiKeyAuthSpec.
Implements
Constructors
constructor
• new ApiKeyAuthSpec(properties?): ApiKeyAuthSpec
Constructs a new ApiKeyAuthSpec.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IApiKeyAuthSpec | Properties to set |
Returns
Properties
enabled
• enabled: boolean
Flag to enable API key auth (default: disabled). Note: disabling API key auth will cause existing API key connections to fail.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this ApiKeyAuthSpec to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ApiKeyAuthSpec
Creates a new ApiKeyAuthSpec instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IApiKeyAuthSpec | Properties to set |
Returns
ApiKeyAuthSpec instance
decode
▸ decode(reader, length?): ApiKeyAuthSpec
Decodes an ApiKeyAuthSpec 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
ApiKeyAuthSpec
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ApiKeyAuthSpec
Decodes an ApiKeyAuthSpec message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ApiKeyAuthSpec
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 ApiKeyAuthSpec message. Does not implicitly temporal.api.cloud.namespace.v1.ApiKeyAuthSpec.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IApiKeyAuthSpec | ApiKeyAuthSpec message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ApiKeyAuthSpec message, length delimited. Does not implicitly temporal.api.cloud.namespace.v1.ApiKeyAuthSpec.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IApiKeyAuthSpec | ApiKeyAuthSpec message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ApiKeyAuthSpec
Creates an ApiKeyAuthSpec message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ApiKeyAuthSpec
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for ApiKeyAuthSpec
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 ApiKeyAuthSpec message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ApiKeyAuthSpec | ApiKeyAuthSpec |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object