Skip to main content

Class: ApiKeyAuthSpec

Represents an ApiKeyAuthSpec.

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.

Methods​

toJSON()​

toJSON(): object

Converts this ApiKeyAuthSpec to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ApiKeyAuthSpec & $Properties

Creates a new ApiKeyAuthSpec instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ApiKeyAuthSpec & $Properties

ApiKeyAuthSpec instance

Call Signature​

static create(properties?): ApiKeyAuthSpec

Creates a new ApiKeyAuthSpec instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ApiKeyAuthSpec

ApiKeyAuthSpec instance

decode()​

static decode(reader, length?): ApiKeyAuthSpec & $Properties

Decodes an ApiKeyAuthSpec message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

ApiKeyAuthSpec & $Properties

ApiKeyAuthSpec

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ApiKeyAuthSpec & $Properties

Decodes an ApiKeyAuthSpec message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ApiKeyAuthSpec & $Properties

ApiKeyAuthSpec

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified ApiKeyAuthSpec message. Does not implicitly temporal.api.cloud.namespace.v1.ApiKeyAuthSpec.verify|verify messages.

Parameters​

message​

$Properties

ApiKeyAuthSpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified ApiKeyAuthSpec message, length delimited. Does not implicitly temporal.api.cloud.namespace.v1.ApiKeyAuthSpec.verify|verify messages.

Parameters​

message​

$Properties

ApiKeyAuthSpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ApiKeyAuthSpec

Creates an ApiKeyAuthSpec message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

ApiKeyAuthSpec

ApiKeyAuthSpec

toObject()​

static toObject(message, options?): object

Creates a plain object from an ApiKeyAuthSpec message. Also converts values to other types if specified.

Parameters​

message​

ApiKeyAuthSpec

ApiKeyAuthSpec

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object