Class TopologyManager (2.67.0)

public final class TopologyManager extends GeneratedMessageV3 implements TopologyManagerOrBuilder

TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/

Protobuf type google.container.v1beta1.TopologyManager

Static Fields

POLICY_FIELD_NUMBER

public static final int POLICY_FIELD_NUMBER
Field Value
Type Description
int

SCOPE_FIELD_NUMBER

public static final int SCOPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TopologyManager getDefaultInstance()
Returns
Type Description
TopologyManager

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static TopologyManager.Builder newBuilder()
Returns
Type Description
TopologyManager.Builder

newBuilder(TopologyManager prototype)

public static TopologyManager.Builder newBuilder(TopologyManager prototype)
Parameter
Name Description
prototype TopologyManager
Returns
Type Description
TopologyManager.Builder

parseDelimitedFrom(InputStream input)

public static TopologyManager parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TopologyManager
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TopologyManager parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TopologyManager
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static TopologyManager parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
TopologyManager
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TopologyManager parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TopologyManager
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TopologyManager parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
TopologyManager
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TopologyManager parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TopologyManager
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TopologyManager parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TopologyManager
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TopologyManager parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TopologyManager
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static TopologyManager parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TopologyManager
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TopologyManager parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TopologyManager
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static TopologyManager parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TopologyManager
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TopologyManager parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TopologyManager
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<TopologyManager> parser()
Returns
Type Description
Parser<TopologyManager>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public TopologyManager getDefaultInstanceForType()
Returns
Type Description
TopologyManager

getParserForType()

public Parser<TopologyManager> getParserForType()
Returns
Type Description
Parser<TopologyManager>
Overrides

getPolicy()

public String getPolicy()

Configures the strategy for resource alignment. Allowed values are:

  • none: the default policy, and does not perform any topology alignment.
  • restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred.
  • best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway.
  • single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure.

    The default policy value is 'none' if unspecified. Details about each strategy can be found here.

string policy = 1;

Returns
Type Description
String

The policy.

getPolicyBytes()

public ByteString getPolicyBytes()

Configures the strategy for resource alignment. Allowed values are:

  • none: the default policy, and does not perform any topology alignment.
  • restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred.
  • best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway.
  • single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure.

    The default policy value is 'none' if unspecified. Details about each strategy can be found here.

string policy = 1;

Returns
Type Description
ByteString

The bytes for policy.

getScope()

public String getScope()

The Topology Manager aligns resources in following scopes:

string scope = 2;

Returns
Type Description
String

The scope.

getScopeBytes()

public ByteString getScopeBytes()

The Topology Manager aligns resources in following scopes:

string scope = 2;

Returns
Type Description
ByteString

The bytes for scope.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public TopologyManager.Builder newBuilderForType()
Returns
Type Description
TopologyManager.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TopologyManager.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TopologyManager.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public TopologyManager.Builder toBuilder()
Returns
Type Description
TopologyManager.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException