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

    Modifier and Type
    Method
    Description
    Category of the extension.
    com.google.protobuf.ByteString
    Category of the extension.
    boolean
    Indicates that the extension is present but was disabled via dynamic configuration.
    This is the name of the Envoy filter as specified in the Envoy configuration, e.g.
    com.google.protobuf.ByteString
    This is the name of the Envoy filter as specified in the Envoy configuration, e.g.
    Deprecated.
    envoy.config.core.v3.Extension.type_descriptor is deprecated.
    com.google.protobuf.ByteString
    Deprecated.
    envoy.config.core.v3.Extension.type_descriptor is deprecated.
    getTypeUrls(int index)
    Type URLs of extension configuration protos.
    com.google.protobuf.ByteString
    getTypeUrlsBytes(int index)
    Type URLs of extension configuration protos.
    int
    Type URLs of extension configuration protos.
    Type URLs of extension configuration protos.
    The version is a property of the extension and maintained independently of other extensions and the Envoy API.
    The version is a property of the extension and maintained independently of other extensions and the Envoy API.
    boolean
    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 Details

    • 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

      @Deprecated String getTypeDescriptor()
      Deprecated.
      envoy.config.core.v3.Extension.type_descriptor is deprecated. See envoy/config/core/v3/base.proto;l=123
       [#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 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Returns:
      The typeDescriptor.
    • getTypeDescriptorBytes

      @Deprecated com.google.protobuf.ByteString getTypeDescriptorBytes()
      Deprecated.
      envoy.config.core.v3.Extension.type_descriptor is deprecated. See envoy/config/core/v3/base.proto;l=123
       [#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 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      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.config.core.v3.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.config.core.v3.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.config.core.v3.BuildVersion version = 4;
    • getDisabled

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

      List<String> getTypeUrlsList()
       Type URLs of extension configuration protos.
       
      repeated string type_urls = 6;
      Returns:
      A list containing the typeUrls.
    • getTypeUrlsCount

      int getTypeUrlsCount()
       Type URLs of extension configuration protos.
       
      repeated string type_urls = 6;
      Returns:
      The count of typeUrls.
    • getTypeUrls

      String getTypeUrls(int index)
       Type URLs of extension configuration protos.
       
      repeated string type_urls = 6;
      Parameters:
      index - The index of the element to return.
      Returns:
      The typeUrls at the given index.
    • getTypeUrlsBytes

      com.google.protobuf.ByteString getTypeUrlsBytes(int index)
       Type URLs of extension configuration protos.
       
      repeated string type_urls = 6;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the typeUrls at the given index.