Package io.envoyproxy.envoy.config.core.v3

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
@Generated 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 Classes
    Modifier and Type
    Class
    Description
    static final class 
    SocketAddress.Builder
    [#next-free-field: 7]
    static enum 
    SocketAddress.PortSpecifierCase
     
    static enum 
    SocketAddress.Protocol
    Protobuf enum envoy.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

    Fields
    Modifier and Type
    Field
    Description
    private Object
    address_
     
    static final int
    ADDRESS_FIELD_NUMBER
     
    private static final SocketAddress
    DEFAULT_INSTANCE
     
    static final int
    IPV4_COMPAT_FIELD_NUMBER
     
    private boolean
    ipv4Compat_
     
    private byte
    memoizedIsInitialized
     
    static final int
    NAMED_PORT_FIELD_NUMBER
     
    private static final com.google.protobuf.Parser<SocketAddress>
    PARSER
     
    static final int
    PORT_VALUE_FIELD_NUMBER
     
    private Object
    portSpecifier_
     
    private int
    portSpecifierCase_
     
    private int
    protocol_
     
    static final int
    PROTOCOL_FIELD_NUMBER
     
    static final int
    RESOLVER_NAME_FIELD_NUMBER
     
    private Object
    resolverName_
     
    private static final long
    serialVersionUID
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    SocketAddress()
     
    private
    SocketAddress(com.google.protobuf.GeneratedMessage.Builder<?> builder)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    String
    getAddress()
    The address for this socket.
    com.google.protobuf.ByteString
    getAddressBytes()
    The address for this socket.
    static SocketAddress
    getDefaultInstance()
     
    SocketAddress
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    boolean
    getIpv4Compat()
    When binding to an IPv6 address above, this enables `IPv4 compatibility <https://tools.ietf.org/html/rfc3493#page-11>`_.
    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) = { ...
    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()
     
    final 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(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()
     
    SocketAddress.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • portSpecifierCase_

      private int portSpecifierCase_

    • portSpecifier_

      private Object 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_

      private volatile Object 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_

      private volatile Object 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

      private static final SocketAddress DEFAULT_INSTANCE

    • PARSER

      private static final com.google.protobuf.Parser<SocketAddress> 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()

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getPortSpecifierCase

      public SocketAddress.PortSpecifierCase getPortSpecifierCase()
      Specified by:
      getPortSpecifierCase in interface SocketAddressOrBuilder

    • getProtocolValue

      public int getProtocolValue()
      .envoy.config.core.v3.SocketAddress.Protocol protocol = 1 [(.validate.rules) = { ... }
      Specified by:
      getProtocolValue in interface SocketAddressOrBuilder
      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 interface SocketAddressOrBuilder
      Returns:
      The 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_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 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_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 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_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 interface SocketAddressOrBuilder
      Returns:
      Whether the namedPort field is set.

    • getNamedPort

      public 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 interface SocketAddressOrBuilder
      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 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.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static SocketAddress parseDelimitedFrom(InputStream input) throws IOException
      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

      public SocketAddress.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.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 interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected SocketAddress.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.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 interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

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