Class Admin

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, AdminOrBuilder, java.io.Serializable

    public final class Admin
    extends com.google.protobuf.GeneratedMessage
    implements AdminOrBuilder
     Administration interface :ref:`operations documentation
     <operations_admin_interface>`.
     [#next-free-field: 7]
     
    Protobuf type envoy.config.bootstrap.v3.Admin
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Admin.Builder
      Administration interface :ref:`operations documentation <operations_admin_interface>`.
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

        com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,​T extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

        com.google.protobuf.AbstractMessage.BuilderParent
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private Admin()  
      private Admin​(com.google.protobuf.GeneratedMessage.Builder<?> builder)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      AccessLog getAccessLog​(int index)
      Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by the administration server.
      int getAccessLogCount()
      Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by the administration server.
      java.util.List<AccessLog> getAccessLogList()
      Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by the administration server.
      AccessLogOrBuilder getAccessLogOrBuilder​(int index)
      Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by the administration server.
      java.util.List<? extends AccessLogOrBuilder> getAccessLogOrBuilderList()
      Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by the administration server.
      java.lang.String getAccessLogPath()
      Deprecated.
      envoy.config.bootstrap.v3.Admin.access_log_path is deprecated.
      com.google.protobuf.ByteString getAccessLogPathBytes()
      Deprecated.
      envoy.config.bootstrap.v3.Admin.access_log_path is deprecated.
      Address getAddress()
      The TCP address that the administration server will listen on.
      AddressOrBuilder getAddressOrBuilder()
      The TCP address that the administration server will listen on.
      static Admin getDefaultInstance()  
      Admin getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      boolean getIgnoreGlobalConnLimit()
      Indicates whether :ref:`global_downstream_max_connections <config_overload_manager_limiting_connections>` should apply to the admin interface or not.
      com.google.protobuf.Parser<Admin> getParserForType()  
      java.lang.String getProfilePath()
      The cpu profiler output path for the administration server.
      com.google.protobuf.ByteString getProfilePathBytes()
      The cpu profiler output path for the administration server.
      int getSerializedSize()  
      SocketOption getSocketOptions​(int index)
      Additional socket options that may not be present in Envoy source code or precompiled binaries.
      int getSocketOptionsCount()
      Additional socket options that may not be present in Envoy source code or precompiled binaries.
      java.util.List<SocketOption> getSocketOptionsList()
      Additional socket options that may not be present in Envoy source code or precompiled binaries.
      SocketOptionOrBuilder getSocketOptionsOrBuilder​(int index)
      Additional socket options that may not be present in Envoy source code or precompiled binaries.
      java.util.List<? extends SocketOptionOrBuilder> getSocketOptionsOrBuilderList()
      Additional socket options that may not be present in Envoy source code or precompiled binaries.
      boolean hasAddress()
      The TCP address that the administration server will listen on.
      int hashCode()  
      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static Admin.Builder newBuilder()  
      static Admin.Builder newBuilder​(Admin prototype)  
      Admin.Builder newBuilderForType()  
      protected Admin.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)  
      static Admin parseDelimitedFrom​(java.io.InputStream input)  
      static Admin parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Admin parseFrom​(byte[] data)  
      static Admin parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Admin parseFrom​(com.google.protobuf.ByteString data)  
      static Admin parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Admin parseFrom​(com.google.protobuf.CodedInputStream input)  
      static Admin parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Admin parseFrom​(java.io.InputStream input)  
      static Admin parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Admin parseFrom​(java.nio.ByteBuffer data)  
      static Admin parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Admin> parser()  
      Admin.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  
      • Methods inherited from class com.google.protobuf.GeneratedMessage

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString
      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        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 Detail

      • bitField0_

        private int bitField0_
      • ACCESS_LOG_FIELD_NUMBER

        public static final int ACCESS_LOG_FIELD_NUMBER
        See Also:
        Constant Field Values
      • accessLog_

        private java.util.List<AccessLog> accessLog_
      • ACCESS_LOG_PATH_FIELD_NUMBER

        public static final int ACCESS_LOG_PATH_FIELD_NUMBER
        See Also:
        Constant Field Values
      • accessLogPath_

        private volatile java.lang.Object accessLogPath_
      • PROFILE_PATH_FIELD_NUMBER

        public static final int PROFILE_PATH_FIELD_NUMBER
        See Also:
        Constant Field Values
      • profilePath_

        private volatile java.lang.Object profilePath_
      • address_

        private Address address_
      • SOCKET_OPTIONS_FIELD_NUMBER

        public static final int SOCKET_OPTIONS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • socketOptions_

        private java.util.List<SocketOption> socketOptions_
      • IGNORE_GLOBAL_CONN_LIMIT_FIELD_NUMBER

        public static final int IGNORE_GLOBAL_CONN_LIMIT_FIELD_NUMBER
        See Also:
        Constant Field Values
      • ignoreGlobalConnLimit_

        private boolean ignoreGlobalConnLimit_
      • memoizedIsInitialized

        private byte memoizedIsInitialized
      • DEFAULT_INSTANCE

        private static final Admin DEFAULT_INSTANCE
      • PARSER

        private static final com.google.protobuf.Parser<Admin> PARSER
    • Constructor Detail

      • Admin

        private Admin​(com.google.protobuf.GeneratedMessage.Builder<?> builder)
      • Admin

        private Admin()
    • Method Detail

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

        public java.util.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
      • getAccessLogOrBuilderList

        public java.util.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
      • 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
      • 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
      • getAccessLogPath

        @Deprecated
        public java.lang.String getAccessLogPath()
        Deprecated.
        envoy.config.bootstrap.v3.Admin.access_log_path is deprecated. See envoy/config/bootstrap/v3/bootstrap.proto;l=433
         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=433
         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.
      • getProfilePath

        public java.lang.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.
      • 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.
      • 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 java.util.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
      • getSocketOptionsOrBuilderList

        public java.util.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
      • 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
      • 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
      • 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.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessage
      • equals

        public boolean equals​(java.lang.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 Admin parseFrom​(java.nio.ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Admin parseFrom​(java.nio.ByteBuffer data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Admin parseFrom​(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

        public static Admin parseFrom​(java.io.InputStream input)
                               throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static Admin parseFrom​(java.io.InputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static Admin parseDelimitedFrom​(java.io.InputStream input)
                                        throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static Admin parseDelimitedFrom​(java.io.InputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static Admin parseFrom​(com.google.protobuf.CodedInputStream input)
                               throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static Admin parseFrom​(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws java.io.IOException
        Throws:
        java.io.IOException
      • newBuilderForType

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

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

        protected Admin.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage
      • getDefaultInstance

        public static Admin getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<Admin> parser()
      • getParserForType

        public com.google.protobuf.Parser<Admin> 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.GeneratedMessage
      • getDefaultInstanceForType

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