Class Bootstrapper.BootstrapInfo
- java.lang.Object
-
- io.grpc.xds.client.Bootstrapper.BootstrapInfo
-
- Direct Known Subclasses:
AutoValue_Bootstrapper_BootstrapInfo
- Enclosing class:
- Bootstrapper
@Internal public abstract static class Bootstrapper.BootstrapInfo extends java.lang.Object
Data class containing the results of reading bootstrap.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Bootstrapper.BootstrapInfo.Builder
-
Constructor Summary
Constructors Constructor Description BootstrapInfo()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract com.google.common.collect.ImmutableMap<java.lang.String,Bootstrapper.AuthorityInfo>
authorities()
A map of authority name to corresponding configuration.static Bootstrapper.BootstrapInfo.Builder
builder()
abstract com.google.common.collect.ImmutableMap<java.lang.String,Bootstrapper.CertificateProviderInfo>
certProviders()
Returns the cert-providers config map.abstract java.lang.String
clientDefaultListenerResourceNameTemplate()
A template for the name of the Listener resource to subscribe to for a gRPC client channel.abstract EnvoyProtoData.Node
node()
Returns the node identifier to be included in xDS requests.abstract java.lang.String
serverListenerResourceNameTemplate()
A template for the name of the Listener resource to subscribe to for a gRPC server.abstract com.google.common.collect.ImmutableList<Bootstrapper.ServerInfo>
servers()
Returns the list of xDS servers to be connected to.
-
-
-
Method Detail
-
servers
public abstract com.google.common.collect.ImmutableList<Bootstrapper.ServerInfo> servers()
Returns the list of xDS servers to be connected to. Must not be empty.
-
node
public abstract EnvoyProtoData.Node node()
Returns the node identifier to be included in xDS requests.
-
certProviders
@Nullable public abstract com.google.common.collect.ImmutableMap<java.lang.String,Bootstrapper.CertificateProviderInfo> certProviders()
Returns the cert-providers config map.
-
serverListenerResourceNameTemplate
@Nullable public abstract java.lang.String serverListenerResourceNameTemplate()
A template for the name of the Listener resource to subscribe to for a gRPC server.If starts with "xdstp:", will be interpreted as a new-style name, in which case the authority of the URI will be used to select the relevant configuration in the "authorities" map. The token "%s", if present in this string, will be replaced with the IP and port on which the server is listening. If the template starts with "xdstp:", the replaced string will be %-encoded.
There is no default; if unset, xDS-based server creation fails.
-
clientDefaultListenerResourceNameTemplate
public abstract java.lang.String clientDefaultListenerResourceNameTemplate()
A template for the name of the Listener resource to subscribe to for a gRPC client channel. Used only when the channel is created with an "xds:" URI with no authority.If starts with "xdstp:", will be interpreted as a new-style name, in which case the authority of the URI will be used to select the relevant configuration in the "authorities" map.
The token "%s", if present in this string, will be replaced with the service authority (i.e., the path part of the target URI used to create the gRPC channel). If the template starts with "xdstp:", the replaced string will be %-encoded.
Defaults to
"%s"
.
-
authorities
public abstract com.google.common.collect.ImmutableMap<java.lang.String,Bootstrapper.AuthorityInfo> authorities()
A map of authority name to corresponding configuration.This is used in the following cases:
- A gRPC client channel is created using an "xds:" URI that includes an authority.
- A gRPC client channel is created using an "xds:" URI with no authority, but the "client_default_listener_resource_name_template" field above turns it into an "xdstp:" URI.
- A gRPC server is created and the "server_listener_resource_name_template" field is an "xdstp:" URI.
In any of those cases, it is an error if the specified authority is not present in this map.
Defaults to an empty map.
-
builder
public static Bootstrapper.BootstrapInfo.Builder builder()
-
-