Package com.google.container.v1

Class TopologyManager

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.container.v1.TopologyManager
All Implemented Interfaces:
TopologyManagerOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class TopologyManager extends com.google.protobuf.GeneratedMessage 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
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    TopologyManager.Builder
    TopologyManager defines the configuration options for Topology Manager feature.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    POLICY_FIELD_NUMBER
     
    static final int
    SCOPE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static TopologyManager
    getDefaultInstance()
     
    TopologyManager
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<TopologyManager>
    getParserForType()
     
    String
    getPolicy()
    Configures the strategy for resource alignment.
    com.google.protobuf.ByteString
    getPolicyBytes()
    Configures the strategy for resource alignment.
    String
    getScope()
    The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified.
    com.google.protobuf.ByteString
    getScopeBytes()
    The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static TopologyManager.Builder
    newBuilder()
     
    static TopologyManager.Builder
    newBuilder(TopologyManager prototype)
     
    TopologyManager.Builder
    newBuilderForType()
     
    protected TopologyManager.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static TopologyManager
    parseDelimitedFrom(InputStream input)
     
    static TopologyManager
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TopologyManager
    parseFrom(byte[] data)
     
    static TopologyManager
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TopologyManager
    parseFrom(com.google.protobuf.ByteString data)
     
    static TopologyManager
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TopologyManager
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static TopologyManager
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TopologyManager
    parseFrom(InputStream input)
     
    static TopologyManager
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TopologyManager
    parseFrom(ByteBuffer data)
     
    static TopologyManager
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<TopologyManager>
    parser()
     
    TopologyManager.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
      string policy = 1;
      Specified by:
      getPolicy in interface TopologyManagerOrBuilder
      Returns:
      The policy.

    • getPolicyBytes

      public com.google.protobuf.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](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
      string policy = 1;
      Specified by:
      getPolicyBytes in interface TopologyManagerOrBuilder
      Returns:
      The bytes for policy.

    • getScope

      public String getScope()
       The Topology Manager aligns resources in following scopes:

 * container
 * pod

 The default scope is 'container' if unspecified.
 See
 https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes
      string scope = 2;
      Specified by:
      getScope in interface TopologyManagerOrBuilder
      Returns:
      The scope.

    • getScopeBytes

      public com.google.protobuf.ByteString getScopeBytes()
       The Topology Manager aligns resources in following scopes:

 * container
 * pod

 The default scope is 'container' if unspecified.
 See
 https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes
      string scope = 2;
      Specified by:
      getScopeBytes in interface TopologyManagerOrBuilder
      Returns:
      The bytes for scope.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static TopologyManager parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TopologyManager parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TopologyManager parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TopologyManager parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TopologyManager parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TopologyManager parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TopologyManager parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TopologyManager parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TopologyManager parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TopologyManager parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TopologyManager parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TopologyManager parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public TopologyManager.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static TopologyManager.Builder newBuilder()

    • newBuilder

      public static TopologyManager.Builder newBuilder(TopologyManager prototype)

    • toBuilder

      public TopologyManager.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected TopologyManager.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static TopologyManager getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<TopologyManager> parser()

    • getParserForType

      public com.google.protobuf.Parser<TopologyManager> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public TopologyManager getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder