Package io.envoyproxy.envoy.api.v2.core

Class 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.GeneratedMessageV3
implements SocketAddressOrBuilder
     [#next-free-field: 7]
    Protobuf type envoy.api.v2.core.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 enum envoy.api.v2.core.SocketAddress.Protocol

      • 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

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • 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

      • getProtocolValue

        public int getProtocolValue()
        .envoy.api.v2.core.SocketAddress.Protocol protocol = 1 [(.validate.rules) = { ... }
        Specified by:
        getProtocolValue in interface SocketAddressOrBuilder
        Returns:
        The enum numeric value on the wire for protocol.

      • getAddress

        public 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_api_msg_listener.FilterChainMatch>`.] When used
 within an upstream :ref:`BindConfig <envoy_api_msg_core.BindConfig>`, the address
 controls the source address of outbound connections. For :ref:`clusters
 <envoy_api_msg_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_api_field_core.SocketAddress.resolver_name>`.
        string address = 2 [(.validate.rules) = { ... }
        Specified by:
        getAddress in interface SocketAddressOrBuilder
        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_api_msg_listener.FilterChainMatch>`.] When used
 within an upstream :ref:`BindConfig <envoy_api_msg_core.BindConfig>`, the address
 controls the source address of outbound connections. For :ref:`clusters
 <envoy_api_msg_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_api_field_core.SocketAddress.resolver_name>`.
        string address = 2 [(.validate.rules) = { ... }
        Specified by:
        getAddressBytes in interface SocketAddressOrBuilder
        Returns:
        The bytes for address.

      • hasPortValue

        public boolean hasPortValue()
        uint32 port_value = 3 [(.validate.rules) = { ... }
        Specified by:
        hasPortValue in interface SocketAddressOrBuilder
        Returns:
        Whether the portValue field is set.

      • getPortValue

        public int getPortValue()
        uint32 port_value = 3 [(.validate.rules) = { ... }
        Specified by:
        getPortValue in interface SocketAddressOrBuilder
        Returns:
        The portValue.

      • hasNamedPort

        public boolean hasNamedPort()
         This is only valid if :ref:`resolver_name
 <envoy_api_field_core.SocketAddress.resolver_name>` is specified below and the
 named resolver is capable of named port resolution.
        string named_port = 4;
        Specified by:
        hasNamedPort in interface SocketAddressOrBuilder
        Returns:
        Whether the namedPort field is set.

      • getNamedPort

        public String getNamedPort()
         This is only valid if :ref:`resolver_name
 <envoy_api_field_core.SocketAddress.resolver_name>` is specified below and the
 named resolver is capable of named port resolution.
        string named_port = 4;
        Specified by:
        getNamedPort in interface SocketAddressOrBuilder
        Returns:
        The namedPort.

      • getNamedPortBytes

        public com.google.protobuf.ByteString getNamedPortBytes()
         This is only valid if :ref:`resolver_name
 <envoy_api_field_core.SocketAddress.resolver_name>` is specified below and the
 named resolver is capable of named port resolution.
        string named_port = 4;
        Specified by:
        getNamedPortBytes in interface SocketAddressOrBuilder
        Returns:
        The bytes for namedPort.

      • getResolverName

        public 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 interface SocketAddressOrBuilder
        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 interface SocketAddressOrBuilder
        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 interface SocketAddressOrBuilder
        Returns:
        The ipv4Compat.

      • 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 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

        public static SocketAddress parseFrom​(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException
        Throws:
        IOException

      • newBuilderForType

        public SocketAddress.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public SocketAddress.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected SocketAddress.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • 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 interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public SocketAddress getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder