Class Extension.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<Extension.Builder>
com.google.protobuf.GeneratedMessage.Builder<Extension.Builder>
io.envoyproxy.envoy.config.core.v3.Extension.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ExtensionOrBuilder, Cloneable
Enclosing class:
Extension
public static final class Extension.Builder extends com.google.protobuf.GeneratedMessage.Builder<Extension.Builder> implements ExtensionOrBuilder
Version and identification for an Envoy extension.
[#next-free-field: 7]
Protobuf type envoy.config.core.v3.Extension

  • Method Summary

    Modifier and Type
    Method
    Description
    Extension.Builder
    addAllTypeUrls(Iterable<String> values)
    Type URLs of extension configuration protos.
    Extension.Builder
    addTypeUrls(String value)
    Type URLs of extension configuration protos.
    Extension.Builder
    addTypeUrlsBytes(com.google.protobuf.ByteString value)
    Type URLs of extension configuration protos.
    Extension
    build()
     
    Extension
    buildPartial()
     
    Extension.Builder
    clear()
     
    Extension.Builder
    clearCategory()
    Category of the extension.
    Extension.Builder
    clearDisabled()
    Indicates that the extension is present but was disabled via dynamic configuration.
    Extension.Builder
    clearName()
    This is the name of the Envoy filter as specified in the Envoy configuration, e.g. envoy.filters.http.router, com.acme.widget.
    Extension.Builder
    clearTypeDescriptor()
    Deprecated.
    envoy.config.core.v3.Extension.type_descriptor is deprecated.
    Extension.Builder
    clearTypeUrls()
    Type URLs of extension configuration protos.
    Extension.Builder
    clearVersion()
    The version is a property of the extension and maintained independently of other extensions and the Envoy API.
    String
    getCategory()
    Category of the extension.
    com.google.protobuf.ByteString
    getCategoryBytes()
    Category of the extension.
    Extension
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    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()
    Deprecated.
    envoy.config.core.v3.Extension.type_descriptor is deprecated.
    com.google.protobuf.ByteString
    getTypeDescriptorBytes()
    Deprecated.
    envoy.config.core.v3.Extension.type_descriptor is deprecated.
    String
    getTypeUrls(int index)
    Type URLs of extension configuration protos.
    com.google.protobuf.ByteString
    getTypeUrlsBytes(int index)
    Type URLs of extension configuration protos.
    int
    getTypeUrlsCount()
    Type URLs of extension configuration protos.
    com.google.protobuf.ProtocolStringList
    getTypeUrlsList()
    Type URLs of extension configuration protos.
    BuildVersion
    getVersion()
    The version is a property of the extension and maintained independently of other extensions and the Envoy API.
    BuildVersion.Builder
    getVersionBuilder()
    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.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    Extension.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    Extension.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    Extension.Builder
    mergeFrom(Extension other)
     
    Extension.Builder
    mergeVersion(BuildVersion value)
    The version is a property of the extension and maintained independently of other extensions and the Envoy API.
    Extension.Builder
    setCategory(String value)
    Category of the extension.
    Extension.Builder
    setCategoryBytes(com.google.protobuf.ByteString value)
    Category of the extension.
    Extension.Builder
    setDisabled(boolean value)
    Indicates that the extension is present but was disabled via dynamic configuration.
    Extension.Builder
    setName(String value)
    This is the name of the Envoy filter as specified in the Envoy configuration, e.g. envoy.filters.http.router, com.acme.widget.
    Extension.Builder
    setNameBytes(com.google.protobuf.ByteString value)
    This is the name of the Envoy filter as specified in the Envoy configuration, e.g. envoy.filters.http.router, com.acme.widget.
    Extension.Builder
    setTypeDescriptor(String value)
    Deprecated.
    envoy.config.core.v3.Extension.type_descriptor is deprecated.
    Extension.Builder
    setTypeDescriptorBytes(com.google.protobuf.ByteString value)
    Deprecated.
    envoy.config.core.v3.Extension.type_descriptor is deprecated.
    Extension.Builder
    setTypeUrls(int index, String value)
    Type URLs of extension configuration protos.
    Extension.Builder
    setVersion(BuildVersion value)
    The version is a property of the extension and maintained independently of other extensions and the Envoy API.
    Extension.Builder
    setVersion(BuildVersion.Builder builderForValue)
    The version is a property of the extension and maintained independently of other extensions and the Envoy API.

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • 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.Builder<Extension.Builder>

    • clear

      public Extension.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<Extension.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Extension.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public Extension.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Extension.Builder>

    • mergeFrom

      public Extension.Builder mergeFrom(Extension other)

    • isInitialized

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

    • mergeFrom

      public Extension.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Extension.Builder>
      Throws:
      IOException

    • 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.

    • setName

      public Extension.Builder setName(String value)
      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;
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public Extension.Builder clearName()
      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:
      This builder for chaining.

    • setNameBytes

      public Extension.Builder setNameBytes(com.google.protobuf.ByteString value)
      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;
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • 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.

    • setCategory

      public Extension.Builder setCategory(String value)
      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;
      Parameters:
      value - The category to set.
      Returns:
      This builder for chaining.

    • clearCategory

      public Extension.Builder clearCategory()
      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:
      This builder for chaining.

    • setCategoryBytes

      public Extension.Builder setCategoryBytes(com.google.protobuf.ByteString value)
      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;
      Parameters:
      value - The bytes for category to set.
      Returns:
      This builder for chaining.

    • getTypeDescriptor

      @Deprecated public 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"];
      Specified by:
      getTypeDescriptor in interface ExtensionOrBuilder
      Returns:
      The typeDescriptor.

    • getTypeDescriptorBytes

      @Deprecated public 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"];
      Specified by:
      getTypeDescriptorBytes in interface ExtensionOrBuilder
      Returns:
      The bytes for typeDescriptor.

    • setTypeDescriptor

      @Deprecated public Extension.Builder setTypeDescriptor(String value)
      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"];
      Parameters:
      value - The typeDescriptor to set.
      Returns:
      This builder for chaining.

    • clearTypeDescriptor

      @Deprecated public Extension.Builder clearTypeDescriptor()
      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:
      This builder for chaining.

    • setTypeDescriptorBytes

      @Deprecated public Extension.Builder setTypeDescriptorBytes(com.google.protobuf.ByteString value)
      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"];
      Parameters:
      value - The bytes for typeDescriptor to set.
      Returns:
      This builder for chaining.

    • 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.config.core.v3.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.config.core.v3.BuildVersion version = 4;
      Specified by:
      getVersion in interface ExtensionOrBuilder
      Returns:
      The version.

    • setVersion

      public Extension.Builder setVersion(BuildVersion value)
      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;

    • setVersion

      public Extension.Builder setVersion(BuildVersion.Builder builderForValue)
      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;

    • mergeVersion

      public Extension.Builder mergeVersion(BuildVersion value)
      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;

    • clearVersion

      public Extension.Builder clearVersion()
      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;

    • getVersionBuilder

      public BuildVersion.Builder getVersionBuilder()
      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;

    • 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.config.core.v3.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.

    • setDisabled

      public Extension.Builder setDisabled(boolean value)
      Indicates that the extension is present but was disabled via dynamic configuration.
      bool disabled = 5;
      Parameters:
      value - The disabled to set.
      Returns:
      This builder for chaining.

    • clearDisabled

      public Extension.Builder clearDisabled()
      Indicates that the extension is present but was disabled via dynamic configuration.
      bool disabled = 5;
      Returns:
      This builder for chaining.

    • getTypeUrlsList

      public com.google.protobuf.ProtocolStringList getTypeUrlsList()
      Type URLs of extension configuration protos.
      repeated string type_urls = 6;
      Specified by:
      getTypeUrlsList in interface ExtensionOrBuilder
      Returns:
      A list containing the typeUrls.

    • getTypeUrlsCount

      public int getTypeUrlsCount()
      Type URLs of extension configuration protos.
      repeated string type_urls = 6;
      Specified by:
      getTypeUrlsCount in interface ExtensionOrBuilder
      Returns:
      The count of typeUrls.

    • getTypeUrls

      public String getTypeUrls(int index)
      Type URLs of extension configuration protos.
      repeated string type_urls = 6;
      Specified by:
      getTypeUrls in interface ExtensionOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The typeUrls at the given index.

    • getTypeUrlsBytes

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

    • setTypeUrls

      public Extension.Builder setTypeUrls(int index, String value)
      Type URLs of extension configuration protos.
      repeated string type_urls = 6;
      Parameters:
      index - The index to set the value at.
      value - The typeUrls to set.
      Returns:
      This builder for chaining.

    • addTypeUrls

      public Extension.Builder addTypeUrls(String value)
      Type URLs of extension configuration protos.
      repeated string type_urls = 6;
      Parameters:
      value - The typeUrls to add.
      Returns:
      This builder for chaining.

    • addAllTypeUrls

      public Extension.Builder addAllTypeUrls(Iterable<String> values)
      Type URLs of extension configuration protos.
      repeated string type_urls = 6;
      Parameters:
      values - The typeUrls to add.
      Returns:
      This builder for chaining.

    • clearTypeUrls

      public Extension.Builder clearTypeUrls()
      Type URLs of extension configuration protos.
      repeated string type_urls = 6;
      Returns:
      This builder for chaining.

    • addTypeUrlsBytes

      public Extension.Builder addTypeUrlsBytes(com.google.protobuf.ByteString value)
      Type URLs of extension configuration protos.
      repeated string type_urls = 6;
      Parameters:
      value - The bytes of the typeUrls to add.
      Returns:
      This builder for chaining.