Skip to main content

Class: FairnessSpec

namespace.v1.FairnessSpec

Represents a FairnessSpec.

Implements

Constructors

constructor

new FairnessSpec(properties?): FairnessSpec

Constructs a new FairnessSpec.

Parameters

NameTypeDescription
properties?IFairnessSpecProperties to set

Returns

FairnessSpec

Properties

taskQueueFairnessEnabled

taskQueueFairnessEnabled: boolean

Flag to enable task queue fairness for the namespace (default: disabled).

Implementation of

IFairnessSpec.taskQueueFairnessEnabled

Methods

toJSON

toJSON(): Object

Converts this FairnessSpec to JSON.

Returns

Object

JSON object


create

create(properties?): FairnessSpec

Creates a new FairnessSpec instance using the specified properties.

Parameters

NameTypeDescription
properties?IFairnessSpecProperties to set

Returns

FairnessSpec

FairnessSpec instance


decode

decode(reader, length?): FairnessSpec

Decodes a FairnessSpec message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

FairnessSpec

FairnessSpec

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): FairnessSpec

Decodes a FairnessSpec message from the specified reader or buffer, length delimited.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

FairnessSpec

FairnessSpec

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 FairnessSpec message. Does not implicitly temporal.api.cloud.namespace.v1.FairnessSpec.verify|verify messages.

Parameters

NameTypeDescription
messageIFairnessSpecFairnessSpec message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIFairnessSpecFairnessSpec message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): FairnessSpec

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

FairnessSpec

FairnessSpec


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for FairnessSpec

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageFairnessSpecFairnessSpec
options?IConversionOptionsConversion options

Returns

Object

Plain object