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

Interface ExtensionOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Extension, Extension.Builder
    public interface ExtensionOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getCategory()
      Category of the extension.
      com.google.protobuf.ByteString getCategoryBytes()
      Category of the extension.
      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.
      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.
      boolean hasVersion()
      The version is a property of the extension and maintained independently of other extensions and the Envoy API.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • getName

        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;
        Returns:
        The name.

      • getNameBytes

        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;
        Returns:
        The bytes for name.

      • getCategory

        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;
        Returns:
        The category.

      • getCategoryBytes

        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;
        Returns:
        The bytes for category.

      • getTypeDescriptor

        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;
        Returns:
        The typeDescriptor.

      • getTypeDescriptorBytes

        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;
        Returns:
        The bytes for typeDescriptor.

      • hasVersion

        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;
        Returns:
        Whether the version field is set.

      • getVersion

        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;
        Returns:
        The version.

      • getVersionOrBuilder

        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;

      • getDisabled

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