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
,java.io.Serializable
public final class SocketAddress extends com.google.protobuf.GeneratedMessage implements SocketAddressOrBuilder
[#next-free-field: 7]
Protobuf typeenvoy.config.core.v3.SocketAddress
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SocketAddress.Builder
[#next-free-field: 7]static class
SocketAddress.PortSpecifierCase
static class
SocketAddress.Protocol
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 extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.Object
address_
static int
ADDRESS_FIELD_NUMBER
private static SocketAddress
DEFAULT_INSTANCE
static int
IPV4_COMPAT_FIELD_NUMBER
private boolean
ipv4Compat_
private byte
memoizedIsInitialized
static int
NAMED_PORT_FIELD_NUMBER
private static com.google.protobuf.Parser<SocketAddress>
PARSER
static int
PORT_VALUE_FIELD_NUMBER
private java.lang.Object
portSpecifier_
private int
portSpecifierCase_
private int
protocol_
static int
PROTOCOL_FIELD_NUMBER
static int
RESOLVER_NAME_FIELD_NUMBER
private java.lang.Object
resolverName_
private static long
serialVersionUID
-
Constructor Summary
Constructors Modifier Constructor Description private
SocketAddress()
private
SocketAddress(com.google.protobuf.GeneratedMessage.Builder<?> builder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
java.lang.String
getAddress()
The address for this socket.com.google.protobuf.ByteString
getAddressBytes()
The address for this socket.static SocketAddress
getDefaultInstance()
SocketAddress
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
boolean
getIpv4Compat()
When binding to an IPv6 address above, this enables `IPv4 compatibility <https://tools.ietf.org/html/rfc3493#page-11>`_.java.lang.String
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.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.com.google.protobuf.Parser<SocketAddress>
getParserForType()
SocketAddress.PortSpecifierCase
getPortSpecifierCase()
int
getPortValue()
uint32 port_value = 3 [(.validate.rules) = { ...
SocketAddress.Protocol
getProtocol()
.envoy.config.core.v3.SocketAddress.Protocol protocol = 1 [(.validate.rules) = { ...
int
getProtocolValue()
.envoy.config.core.v3.SocketAddress.Protocol protocol = 1 [(.validate.rules) = { ...
java.lang.String
getResolverName()
The name of the custom resolver.com.google.protobuf.ByteString
getResolverNameBytes()
The name of the custom resolver.int
getSerializedSize()
int
hashCode()
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.boolean
hasPortValue()
uint32 port_value = 3 [(.validate.rules) = { ...
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
static SocketAddress.Builder
newBuilder()
static SocketAddress.Builder
newBuilder(SocketAddress prototype)
SocketAddress.Builder
newBuilderForType()
protected SocketAddress.Builder
newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static SocketAddress
parseDelimitedFrom(java.io.InputStream input)
static SocketAddress
parseDelimitedFrom(java.io.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(java.io.InputStream input)
static SocketAddress
parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SocketAddress
parseFrom(java.nio.ByteBuffer data)
static SocketAddress
parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SocketAddress>
parser()
SocketAddress.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
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
portSpecifierCase_
private int portSpecifierCase_
-
portSpecifier_
private java.lang.Object portSpecifier_
-
PROTOCOL_FIELD_NUMBER
public static final int PROTOCOL_FIELD_NUMBER
- See Also:
- Constant Field Values
-
protocol_
private int protocol_
-
ADDRESS_FIELD_NUMBER
public static final int ADDRESS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
address_
private volatile java.lang.Object address_
-
PORT_VALUE_FIELD_NUMBER
public static final int PORT_VALUE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
NAMED_PORT_FIELD_NUMBER
public static final int NAMED_PORT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
RESOLVER_NAME_FIELD_NUMBER
public static final int RESOLVER_NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
resolverName_
private volatile java.lang.Object resolverName_
-
IPV4_COMPAT_FIELD_NUMBER
public static final int IPV4_COMPAT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ipv4Compat_
private boolean ipv4Compat_
-
memoizedIsInitialized
private byte memoizedIsInitialized
-
DEFAULT_INSTANCE
private static final SocketAddress DEFAULT_INSTANCE
-
PARSER
private static final com.google.protobuf.Parser<SocketAddress> PARSER
-
-
Method Detail
-
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
public SocketAddress.PortSpecifierCase 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
public SocketAddress.Protocol getProtocol()
.envoy.config.core.v3.SocketAddress.Protocol protocol = 1 [(.validate.rules) = { ... }
- Specified by:
getProtocol
in interfaceSocketAddressOrBuilder
- Returns:
- The protocol.
-
getAddress
public java.lang.String 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
public java.lang.String 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
public java.lang.String 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
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
java.io.IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
public boolean equals(java.lang.Object obj)
- 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(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SocketAddress parseFrom(java.nio.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
public static SocketAddress parseFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static SocketAddress parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static SocketAddress parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static SocketAddress parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static SocketAddress parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static SocketAddress parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
newBuilderForType
public SocketAddress.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static SocketAddress.Builder newBuilder()
-
newBuilder
public static SocketAddress.Builder newBuilder(SocketAddress prototype)
-
toBuilder
public SocketAddress.Builder 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
public static SocketAddress getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<SocketAddress> parser()
-
getParserForType
public com.google.protobuf.Parser<SocketAddress> 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
public SocketAddress getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-