Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AffinityInformation

Package version

An interface representing AffinityInformation.

summary

A locality hint that can be used by the Batch service to select a compute node on which to start a task.

Hierarchy

  • AffinityInformation

Index

Properties

Properties

affinityId

affinityId: string

An opaque string representing the location of a compute node or a task that has run previously. You can pass the affinityId of a compute node to indicate that this task needs to run on that compute node. Note that this is just a soft affinity. If the target node is busy or unavailable at the time the task is scheduled, then the task will be scheduled elsewhere.

Generated using TypeDoc