Class Admin
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.bootstrap.v3.Admin
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,AdminOrBuilder
,Serializable
Administration interface :ref:`operations documentation <operations_admin_interface>`. [#next-free-field: 7]Protobuf type
envoy.config.bootstrap.v3.Admin
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
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>, 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
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
static final int
private Object
private Address
static final int
private int
private static final Admin
static final int
private boolean
private byte
private static final com.google.protobuf.Parser
<Admin> static final int
private Object
private static final long
static final int
private List
<SocketOption> Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
getAccessLog
(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.static Admin
static final com.google.protobuf.Descriptors.Descriptor
boolean
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> The cpu profiler output path for the administration server.com.google.protobuf.ByteString
The cpu profiler output path for the administration server.int
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.int
hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
static Admin.Builder
static Admin.Builder
newBuilder
(Admin prototype) protected Admin.Builder
newBuilderForType
(com.google.protobuf.AbstractMessage.BuilderParent parent) static Admin
parseDelimitedFrom
(InputStream input) static Admin
parseDelimitedFrom
(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
(InputStream input) static Admin
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Admin
parseFrom
(ByteBuffer data) static Admin
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser
<Admin> parser()
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 Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
bitField0_
private int bitField0_ -
ACCESS_LOG_FIELD_NUMBER
public static final int ACCESS_LOG_FIELD_NUMBER- See Also:
-
accessLog_
-
ACCESS_LOG_PATH_FIELD_NUMBER
public static final int ACCESS_LOG_PATH_FIELD_NUMBER- See Also:
-
accessLogPath_
-
PROFILE_PATH_FIELD_NUMBER
public static final int PROFILE_PATH_FIELD_NUMBER- See Also:
-
profilePath_
-
ADDRESS_FIELD_NUMBER
public static final int ADDRESS_FIELD_NUMBER- See Also:
-
address_
-
SOCKET_OPTIONS_FIELD_NUMBER
public static final int SOCKET_OPTIONS_FIELD_NUMBER- See Also:
-
socketOptions_
-
IGNORE_GLOBAL_CONN_LIMIT_FIELD_NUMBER
public static final int IGNORE_GLOBAL_CONN_LIMIT_FIELD_NUMBER- See Also:
-
ignoreGlobalConnLimit_
private boolean ignoreGlobalConnLimit_ -
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
Admin
private Admin(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Admin
private Admin()
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage
-
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 interfaceAdminOrBuilder
-
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 interfaceAdminOrBuilder
-
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 interfaceAdminOrBuilder
-
getAccessLog
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 interfaceAdminOrBuilder
-
getAccessLogOrBuilder
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 interfaceAdminOrBuilder
-
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"];
- Specified by:
getAccessLogPath
in interfaceAdminOrBuilder
- 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"];
- Specified by:
getAccessLogPathBytes
in interfaceAdminOrBuilder
- Returns:
- The bytes for accessLogPath.
-
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 interfaceAdminOrBuilder
- 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 interfaceAdminOrBuilder
- 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 interfaceAdminOrBuilder
- Returns:
- Whether the address field is set.
-
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 interfaceAdminOrBuilder
- Returns:
- The address.
-
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 interfaceAdminOrBuilder
-
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 interfaceAdminOrBuilder
-
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 interfaceAdminOrBuilder
-
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 interfaceAdminOrBuilder
-
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;
- Specified by:
getSocketOptions
in interfaceAdminOrBuilder
-
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;
- Specified by:
getSocketOptionsOrBuilder
in interfaceAdminOrBuilder
-
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 interfaceAdminOrBuilder
- Returns:
- The ignoreGlobalConnLimit.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Admin parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Admin parseFrom(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
- Throws:
IOException
-
parseFrom
public static Admin parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static Admin parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Admin parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
- Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-