Class TopologyManager.Builder (2.67.0)

public static final class TopologyManager.Builder extends GeneratedMessageV3.Builder<TopologyManager.Builder> 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.v1.TopologyManager

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TopologyManager.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TopologyManager.Builder
Overrides

build()

public TopologyManager build()
Returns
Type Description
TopologyManager

buildPartial()

public TopologyManager buildPartial()
Returns
Type Description
TopologyManager

clear()

public TopologyManager.Builder clear()
Returns
Type Description
TopologyManager.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public TopologyManager.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
TopologyManager.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public TopologyManager.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
TopologyManager.Builder
Overrides

clearPolicy()

public TopologyManager.Builder clearPolicy()

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
TopologyManager.Builder

This builder for chaining.

clearScope()

public TopologyManager.Builder clearScope()

The Topology Manager aligns resources in following scopes:

string scope = 2;

Returns
Type Description
TopologyManager.Builder

This builder for chaining.

clone()

public TopologyManager.Builder clone()
Returns
Type Description
TopologyManager.Builder
Overrides

getDefaultInstanceForType()

public TopologyManager getDefaultInstanceForType()
Returns
Type Description
TopologyManager

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(TopologyManager other)

public TopologyManager.Builder mergeFrom(TopologyManager other)
Parameter
Name Description
other TopologyManager
Returns
Type Description
TopologyManager.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TopologyManager.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TopologyManager.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public TopologyManager.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
TopologyManager.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TopologyManager.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TopologyManager.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public TopologyManager.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TopologyManager.Builder
Overrides

setPolicy(String value)

public TopologyManager.Builder setPolicy(String value)

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;

Parameter
Name Description
value String

The policy to set.

Returns
Type Description
TopologyManager.Builder

This builder for chaining.

setPolicyBytes(ByteString value)

public TopologyManager.Builder setPolicyBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for policy to set.

Returns
Type Description
TopologyManager.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public TopologyManager.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
TopologyManager.Builder
Overrides

setScope(String value)

public TopologyManager.Builder setScope(String value)

The Topology Manager aligns resources in following scopes:

string scope = 2;

Parameter
Name Description
value String

The scope to set.

Returns
Type Description
TopologyManager.Builder

This builder for chaining.

setScopeBytes(ByteString value)

public TopologyManager.Builder setScopeBytes(ByteString value)

The Topology Manager aligns resources in following scopes:

string scope = 2;

Parameter
Name Description
value ByteString

The bytes for scope to set.

Returns
Type Description
TopologyManager.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final TopologyManager.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TopologyManager.Builder
Overrides