io.envoyproxy.envoy.config.core.v3

Interface SocketAddressOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

SocketAddress, SocketAddress.Builder

public interface SocketAddressOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getAddress() The address for this socket.
com.google.protobuf.ByteString	getAddressBytes() The address for this socket.
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_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_api_field_config.core.v3.SocketAddress.resolver_name>` is specified below and the named resolver is capable of named port resolution.
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.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getProtocolValue

int getProtocolValue()

.envoy.config.core.v3.SocketAddress.Protocol protocol = 1 [(.validate.rules) = { ... }

getProtocol

SocketAddress.Protocol getProtocol()

.envoy.config.core.v3.SocketAddress.Protocol protocol = 1 [(.validate.rules) = { ... }

getAddress

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_config.listener.v3.FilterChainMatch>`.] When used
 within an upstream :ref:`BindConfig <envoy_api_msg_config.core.v3.BindConfig>`, the address
 controls the source address of outbound connections. For :ref:`clusters
 <envoy_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_api_field_config.core.v3.SocketAddress.resolver_name>`.
 

string address = 2 [(.validate.rules) = { ... }

getAddressBytes

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_config.listener.v3.FilterChainMatch>`.] When used
 within an upstream :ref:`BindConfig <envoy_api_msg_config.core.v3.BindConfig>`, the address
 controls the source address of outbound connections. For :ref:`clusters
 <envoy_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_api_field_config.core.v3.SocketAddress.resolver_name>`.
 

string address = 2 [(.validate.rules) = { ... }

getPortValue

int getPortValue()

uint32 port_value = 3 [(.validate.rules) = { ... }

getNamedPort

String getNamedPort()

 This is only valid if :ref:`resolver_name
 <envoy_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;

getNamedPortBytes

com.google.protobuf.ByteString getNamedPortBytes()

 This is only valid if :ref:`resolver_name
 <envoy_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;

getResolverName

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;

getResolverNameBytes

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;

getIpv4Compat

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;

getPortSpecifierCase

SocketAddress.PortSpecifierCase getPortSpecifierCase()