Class SocketAddress
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.core.v3.SocketAddress
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,SocketAddressOrBuilder
,Serializable
public final class SocketAddress
extends com.google.protobuf.GeneratedMessage
implements SocketAddressOrBuilder
[#next-free-field: 7]Protobuf type
envoy.config.core.v3.SocketAddress
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
[#next-free-field: 7]static enum
static enum
Protobuf enumenvoy.config.core.v3.SocketAddress.Protocol
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 TypeFieldDescriptionprivate Object
static final int
private static final SocketAddress
static final int
private boolean
private byte
static final int
private static final com.google.protobuf.Parser
<SocketAddress> static final int
private Object
private int
private int
static final int
static final int
private Object
private static final long
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
ConstructorsModifierConstructorDescriptionprivate
private
SocketAddress
(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
The address for this socket.com.google.protobuf.ByteString
The address for this socket.static SocketAddress
static final com.google.protobuf.Descriptors.Descriptor
boolean
When binding to an IPv6 address above, this enables `IPv4 compatibility <https://tools.ietf.org/html/rfc3493#page-11>`_.This is only valid if :ref:`resolver_name <envoy_v3_api_field_config.core.v3.SocketAddress.resolver_name>` is specified below and the named resolver is capable of named port resolution.com.google.protobuf.ByteString
This is only valid if :ref:`resolver_name <envoy_v3_api_field_config.core.v3.SocketAddress.resolver_name>` is specified below and the named resolver is capable of named port resolution.com.google.protobuf.Parser
<SocketAddress> int
uint32 port_value = 3 [(.validate.rules) = { ...
.envoy.config.core.v3.SocketAddress.Protocol protocol = 1 [(.validate.rules) = { ...
int
.envoy.config.core.v3.SocketAddress.Protocol protocol = 1 [(.validate.rules) = { ...
The name of the custom resolver.com.google.protobuf.ByteString
The name of the custom resolver.int
int
hashCode()
boolean
This is only valid if :ref:`resolver_name <envoy_v3_api_field_config.core.v3.SocketAddress.resolver_name>` is specified below and the named resolver is capable of named port resolution.boolean
uint32 port_value = 3 [(.validate.rules) = { ...
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
static SocketAddress.Builder
static SocketAddress.Builder
newBuilder
(SocketAddress prototype) protected SocketAddress.Builder
newBuilderForType
(com.google.protobuf.AbstractMessage.BuilderParent parent) static SocketAddress
parseDelimitedFrom
(InputStream input) static SocketAddress
parseDelimitedFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static SocketAddress
parseFrom
(byte[] data) static SocketAddress
parseFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static SocketAddress
parseFrom
(com.google.protobuf.ByteString data) static SocketAddress
parseFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static SocketAddress
parseFrom
(com.google.protobuf.CodedInputStream input) static SocketAddress
parseFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static SocketAddress
parseFrom
(InputStream input) static SocketAddress
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static SocketAddress
parseFrom
(ByteBuffer data) static SocketAddress
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser
<SocketAddress> 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:
-
portSpecifierCase_
private int portSpecifierCase_ -
portSpecifier_
-
PROTOCOL_FIELD_NUMBER
public static final int PROTOCOL_FIELD_NUMBER- See Also:
-
protocol_
private int protocol_ -
ADDRESS_FIELD_NUMBER
public static final int ADDRESS_FIELD_NUMBER- See Also:
-
address_
-
PORT_VALUE_FIELD_NUMBER
public static final int PORT_VALUE_FIELD_NUMBER- See Also:
-
NAMED_PORT_FIELD_NUMBER
public static final int NAMED_PORT_FIELD_NUMBER- See Also:
-
RESOLVER_NAME_FIELD_NUMBER
public static final int RESOLVER_NAME_FIELD_NUMBER- See Also:
-
resolverName_
-
IPV4_COMPAT_FIELD_NUMBER
public static final int IPV4_COMPAT_FIELD_NUMBER- See Also:
-
ipv4Compat_
private boolean ipv4Compat_ -
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
SocketAddress
private SocketAddress(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
SocketAddress
private SocketAddress()
-
-
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
-
getPortSpecifierCase
- Specified by:
getPortSpecifierCase
in interfaceSocketAddressOrBuilder
-
getProtocolValue
public int getProtocolValue().envoy.config.core.v3.SocketAddress.Protocol protocol = 1 [(.validate.rules) = { ... }
- Specified by:
getProtocolValue
in interfaceSocketAddressOrBuilder
- Returns:
- The enum numeric value on the wire for protocol.
-
getProtocol
.envoy.config.core.v3.SocketAddress.Protocol protocol = 1 [(.validate.rules) = { ... }
- Specified by:
getProtocol
in interfaceSocketAddressOrBuilder
- Returns:
- The protocol.
-
getAddress
The address for this socket. :ref:`Listeners <config_listeners>` will bind to the address. An empty address is not allowed. Specify ``0.0.0.0`` or ``::`` to bind to any address. [#comment:TODO(zuercher) reinstate when implemented: It is possible to distinguish a Listener address via the prefix/suffix matching in :ref:`FilterChainMatch <envoy_v3_api_msg_config.listener.v3.FilterChainMatch>`.] When used within an upstream :ref:`BindConfig <envoy_v3_api_msg_config.core.v3.BindConfig>`, the address controls the source address of outbound connections. For :ref:`clusters <envoy_v3_api_msg_config.cluster.v3.Cluster>`, the cluster type determines whether the address must be an IP (``STATIC`` or ``EDS`` clusters) or a hostname resolved by DNS (``STRICT_DNS`` or ``LOGICAL_DNS`` clusters). Address resolution can be customized via :ref:`resolver_name <envoy_v3_api_field_config.core.v3.SocketAddress.resolver_name>`.
string address = 2 [(.validate.rules) = { ... }
- Specified by:
getAddress
in interfaceSocketAddressOrBuilder
- Returns:
- The address.
-
getAddressBytes
public com.google.protobuf.ByteString getAddressBytes()The address for this socket. :ref:`Listeners <config_listeners>` will bind to the address. An empty address is not allowed. Specify ``0.0.0.0`` or ``::`` to bind to any address. [#comment:TODO(zuercher) reinstate when implemented: It is possible to distinguish a Listener address via the prefix/suffix matching in :ref:`FilterChainMatch <envoy_v3_api_msg_config.listener.v3.FilterChainMatch>`.] When used within an upstream :ref:`BindConfig <envoy_v3_api_msg_config.core.v3.BindConfig>`, the address controls the source address of outbound connections. For :ref:`clusters <envoy_v3_api_msg_config.cluster.v3.Cluster>`, the cluster type determines whether the address must be an IP (``STATIC`` or ``EDS`` clusters) or a hostname resolved by DNS (``STRICT_DNS`` or ``LOGICAL_DNS`` clusters). Address resolution can be customized via :ref:`resolver_name <envoy_v3_api_field_config.core.v3.SocketAddress.resolver_name>`.
string address = 2 [(.validate.rules) = { ... }
- Specified by:
getAddressBytes
in interfaceSocketAddressOrBuilder
- Returns:
- The bytes for address.
-
hasPortValue
public boolean hasPortValue()uint32 port_value = 3 [(.validate.rules) = { ... }
- Specified by:
hasPortValue
in interfaceSocketAddressOrBuilder
- Returns:
- Whether the portValue field is set.
-
getPortValue
public int getPortValue()uint32 port_value = 3 [(.validate.rules) = { ... }
- Specified by:
getPortValue
in interfaceSocketAddressOrBuilder
- Returns:
- The portValue.
-
hasNamedPort
public boolean hasNamedPort()This is only valid if :ref:`resolver_name <envoy_v3_api_field_config.core.v3.SocketAddress.resolver_name>` is specified below and the named resolver is capable of named port resolution.
string named_port = 4;
- Specified by:
hasNamedPort
in interfaceSocketAddressOrBuilder
- Returns:
- Whether the namedPort field is set.
-
getNamedPort
This is only valid if :ref:`resolver_name <envoy_v3_api_field_config.core.v3.SocketAddress.resolver_name>` is specified below and the named resolver is capable of named port resolution.
string named_port = 4;
- Specified by:
getNamedPort
in interfaceSocketAddressOrBuilder
- Returns:
- The namedPort.
-
getNamedPortBytes
public com.google.protobuf.ByteString getNamedPortBytes()This is only valid if :ref:`resolver_name <envoy_v3_api_field_config.core.v3.SocketAddress.resolver_name>` is specified below and the named resolver is capable of named port resolution.
string named_port = 4;
- Specified by:
getNamedPortBytes
in interfaceSocketAddressOrBuilder
- Returns:
- The bytes for namedPort.
-
getResolverName
The name of the custom resolver. This must have been registered with Envoy. If this is empty, a context dependent default applies. If the address is a concrete IP address, no resolution will occur. If address is a hostname this should be set for resolution other than DNS. Specifying a custom resolver with ``STRICT_DNS`` or ``LOGICAL_DNS`` will generate an error at runtime.
string resolver_name = 5;
- Specified by:
getResolverName
in interfaceSocketAddressOrBuilder
- Returns:
- The resolverName.
-
getResolverNameBytes
public com.google.protobuf.ByteString getResolverNameBytes()The name of the custom resolver. This must have been registered with Envoy. If this is empty, a context dependent default applies. If the address is a concrete IP address, no resolution will occur. If address is a hostname this should be set for resolution other than DNS. Specifying a custom resolver with ``STRICT_DNS`` or ``LOGICAL_DNS`` will generate an error at runtime.
string resolver_name = 5;
- Specified by:
getResolverNameBytes
in interfaceSocketAddressOrBuilder
- Returns:
- The bytes for resolverName.
-
getIpv4Compat
public boolean getIpv4Compat()When binding to an IPv6 address above, this enables `IPv4 compatibility <https://tools.ietf.org/html/rfc3493#page-11>`_. Binding to ``::`` will allow both IPv4 and IPv6 connections, with peer IPv4 addresses mapped into IPv6 space as ``::FFFF:<IPv4-address>``.
bool ipv4_compat = 6;
- Specified by:
getIpv4Compat
in interfaceSocketAddressOrBuilder
- Returns:
- The ipv4Compat.
-
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 SocketAddress parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SocketAddress parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SocketAddress parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SocketAddress parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SocketAddress parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SocketAddress parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static SocketAddress parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static SocketAddress parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static SocketAddress parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static SocketAddress 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
protected SocketAddress.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - 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
-