Package io.temporal.api.common.v1

Interface PriorityOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Priority, Priority.Builder

@Generated(value="protoc",
           comments="annotations:PriorityOrBuilder.java.pb.meta")
public interface PriorityOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method	Description
java.lang.String	getFairnessKey()	Fairness key is a short string that's used as a key for a fairness balancing mechanism.
com.google.protobuf.ByteString	getFairnessKeyBytes()	Fairness key is a short string that's used as a key for a fairness balancing mechanism.
float	getFairnessWeight()	Fairness weight for a task can come from multiple sources for flexibility.
int	getPriorityKey()	Priority key is a positive integer from 1 to n, where smaller integers correspond to higher priorities (tasks run sooner).

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Detail

getPriorityKey

int getPriorityKey()

 Priority key is a positive integer from 1 to n, where smaller integers
 correspond to higher priorities (tasks run sooner). In general, tasks in
 a queue should be processed in close to priority order, although small
 deviations are possible.

 The maximum priority value (minimum priority) is determined by server
 configuration, and defaults to 5.

 If priority is not present (or zero), then the effective priority will be
 the default priority, which is is calculated by (min+max)/2. With the
 default max of 5, and min of 1, that comes out to 3.
 

int32 priority_key = 1;

Returns:

The priorityKey.

getFairnessKey

java.lang.String getFairnessKey()

 Fairness key is a short string that's used as a key for a fairness
 balancing mechanism. It may correspond to a tenant id, or to a fixed
 string like "high" or "low". The default is the empty string.

 The fairness mechanism attempts to dispatch tasks for a given key in
 proportion to its weight. For example, using a thousand distinct tenant
 ids, each with a weight of 1.0 (the default) will result in each tenant
 getting a roughly equal share of task dispatch throughput.

 (Note: this does not imply equal share of worker capacity! Fairness
 decisions are made based on queue statistics, not
 current worker load.)

 As another example, using keys "high" and "low" with weight 9.0 and 1.0
 respectively will prefer dispatching "high" tasks over "low" tasks at a
 9:1 ratio, while allowing either key to use all worker capacity if the
 other is not present.

 All fairness mechanisms, including rate limits, are best-effort and
 probabilistic. The results may not match what a "perfect" algorithm with
 infinite resources would produce. The more unique keys are used, the less
 accurate the results will be.

 Fairness keys are limited to 64 bytes.
 

string fairness_key = 2;

Returns:

The fairnessKey.

getFairnessKeyBytes

com.google.protobuf.ByteString getFairnessKeyBytes()

 Fairness key is a short string that's used as a key for a fairness
 balancing mechanism. It may correspond to a tenant id, or to a fixed
 string like "high" or "low". The default is the empty string.

 The fairness mechanism attempts to dispatch tasks for a given key in
 proportion to its weight. For example, using a thousand distinct tenant
 ids, each with a weight of 1.0 (the default) will result in each tenant
 getting a roughly equal share of task dispatch throughput.

 (Note: this does not imply equal share of worker capacity! Fairness
 decisions are made based on queue statistics, not
 current worker load.)

 As another example, using keys "high" and "low" with weight 9.0 and 1.0
 respectively will prefer dispatching "high" tasks over "low" tasks at a
 9:1 ratio, while allowing either key to use all worker capacity if the
 other is not present.

 All fairness mechanisms, including rate limits, are best-effort and
 probabilistic. The results may not match what a "perfect" algorithm with
 infinite resources would produce. The more unique keys are used, the less
 accurate the results will be.

 Fairness keys are limited to 64 bytes.
 

string fairness_key = 2;

Returns:

The bytes for fairnessKey.

getFairnessWeight

float getFairnessWeight()

 Fairness weight for a task can come from multiple sources for
 flexibility. From highest to lowest precedence:
 1. Weights for a small set of keys can be overridden in task queue
    configuration with an API.
 2. It can be attached to the workflow/activity in this field.
 3. The default weight of 1.0 will be used.

 Weight values are clamped to the range [0.001, 1000].
 

float fairness_weight = 3;

Returns:

The fairnessWeight.