Module io.helidon.grpc.client

Package io.helidon.grpc.client

Class GrpcChannelDescriptor

java.lang.Object

io.helidon.grpc.client.GrpcChannelDescriptor

public class GrpcChannelDescriptor
extends Object

GrpcChannelDescriptor contains the configuration for a Channel.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GrpcChannelDescriptor.Builder	Builder builds a GrpcChannelDescriptor.

Method Summary

Modifier and Type	Method	Description
static GrpcChannelDescriptor.Builder	builder()	Create and return a new GrpcChannelDescriptor.Builder.
String	host()	Get the host name to connect.
boolean	isInProcessChannel()	Checks if this is a descriptor for building a in process Channel.
Optional<String>	loadBalancerPolicy()	Get the default load balancer policy to use.
Optional<io.grpc.NameResolver.Factory>	nameResolverFactory()	Deprecated.
int	port()	Get the port that will be used to connect to the server.
Optional<String>	target()	Get the optional target string to use to resolve channel addresses.
Optional<GrpcTlsDescriptor>	tlsDescriptor()	Get the GrpcTlsDescriptor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static GrpcChannelDescriptor.Builder builder()

Create and return a new GrpcChannelDescriptor.Builder.

Returns:

a new GrpcChannelDescriptor.Builder

isInProcessChannel

public boolean isInProcessChannel()

Checks if this is a descriptor for building a in process Channel.

Returns:

true if this is a descriptor for building a in process Channel

host

public String host()

Get the host name to connect.

Returns:

the host name to connect

port

public int port()

Get the port that will be used to connect to the server.

Returns:

the port that will be used to connect to the server

target

public Optional<String> target()

Get the optional target string to use to resolve channel addresses.

Returns:

the optional target string to use to resolve channel addresses

loadBalancerPolicy

public Optional<String> loadBalancerPolicy()

Get the default load balancer policy to use.

Returns:

the optional default load balancer policy to use

nameResolverFactory

@Deprecated
public Optional<io.grpc.NameResolver.Factory> nameResolverFactory()

Deprecated.

Get the NameResolver.Factory to use.

This method is deprecated due to the deprecation of the ManagedChannelBuilder.nameResolverFactory(io.grpc.NameResolver.Factory) method in the gRPC Java API.

Returns:

the optional NameResolver.Factory to use

tlsDescriptor

public Optional<GrpcTlsDescriptor> tlsDescriptor()

Get the GrpcTlsDescriptor. If this method returns null or if tlsDescriptor.isEnabled() is false, then no TLS will be used (and none of the other configuration values from tlsDescriptor will be used).

If the GrpcTlsDescriptor has been set but the value of GrpcTlsDescriptor.isEnabled() returns false then an empty Optional will be returned.

Returns:

the optional GrpcTlsDescriptor