Package io.envoyproxy.envoy.api.v2.core

Class Extension

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.api.v2.core.Extension
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ExtensionOrBuilder, Serializable
public final class Extension extends com.google.protobuf.GeneratedMessageV3 implements ExtensionOrBuilder
 Version and identification for an Envoy extension.
 [#next-free-field: 6]
Protobuf type envoy.api.v2.core.Extension
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Extension.Builder
    Version and identification for an Envoy extension.

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

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, 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 final int
    CATEGORY_FIELD_NUMBER
     
    static final int
    DISABLED_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    TYPE_DESCRIPTOR_FIELD_NUMBER
     
    static final int
    VERSION_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 Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    String
    getCategory()
    Category of the extension.
    com.google.protobuf.ByteString
    getCategoryBytes()
    Category of the extension.
    static Extension
    getDefaultInstance()
     
    Extension
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    boolean
    getDisabled()
    Indicates that the extension is present but was disabled via dynamic configuration.
    String
    getName()
    This is the name of the Envoy filter as specified in the Envoy configuration, e.g. envoy.filters.http.router, com.acme.widget.
    com.google.protobuf.ByteString
    getNameBytes()
    This is the name of the Envoy filter as specified in the Envoy configuration, e.g. envoy.filters.http.router, com.acme.widget.
    com.google.protobuf.Parser<Extension>
    getParserForType()
     
    int
    getSerializedSize()
     
    String
    getTypeDescriptor()
    [#not-implemented-hide:] Type descriptor of extension configuration proto.
    com.google.protobuf.ByteString
    getTypeDescriptorBytes()
    [#not-implemented-hide:] Type descriptor of extension configuration proto.
    BuildVersion
    getVersion()
    The version is a property of the extension and maintained independently of other extensions and the Envoy API.
    BuildVersionOrBuilder
    getVersionOrBuilder()
    The version is a property of the extension and maintained independently of other extensions and the Envoy API.
    int
    hashCode()
     
    boolean
    hasVersion()
    The version is a property of the extension and maintained independently of other extensions and the Envoy API.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Extension.Builder
    newBuilder()
     
    static Extension.Builder
    newBuilder(Extension prototype)
     
    Extension.Builder
    newBuilderForType()
     
    protected Extension.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Extension
    parseDelimitedFrom(InputStream input)
     
    static Extension
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Extension
    parseFrom(byte[] data)
     
    static Extension
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Extension
    parseFrom(com.google.protobuf.ByteString data)
     
    static Extension
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Extension
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Extension
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Extension
    parseFrom(InputStream input)
     
    static Extension
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Extension
    parseFrom(ByteBuffer data)
     
    static Extension
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Extension>
    parser()
     
    Extension.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    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, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, 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

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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 the name of the Envoy filter as specified in the Envoy
 configuration, e.g. envoy.filters.http.router, com.acme.widget.
      string name = 1;
      Specified by:
      getName in interface ExtensionOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       This is the name of the Envoy filter as specified in the Envoy
 configuration, e.g. envoy.filters.http.router, com.acme.widget.
      string name = 1;
      Specified by:
      getNameBytes in interface ExtensionOrBuilder
      Returns:
      The bytes for name.

    • getCategory

      public String getCategory()
       Category of the extension.
 Extension category names use reverse DNS notation. For instance "envoy.filters.listener"
 for Envoy's built-in listener filters or "com.acme.filters.http" for HTTP filters from
 acme.com vendor.
 [#comment:TODO(yanavlasov): Link to the doc with existing envoy category names.]
      string category = 2;
      Specified by:
      getCategory in interface ExtensionOrBuilder
      Returns:
      The category.

    • getCategoryBytes

      public com.google.protobuf.ByteString getCategoryBytes()
       Category of the extension.
 Extension category names use reverse DNS notation. For instance "envoy.filters.listener"
 for Envoy's built-in listener filters or "com.acme.filters.http" for HTTP filters from
 acme.com vendor.
 [#comment:TODO(yanavlasov): Link to the doc with existing envoy category names.]
      string category = 2;
      Specified by:
      getCategoryBytes in interface ExtensionOrBuilder
      Returns:
      The bytes for category.

    • getTypeDescriptor

      public String getTypeDescriptor()
       [#not-implemented-hide:] Type descriptor of extension configuration proto.
 [#comment:TODO(yanavlasov): Link to the doc with existing configuration protos.]
 [#comment:TODO(yanavlasov): Add tests when PR #9391 lands.]
      string type_descriptor = 3;
      Specified by:
      getTypeDescriptor in interface ExtensionOrBuilder
      Returns:
      The typeDescriptor.

    • getTypeDescriptorBytes

      public com.google.protobuf.ByteString getTypeDescriptorBytes()
       [#not-implemented-hide:] Type descriptor of extension configuration proto.
 [#comment:TODO(yanavlasov): Link to the doc with existing configuration protos.]
 [#comment:TODO(yanavlasov): Add tests when PR #9391 lands.]
      string type_descriptor = 3;
      Specified by:
      getTypeDescriptorBytes in interface ExtensionOrBuilder
      Returns:
      The bytes for typeDescriptor.

    • hasVersion

      public boolean hasVersion()
       The version is a property of the extension and maintained independently
 of other extensions and the Envoy API.
 This field is not set when extension did not provide version information.
      .envoy.api.v2.core.BuildVersion version = 4;
      Specified by:
      hasVersion in interface ExtensionOrBuilder
      Returns:
      Whether the version field is set.

    • getVersion

      public BuildVersion getVersion()
       The version is a property of the extension and maintained independently
 of other extensions and the Envoy API.
 This field is not set when extension did not provide version information.
      .envoy.api.v2.core.BuildVersion version = 4;
      Specified by:
      getVersion in interface ExtensionOrBuilder
      Returns:
      The version.

    • getVersionOrBuilder

      public BuildVersionOrBuilder getVersionOrBuilder()
       The version is a property of the extension and maintained independently
 of other extensions and the Envoy API.
 This field is not set when extension did not provide version information.
      .envoy.api.v2.core.BuildVersion version = 4;
      Specified by:
      getVersionOrBuilder in interface ExtensionOrBuilder

    • getDisabled

      public boolean getDisabled()
       Indicates that the extension is present but was disabled via dynamic configuration.
      bool disabled = 5;
      Specified by:
      getDisabled in interface ExtensionOrBuilder
      Returns:
      The disabled.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Extension.Builder newBuilder()

    • newBuilder

      public static Extension.Builder newBuilder(Extension prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Extension getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Extension> 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 Extension getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder