Package io.envoyproxy.envoy.extensions.filters.network.generic_proxy.v3

Interface VirtualHostOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
VirtualHost, VirtualHost.Builder
public interface VirtualHostOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getHosts(int index)
    A list of hosts that will be matched to this virtual host.
    com.google.protobuf.ByteString
    getHostsBytes(int index)
    A list of hosts that will be matched to this virtual host.
    int
    getHostsCount()
    A list of hosts that will be matched to this virtual host.
    List<String>
    getHostsList()
    A list of hosts that will be matched to this virtual host.
    String
    getName()
    The name of the virtual host.
    com.google.protobuf.ByteString
    getNameBytes()
    The name of the virtual host.
    Matcher
    getRoutes()
    The match tree to use when resolving route actions for incoming requests.
    MatcherOrBuilder
    getRoutesOrBuilder()
    The match tree to use when resolving route actions for incoming requests.
    boolean
    hasRoutes()
    The match tree to use when resolving route actions for incoming requests.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getName

      String getName()
       The name of the virtual host.
      string name = 1 [(.validate.rules) = { ... }
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       The name of the virtual host.
      string name = 1 [(.validate.rules) = { ... }
      Returns:
      The bytes for name.

    • getHostsList

      List<String> getHostsList()
       A list of hosts that will be matched to this virtual host. Wildcard hosts are supported in
 the suffix or prefix form.

 Host search order:
  1. Exact names: ``www.foo.com``.
  2. Suffix wildcards: ``*.foo.com`` or ``*-bar.foo.com``.
  3. Prefix wildcards: ``foo.*`` or ``foo-*``.
  4. Special wildcard ``*`` matching any host and will be the default virtual host.

 .. note::

   The wildcard will not match the empty string.
   e.g. ``*-bar.foo.com`` will match ``baz-bar.foo.com`` but not ``-bar.foo.com``.
   The longest wildcards match first.
   Only a single virtual host in the entire route configuration can match on ``*``. A domain
   must be unique across all virtual hosts or the config will fail to load.
      repeated string hosts = 2 [(.validate.rules) = { ... }
      Returns:
      A list containing the hosts.

    • getHostsCount

      int getHostsCount()
       A list of hosts that will be matched to this virtual host. Wildcard hosts are supported in
 the suffix or prefix form.

 Host search order:
  1. Exact names: ``www.foo.com``.
  2. Suffix wildcards: ``*.foo.com`` or ``*-bar.foo.com``.
  3. Prefix wildcards: ``foo.*`` or ``foo-*``.
  4. Special wildcard ``*`` matching any host and will be the default virtual host.

 .. note::

   The wildcard will not match the empty string.
   e.g. ``*-bar.foo.com`` will match ``baz-bar.foo.com`` but not ``-bar.foo.com``.
   The longest wildcards match first.
   Only a single virtual host in the entire route configuration can match on ``*``. A domain
   must be unique across all virtual hosts or the config will fail to load.
      repeated string hosts = 2 [(.validate.rules) = { ... }
      Returns:
      The count of hosts.

    • getHosts

      String getHosts(int index)
       A list of hosts that will be matched to this virtual host. Wildcard hosts are supported in
 the suffix or prefix form.

 Host search order:
  1. Exact names: ``www.foo.com``.
  2. Suffix wildcards: ``*.foo.com`` or ``*-bar.foo.com``.
  3. Prefix wildcards: ``foo.*`` or ``foo-*``.
  4. Special wildcard ``*`` matching any host and will be the default virtual host.

 .. note::

   The wildcard will not match the empty string.
   e.g. ``*-bar.foo.com`` will match ``baz-bar.foo.com`` but not ``-bar.foo.com``.
   The longest wildcards match first.
   Only a single virtual host in the entire route configuration can match on ``*``. A domain
   must be unique across all virtual hosts or the config will fail to load.
      repeated string hosts = 2 [(.validate.rules) = { ... }
      Parameters:
      index - The index of the element to return.
      Returns:
      The hosts at the given index.

    • getHostsBytes

      com.google.protobuf.ByteString getHostsBytes(int index)
       A list of hosts that will be matched to this virtual host. Wildcard hosts are supported in
 the suffix or prefix form.

 Host search order:
  1. Exact names: ``www.foo.com``.
  2. Suffix wildcards: ``*.foo.com`` or ``*-bar.foo.com``.
  3. Prefix wildcards: ``foo.*`` or ``foo-*``.
  4. Special wildcard ``*`` matching any host and will be the default virtual host.

 .. note::

   The wildcard will not match the empty string.
   e.g. ``*-bar.foo.com`` will match ``baz-bar.foo.com`` but not ``-bar.foo.com``.
   The longest wildcards match first.
   Only a single virtual host in the entire route configuration can match on ``*``. A domain
   must be unique across all virtual hosts or the config will fail to load.
      repeated string hosts = 2 [(.validate.rules) = { ... }
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the hosts at the given index.

    • hasRoutes

      boolean hasRoutes()
       The match tree to use when resolving route actions for incoming requests.
      .xds.type.matcher.v3.Matcher routes = 3 [(.validate.rules) = { ... }
      Returns:
      Whether the routes field is set.

    • getRoutes

      Matcher getRoutes()
       The match tree to use when resolving route actions for incoming requests.
      .xds.type.matcher.v3.Matcher routes = 3 [(.validate.rules) = { ... }
      Returns:
      The routes.

    • getRoutesOrBuilder

      MatcherOrBuilder getRoutesOrBuilder()
       The match tree to use when resolving route actions for incoming requests.
      .xds.type.matcher.v3.Matcher routes = 3 [(.validate.rules) = { ... }