Package io.envoyproxy.envoy.config.bootstrap.v3

Class Admin.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, AdminOrBuilder, Cloneable
    Enclosing class:
    Admin
    public static final class Admin.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Admin.Builder>
implements AdminOrBuilder
     Administration interface :ref:`operations documentation
 <operations_admin_interface>`.
 [#next-free-field: 7]
    Protobuf type envoy.config.bootstrap.v3.Admin

    • Method Detail

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

      • clear

        public Admin.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.GeneratedMessageV3.Builder<Admin.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.GeneratedMessageV3.Builder<Admin.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public Admin.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<Admin.Builder>

      • setField

        public Admin.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                              Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Admin.Builder>

      • clearField

        public Admin.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Admin.Builder>

      • clearOneof

        public Admin.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Admin.Builder>

      • setRepeatedField

        public Admin.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                      int index,
                                      Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Admin.Builder>

      • addRepeatedField

        public Admin.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                      Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Admin.Builder>

      • mergeFrom

        public Admin.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<Admin.Builder>

      • isInitialized

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

      • mergeFrom

        public Admin.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<Admin.Builder>
        Throws:
        IOException

      • getAccessLogList

        public List<AccessLog> getAccessLogList()
         Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by the administration server.
        repeated .envoy.config.accesslog.v3.AccessLog access_log = 5;
        Specified by:
        getAccessLogList in interface AdminOrBuilder

      • getAccessLogCount

        public int getAccessLogCount()
         Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by the administration server.
        repeated .envoy.config.accesslog.v3.AccessLog access_log = 5;
        Specified by:
        getAccessLogCount in interface AdminOrBuilder

      • getAccessLog

        public AccessLog getAccessLog​(int index)
         Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by the administration server.
        repeated .envoy.config.accesslog.v3.AccessLog access_log = 5;
        Specified by:
        getAccessLog in interface AdminOrBuilder

      • setAccessLog

        public Admin.Builder setAccessLog​(int index,
                                  AccessLog value)
         Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by the administration server.
        repeated .envoy.config.accesslog.v3.AccessLog access_log = 5;

      • setAccessLog

        public Admin.Builder setAccessLog​(int index,
                                  AccessLog.Builder builderForValue)
         Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by the administration server.
        repeated .envoy.config.accesslog.v3.AccessLog access_log = 5;

      • addAccessLog

        public Admin.Builder addAccessLog​(AccessLog value)
         Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by the administration server.
        repeated .envoy.config.accesslog.v3.AccessLog access_log = 5;

      • addAccessLog

        public Admin.Builder addAccessLog​(int index,
                                  AccessLog value)
         Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by the administration server.
        repeated .envoy.config.accesslog.v3.AccessLog access_log = 5;

      • addAccessLog

        public Admin.Builder addAccessLog​(AccessLog.Builder builderForValue)
         Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by the administration server.
        repeated .envoy.config.accesslog.v3.AccessLog access_log = 5;

      • addAccessLog

        public Admin.Builder addAccessLog​(int index,
                                  AccessLog.Builder builderForValue)
         Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by the administration server.
        repeated .envoy.config.accesslog.v3.AccessLog access_log = 5;

      • addAllAccessLog

        public Admin.Builder addAllAccessLog​(Iterable<? extends AccessLog> values)
         Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by the administration server.
        repeated .envoy.config.accesslog.v3.AccessLog access_log = 5;

      • clearAccessLog

        public Admin.Builder clearAccessLog()
         Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by the administration server.
        repeated .envoy.config.accesslog.v3.AccessLog access_log = 5;

      • removeAccessLog

        public Admin.Builder removeAccessLog​(int index)
         Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by the administration server.
        repeated .envoy.config.accesslog.v3.AccessLog access_log = 5;

      • getAccessLogBuilder

        public AccessLog.Builder getAccessLogBuilder​(int index)
         Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by the administration server.
        repeated .envoy.config.accesslog.v3.AccessLog access_log = 5;

      • getAccessLogOrBuilder

        public AccessLogOrBuilder getAccessLogOrBuilder​(int index)
         Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by the administration server.
        repeated .envoy.config.accesslog.v3.AccessLog access_log = 5;
        Specified by:
        getAccessLogOrBuilder in interface AdminOrBuilder

      • getAccessLogOrBuilderList

        public List<? extends AccessLogOrBuilder> getAccessLogOrBuilderList()
         Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by the administration server.
        repeated .envoy.config.accesslog.v3.AccessLog access_log = 5;
        Specified by:
        getAccessLogOrBuilderList in interface AdminOrBuilder

      • addAccessLogBuilder

        public AccessLog.Builder addAccessLogBuilder()
         Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by the administration server.
        repeated .envoy.config.accesslog.v3.AccessLog access_log = 5;

      • addAccessLogBuilder

        public AccessLog.Builder addAccessLogBuilder​(int index)
         Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by the administration server.
        repeated .envoy.config.accesslog.v3.AccessLog access_log = 5;

      • getAccessLogBuilderList

        public List<AccessLog.Builder> getAccessLogBuilderList()
         Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by the administration server.
        repeated .envoy.config.accesslog.v3.AccessLog access_log = 5;

      • getAccessLogPath

        @Deprecated
public String getAccessLogPath()
        Deprecated.
        envoy.config.bootstrap.v3.Admin.access_log_path is deprecated. See envoy/config/bootstrap/v3/bootstrap.proto;l=353
         The path to write the access log for the administration server. If no
 access log is desired specify ‘/dev/null’. This is only required if
 :ref:`address <envoy_v3_api_field_config.bootstrap.v3.Admin.address>` is set.
 Deprecated in favor of ``access_log`` which offers more options.
        string access_log_path = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getAccessLogPath in interface AdminOrBuilder
        Returns:
        The accessLogPath.

      • getAccessLogPathBytes

        @Deprecated
public com.google.protobuf.ByteString getAccessLogPathBytes()
        Deprecated.
        envoy.config.bootstrap.v3.Admin.access_log_path is deprecated. See envoy/config/bootstrap/v3/bootstrap.proto;l=353
         The path to write the access log for the administration server. If no
 access log is desired specify ‘/dev/null’. This is only required if
 :ref:`address <envoy_v3_api_field_config.bootstrap.v3.Admin.address>` is set.
 Deprecated in favor of ``access_log`` which offers more options.
        string access_log_path = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getAccessLogPathBytes in interface AdminOrBuilder
        Returns:
        The bytes for accessLogPath.

      • setAccessLogPath

        @Deprecated
public Admin.Builder setAccessLogPath​(String value)
        Deprecated.
        envoy.config.bootstrap.v3.Admin.access_log_path is deprecated. See envoy/config/bootstrap/v3/bootstrap.proto;l=353
         The path to write the access log for the administration server. If no
 access log is desired specify ‘/dev/null’. This is only required if
 :ref:`address <envoy_v3_api_field_config.bootstrap.v3.Admin.address>` is set.
 Deprecated in favor of ``access_log`` which offers more options.
        string access_log_path = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Parameters:
        value - The accessLogPath to set.
        Returns:
        This builder for chaining.

      • clearAccessLogPath

        @Deprecated
public Admin.Builder clearAccessLogPath()
        Deprecated.
        envoy.config.bootstrap.v3.Admin.access_log_path is deprecated. See envoy/config/bootstrap/v3/bootstrap.proto;l=353
         The path to write the access log for the administration server. If no
 access log is desired specify ‘/dev/null’. This is only required if
 :ref:`address <envoy_v3_api_field_config.bootstrap.v3.Admin.address>` is set.
 Deprecated in favor of ``access_log`` which offers more options.
        string access_log_path = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Returns:
        This builder for chaining.

      • setAccessLogPathBytes

        @Deprecated
public Admin.Builder setAccessLogPathBytes​(com.google.protobuf.ByteString value)
        Deprecated.
        envoy.config.bootstrap.v3.Admin.access_log_path is deprecated. See envoy/config/bootstrap/v3/bootstrap.proto;l=353
         The path to write the access log for the administration server. If no
 access log is desired specify ‘/dev/null’. This is only required if
 :ref:`address <envoy_v3_api_field_config.bootstrap.v3.Admin.address>` is set.
 Deprecated in favor of ``access_log`` which offers more options.
        string access_log_path = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Parameters:
        value - The bytes for accessLogPath to set.
        Returns:
        This builder for chaining.

      • getProfilePath

        public String getProfilePath()
         The cpu profiler output path for the administration server. If no profile
 path is specified, the default is ‘/var/log/envoy/envoy.prof’.
        string profile_path = 2;
        Specified by:
        getProfilePath in interface AdminOrBuilder
        Returns:
        The profilePath.

      • getProfilePathBytes

        public com.google.protobuf.ByteString getProfilePathBytes()
         The cpu profiler output path for the administration server. If no profile
 path is specified, the default is ‘/var/log/envoy/envoy.prof’.
        string profile_path = 2;
        Specified by:
        getProfilePathBytes in interface AdminOrBuilder
        Returns:
        The bytes for profilePath.

      • setProfilePath

        public Admin.Builder setProfilePath​(String value)
         The cpu profiler output path for the administration server. If no profile
 path is specified, the default is ‘/var/log/envoy/envoy.prof’.
        string profile_path = 2;
        Parameters:
        value - The profilePath to set.
        Returns:
        This builder for chaining.

      • clearProfilePath

        public Admin.Builder clearProfilePath()
         The cpu profiler output path for the administration server. If no profile
 path is specified, the default is ‘/var/log/envoy/envoy.prof’.
        string profile_path = 2;
        Returns:
        This builder for chaining.

      • setProfilePathBytes

        public Admin.Builder setProfilePathBytes​(com.google.protobuf.ByteString value)
         The cpu profiler output path for the administration server. If no profile
 path is specified, the default is ‘/var/log/envoy/envoy.prof’.
        string profile_path = 2;
        Parameters:
        value - The bytes for profilePath to set.
        Returns:
        This builder for chaining.

      • hasAddress

        public boolean hasAddress()
         The TCP address that the administration server will listen on.
 If not specified, Envoy will not start an administration server.
        .envoy.config.core.v3.Address address = 3;
        Specified by:
        hasAddress in interface AdminOrBuilder
        Returns:
        Whether the address field is set.

      • getAddress

        public Address getAddress()
         The TCP address that the administration server will listen on.
 If not specified, Envoy will not start an administration server.
        .envoy.config.core.v3.Address address = 3;
        Specified by:
        getAddress in interface AdminOrBuilder
        Returns:
        The address.

      • setAddress

        public Admin.Builder setAddress​(Address value)
         The TCP address that the administration server will listen on.
 If not specified, Envoy will not start an administration server.
        .envoy.config.core.v3.Address address = 3;

      • setAddress

        public Admin.Builder setAddress​(Address.Builder builderForValue)
         The TCP address that the administration server will listen on.
 If not specified, Envoy will not start an administration server.
        .envoy.config.core.v3.Address address = 3;

      • mergeAddress

        public Admin.Builder mergeAddress​(Address value)
         The TCP address that the administration server will listen on.
 If not specified, Envoy will not start an administration server.
        .envoy.config.core.v3.Address address = 3;

      • clearAddress

        public Admin.Builder clearAddress()
         The TCP address that the administration server will listen on.
 If not specified, Envoy will not start an administration server.
        .envoy.config.core.v3.Address address = 3;

      • getAddressBuilder

        public Address.Builder getAddressBuilder()
         The TCP address that the administration server will listen on.
 If not specified, Envoy will not start an administration server.
        .envoy.config.core.v3.Address address = 3;

      • getAddressOrBuilder

        public AddressOrBuilder getAddressOrBuilder()
         The TCP address that the administration server will listen on.
 If not specified, Envoy will not start an administration server.
        .envoy.config.core.v3.Address address = 3;
        Specified by:
        getAddressOrBuilder in interface AdminOrBuilder

      • getSocketOptionsList

        public List<SocketOption> getSocketOptionsList()
         Additional socket options that may not be present in Envoy source code or
 precompiled binaries.
        repeated .envoy.config.core.v3.SocketOption socket_options = 4;
        Specified by:
        getSocketOptionsList in interface AdminOrBuilder

      • getSocketOptionsCount

        public int getSocketOptionsCount()
         Additional socket options that may not be present in Envoy source code or
 precompiled binaries.
        repeated .envoy.config.core.v3.SocketOption socket_options = 4;
        Specified by:
        getSocketOptionsCount in interface AdminOrBuilder

      • getSocketOptions

        public SocketOption getSocketOptions​(int index)
         Additional socket options that may not be present in Envoy source code or
 precompiled binaries.
        repeated .envoy.config.core.v3.SocketOption socket_options = 4;
        Specified by:
        getSocketOptions in interface AdminOrBuilder

      • setSocketOptions

        public Admin.Builder setSocketOptions​(int index,
                                      SocketOption value)
         Additional socket options that may not be present in Envoy source code or
 precompiled binaries.
        repeated .envoy.config.core.v3.SocketOption socket_options = 4;

      • setSocketOptions

        public Admin.Builder setSocketOptions​(int index,
                                      SocketOption.Builder builderForValue)
         Additional socket options that may not be present in Envoy source code or
 precompiled binaries.
        repeated .envoy.config.core.v3.SocketOption socket_options = 4;

      • addSocketOptions

        public Admin.Builder addSocketOptions​(SocketOption value)
         Additional socket options that may not be present in Envoy source code or
 precompiled binaries.
        repeated .envoy.config.core.v3.SocketOption socket_options = 4;

      • addSocketOptions

        public Admin.Builder addSocketOptions​(int index,
                                      SocketOption value)
         Additional socket options that may not be present in Envoy source code or
 precompiled binaries.
        repeated .envoy.config.core.v3.SocketOption socket_options = 4;

      • addSocketOptions

        public Admin.Builder addSocketOptions​(SocketOption.Builder builderForValue)
         Additional socket options that may not be present in Envoy source code or
 precompiled binaries.
        repeated .envoy.config.core.v3.SocketOption socket_options = 4;

      • addSocketOptions

        public Admin.Builder addSocketOptions​(int index,
                                      SocketOption.Builder builderForValue)
         Additional socket options that may not be present in Envoy source code or
 precompiled binaries.
        repeated .envoy.config.core.v3.SocketOption socket_options = 4;

      • addAllSocketOptions

        public Admin.Builder addAllSocketOptions​(Iterable<? extends SocketOption> values)
         Additional socket options that may not be present in Envoy source code or
 precompiled binaries.
        repeated .envoy.config.core.v3.SocketOption socket_options = 4;

      • clearSocketOptions

        public Admin.Builder clearSocketOptions()
         Additional socket options that may not be present in Envoy source code or
 precompiled binaries.
        repeated .envoy.config.core.v3.SocketOption socket_options = 4;

      • removeSocketOptions

        public Admin.Builder removeSocketOptions​(int index)
         Additional socket options that may not be present in Envoy source code or
 precompiled binaries.
        repeated .envoy.config.core.v3.SocketOption socket_options = 4;

      • getSocketOptionsBuilder

        public SocketOption.Builder getSocketOptionsBuilder​(int index)
         Additional socket options that may not be present in Envoy source code or
 precompiled binaries.
        repeated .envoy.config.core.v3.SocketOption socket_options = 4;

      • getSocketOptionsOrBuilder

        public SocketOptionOrBuilder getSocketOptionsOrBuilder​(int index)
         Additional socket options that may not be present in Envoy source code or
 precompiled binaries.
        repeated .envoy.config.core.v3.SocketOption socket_options = 4;
        Specified by:
        getSocketOptionsOrBuilder in interface AdminOrBuilder

      • getSocketOptionsOrBuilderList

        public List<? extends SocketOptionOrBuilder> getSocketOptionsOrBuilderList()
         Additional socket options that may not be present in Envoy source code or
 precompiled binaries.
        repeated .envoy.config.core.v3.SocketOption socket_options = 4;
        Specified by:
        getSocketOptionsOrBuilderList in interface AdminOrBuilder

      • addSocketOptionsBuilder

        public SocketOption.Builder addSocketOptionsBuilder()
         Additional socket options that may not be present in Envoy source code or
 precompiled binaries.
        repeated .envoy.config.core.v3.SocketOption socket_options = 4;

      • addSocketOptionsBuilder

        public SocketOption.Builder addSocketOptionsBuilder​(int index)
         Additional socket options that may not be present in Envoy source code or
 precompiled binaries.
        repeated .envoy.config.core.v3.SocketOption socket_options = 4;

      • getSocketOptionsBuilderList

        public List<SocketOption.Builder> getSocketOptionsBuilderList()
         Additional socket options that may not be present in Envoy source code or
 precompiled binaries.
        repeated .envoy.config.core.v3.SocketOption socket_options = 4;

      • getIgnoreGlobalConnLimit

        public boolean getIgnoreGlobalConnLimit()
         Indicates whether :ref:`global_downstream_max_connections <config_overload_manager_limiting_connections>`
 should apply to the admin interface or not.
        bool ignore_global_conn_limit = 6;
        Specified by:
        getIgnoreGlobalConnLimit in interface AdminOrBuilder
        Returns:
        The ignoreGlobalConnLimit.

      • setIgnoreGlobalConnLimit

        public Admin.Builder setIgnoreGlobalConnLimit​(boolean value)
         Indicates whether :ref:`global_downstream_max_connections <config_overload_manager_limiting_connections>`
 should apply to the admin interface or not.
        bool ignore_global_conn_limit = 6;
        Parameters:
        value - The ignoreGlobalConnLimit to set.
        Returns:
        This builder for chaining.

      • clearIgnoreGlobalConnLimit

        public Admin.Builder clearIgnoreGlobalConnLimit()
         Indicates whether :ref:`global_downstream_max_connections <config_overload_manager_limiting_connections>`
 should apply to the admin interface or not.
        bool ignore_global_conn_limit = 6;
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final Admin.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Admin.Builder>

      • mergeUnknownFields

        public final Admin.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Admin.Builder>