Package io.envoyproxy.envoy.config.overload.v3

Class LoadShedPoint

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, LoadShedPointOrBuilder, Serializable
    public final class LoadShedPoint
extends com.google.protobuf.GeneratedMessageV3
implements LoadShedPointOrBuilder
     A point within the connection or request lifecycle that provides context on
 whether to shed load at that given stage for the current entity at the
 point.
    Protobuf type envoy.config.overload.v3.LoadShedPoint
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  LoadShedPoint.Builder
      A point within the connection or request lifecycle that provides context on whether to shed load at that given stage for the current entity at the point.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int NAME_FIELD_NUMBER  
      static int TRIGGERS_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • getName

        public String getName()
         This is just a well-known string for the LoadShedPoint.
 Deployment specific LoadShedPoints e.g. within a custom extension should
 be prefixed by the company / deployment name to avoid colliding with any
 open source LoadShedPoints.
        string name = 1 [(.validate.rules) = { ... }
        Specified by:
        getName in interface LoadShedPointOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         This is just a well-known string for the LoadShedPoint.
 Deployment specific LoadShedPoints e.g. within a custom extension should
 be prefixed by the company / deployment name to avoid colliding with any
 open source LoadShedPoints.
        string name = 1 [(.validate.rules) = { ... }
        Specified by:
        getNameBytes in interface LoadShedPointOrBuilder
        Returns:
        The bytes for name.

      • getTriggersList

        public List<Trigger> getTriggersList()
         A set of triggers for this LoadShedPoint. The LoadShedPoint will use the
 the maximum state of all triggers, which can be scalar values between 0 and
 1 or saturated. A LoadShedPoint can only have one trigger for a given
 resource e.g. :ref:`Trigger.name
 <envoy_v3_api_field_config.overload.v3.Trigger.name>` must be unique in
 this list.
        repeated .envoy.config.overload.v3.Trigger triggers = 2 [(.validate.rules) = { ... }
        Specified by:
        getTriggersList in interface LoadShedPointOrBuilder

      • getTriggersOrBuilderList

        public List<? extends TriggerOrBuilder> getTriggersOrBuilderList()
         A set of triggers for this LoadShedPoint. The LoadShedPoint will use the
 the maximum state of all triggers, which can be scalar values between 0 and
 1 or saturated. A LoadShedPoint can only have one trigger for a given
 resource e.g. :ref:`Trigger.name
 <envoy_v3_api_field_config.overload.v3.Trigger.name>` must be unique in
 this list.
        repeated .envoy.config.overload.v3.Trigger triggers = 2 [(.validate.rules) = { ... }
        Specified by:
        getTriggersOrBuilderList in interface LoadShedPointOrBuilder

      • getTriggersCount

        public int getTriggersCount()
         A set of triggers for this LoadShedPoint. The LoadShedPoint will use the
 the maximum state of all triggers, which can be scalar values between 0 and
 1 or saturated. A LoadShedPoint can only have one trigger for a given
 resource e.g. :ref:`Trigger.name
 <envoy_v3_api_field_config.overload.v3.Trigger.name>` must be unique in
 this list.
        repeated .envoy.config.overload.v3.Trigger triggers = 2 [(.validate.rules) = { ... }
        Specified by:
        getTriggersCount in interface LoadShedPointOrBuilder

      • getTriggers

        public Trigger getTriggers​(int index)
         A set of triggers for this LoadShedPoint. The LoadShedPoint will use the
 the maximum state of all triggers, which can be scalar values between 0 and
 1 or saturated. A LoadShedPoint can only have one trigger for a given
 resource e.g. :ref:`Trigger.name
 <envoy_v3_api_field_config.overload.v3.Trigger.name>` must be unique in
 this list.
        repeated .envoy.config.overload.v3.Trigger triggers = 2 [(.validate.rules) = { ... }
        Specified by:
        getTriggers in interface LoadShedPointOrBuilder

      • getTriggersOrBuilder

        public TriggerOrBuilder getTriggersOrBuilder​(int index)
         A set of triggers for this LoadShedPoint. The LoadShedPoint will use the
 the maximum state of all triggers, which can be scalar values between 0 and
 1 or saturated. A LoadShedPoint can only have one trigger for a given
 resource e.g. :ref:`Trigger.name
 <envoy_v3_api_field_config.overload.v3.Trigger.name>` must be unique in
 this list.
        repeated .envoy.config.overload.v3.Trigger triggers = 2 [(.validate.rules) = { ... }
        Specified by:
        getTriggersOrBuilder in interface LoadShedPointOrBuilder

      • isInitialized

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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 LoadShedPoint parseFrom​(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected LoadShedPoint.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static LoadShedPoint getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<LoadShedPoint> 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.GeneratedMessageV3

      • getDefaultInstanceForType

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