Interface AdminOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
Admin
,Admin.Builder
public interface AdminOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptiongetAccessLog
(int index) Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by the administration server.int
Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by the administration server.Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by the administration server.getAccessLogOrBuilder
(int index) Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by the administration server.List
<? extends AccessLogOrBuilder> Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by the administration server.Deprecated.envoy.config.bootstrap.v3.Admin.access_log_path is deprecated.com.google.protobuf.ByteString
Deprecated.envoy.config.bootstrap.v3.Admin.access_log_path is deprecated.The TCP address that the administration server will listen on.The TCP address that the administration server will listen on.boolean
Indicates whether :ref:`global_downstream_max_connections <config_overload_manager_limiting_connections>` should apply to the admin interface or not.The cpu profiler output path for the administration server.com.google.protobuf.ByteString
The cpu profiler output path for the administration server.getSocketOptions
(int index) Additional socket options that may not be present in Envoy source code or precompiled binaries.int
Additional socket options that may not be present in Envoy source code or precompiled binaries.Additional socket options that may not be present in Envoy source code or precompiled binaries.getSocketOptionsOrBuilder
(int index) Additional socket options that may not be present in Envoy source code or precompiled binaries.List
<? extends SocketOptionOrBuilder> Additional socket options that may not be present in Envoy source code or precompiled binaries.boolean
The TCP address that the administration server will listen on.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
-
getAccessLogList
Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by the administration server.
repeated .envoy.config.accesslog.v3.AccessLog access_log = 5;
-
getAccessLog
Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by the administration server.
repeated .envoy.config.accesslog.v3.AccessLog access_log = 5;
-
getAccessLogCount
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;
-
getAccessLogOrBuilderList
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;
-
getAccessLogOrBuilder
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.envoy.config.bootstrap.v3.Admin.access_log_path is deprecated. See envoy/config/bootstrap/v3/bootstrap.proto;l=433The 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:
- The accessLogPath.
-
getAccessLogPathBytes
Deprecated.envoy.config.bootstrap.v3.Admin.access_log_path is deprecated. See envoy/config/bootstrap/v3/bootstrap.proto;l=433The 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:
- The bytes for accessLogPath.
-
getProfilePath
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;
- Returns:
- The profilePath.
-
getProfilePathBytes
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;
- Returns:
- The bytes for profilePath.
-
hasAddress
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;
- Returns:
- Whether the address field is set.
-
getAddress
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;
- Returns:
- The address.
-
getAddressOrBuilder
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;
-
getSocketOptionsList
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;
-
getSocketOptions
Additional socket options that may not be present in Envoy source code or precompiled binaries.
repeated .envoy.config.core.v3.SocketOption socket_options = 4;
-
getSocketOptionsCount
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;
-
getSocketOptionsOrBuilderList
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;
-
getSocketOptionsOrBuilder
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
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;
- Returns:
- The ignoreGlobalConnLimit.
-