io.envoyproxy.envoy.config.bootstrap.v3

Class Admin

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

public final class Admin
extends com.google.protobuf.GeneratedMessageV3
implements AdminOrBuilder

 Administration interface :ref:`operations documentation
 <operations_admin_interface>`.
 

Protobuf type envoy.config.bootstrap.v3.Admin

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Admin.Builder Administration interface :ref:`operations documentation <operations_admin_interface>`.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACCESS_LOG_PATH_FIELD_NUMBER
static int	ADDRESS_FIELD_NUMBER
static int	PROFILE_PATH_FIELD_NUMBER
static int	SOCKET_OPTIONS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAccessLogPath() The path to write the access log for the administration server.
com.google.protobuf.ByteString	getAccessLogPathBytes() The path to write the access log for the administration server.
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()
com.google.protobuf.Parser<Admin>	getParserForType()
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.
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.
List<? extends SocketOptionOrBuilder>	getSocketOptionsOrBuilderList() Additional socket options that may not be present in Envoy source code or precompiled binaries.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasAddress() The TCP address that the administration server will listen on.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Admin.Builder	newBuilder()
static Admin.Builder	newBuilder(Admin prototype)
Admin.Builder	newBuilderForType()
protected Admin.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
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(ByteBuffer data)
static Admin	parseFrom(ByteBuffer 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 com.google.protobuf.Parser<Admin>	parser()
Admin.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

ACCESS_LOG_PATH_FIELD_NUMBER

public static final int ACCESS_LOG_PATH_FIELD_NUMBER

See Also:

Constant Field Values

PROFILE_PATH_FIELD_NUMBER

public static final int PROFILE_PATH_FIELD_NUMBER

See Also:

Constant Field Values

ADDRESS_FIELD_NUMBER

public static final int ADDRESS_FIELD_NUMBER

See Also:

Constant Field Values

SOCKET_OPTIONS_FIELD_NUMBER

public static final int SOCKET_OPTIONS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

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

getAccessLogPath

public String getAccessLogPath()

 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_api_field_config.bootstrap.v3.Admin.address>` is set.
 

string access_log_path = 1;

Specified by:

getAccessLogPath in interface AdminOrBuilder

getAccessLogPathBytes

public com.google.protobuf.ByteString getAccessLogPathBytes()

 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_api_field_config.bootstrap.v3.Admin.address>` is set.
 

string access_log_path = 1;

Specified by:

getAccessLogPathBytes in interface AdminOrBuilder

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

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

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

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

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

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

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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(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(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

public static Admin parseFrom(InputStream input)
                       throws IOException

Throws:

IOException

parseFrom

public static Admin parseFrom(InputStream input,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static Admin parseDelimitedFrom(InputStream input)
                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static Admin parseDelimitedFrom(InputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

parseFrom

public static Admin parseFrom(com.google.protobuf.CodedInputStream input)
                       throws IOException

Throws:

IOException

parseFrom

public static Admin parseFrom(com.google.protobuf.CodedInputStream input,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws IOException

Throws:

IOException

newBuilderForType

public Admin.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Admin.Builder newBuilder()

newBuilder

public static Admin.Builder newBuilder(Admin prototype)

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.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

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

getDefaultInstanceForType

public Admin getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder