Module io.helidon.webclient.grpc

Package io.helidon.webclient.grpc

Class GrpcClientMethodDescriptor

java.lang.Object

io.helidon.webclient.grpc.GrpcClientMethodDescriptor

public final class GrpcClientMethodDescriptor
extends Object

Encapsulates all metadata necessary to define a gRPC method. In addition to wrapping a MethodDescriptor, this class also holds the request and response types of the gRPC method. A GrpcServiceDescriptor can contain zero or more MethodDescriptor.

An instance of ClientMethodDescriptor can be created either from an existing MethodDescriptor or from one of the factory methods bidirectional(String, String), clientStreaming(String, String), serverStreaming(String, String) or unary(String, String).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GrpcClientMethodDescriptor.Builder	MethodDescriptor builder implementation.
static interface	GrpcClientMethodDescriptor.Rules	ClientMethod configuration API.

Method Summary

Modifier and Type	Method	Description
static GrpcClientMethodDescriptor.Builder	bidirectional(String serviceName, String name)	Creates a new bidirectional GrpcClientMethodDescriptor.Builder with the specified name.
static GrpcClientMethodDescriptor.Builder	builder(String serviceName, String name, io.grpc.MethodDescriptor.Builder<?,?> descriptor)	Creates a new GrpcClientMethodDescriptor.Builder with the specified name and MethodDescriptor.
static GrpcClientMethodDescriptor.Builder	builder(String serviceName, String name, io.grpc.MethodDescriptor.MethodType methodType)	Creates a new GrpcClientMethodDescriptor.Builder with the specified name.
io.grpc.CallCredentials	callCredentials()	Return the CallCredentials set on this service.
static GrpcClientMethodDescriptor.Builder	clientStreaming(String serviceName, String name)	Creates a new client Streaming GrpcClientMethodDescriptor.Builder with the specified name.
static GrpcClientMethodDescriptor	create(String serviceName, String name, io.grpc.MethodDescriptor.Builder<?,?> descriptor)	Creates a new GrpcClientMethodDescriptor.Builder with the specified name and MethodDescriptor.
<ReqT, RespT> io.grpc.MethodDescriptor<ReqT,RespT>	descriptor()	Returns the MethodDescriptor of this method.
MethodHandler<?,?>	methodHandler()	Obtain the MethodHandler to use to make client calls.
String	name()	Returns the simple name of the method.
static GrpcClientMethodDescriptor.Builder	serverStreaming(String serviceName, String name)	Creates a new server streaming GrpcClientMethodDescriptor.Builder with the specified name.
io.grpc.MethodDescriptor.MethodType	type()	Returns the MethodDescriptor.MethodType of this method.
static GrpcClientMethodDescriptor.Builder	unary(String serviceName, String name)	Creates a new unary GrpcClientMethodDescriptor.Builder with the specified name.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static GrpcClientMethodDescriptor.Builder builder(String serviceName,
 String name,
 io.grpc.MethodDescriptor.Builder<?,?> descriptor)

Creates a new GrpcClientMethodDescriptor.Builder with the specified name and MethodDescriptor.

Parameters:

serviceName - the name of the owning gRPC service

name - the simple method name

descriptor - the underlying gRPC MethodDescriptor.Builder

Returns:

A new instance of a GrpcClientMethodDescriptor.Builder

create

public static GrpcClientMethodDescriptor create(String serviceName,
 String name,
 io.grpc.MethodDescriptor.Builder<?,?> descriptor)

Creates a new GrpcClientMethodDescriptor.Builder with the specified name and MethodDescriptor.

Parameters:

serviceName - the name of the owning gRPC service

name - the simple method name

descriptor - the underlying gRPC MethodDescriptor.Builder

Returns:

a new instance of a GrpcClientMethodDescriptor.Builder

unary

public static GrpcClientMethodDescriptor.Builder unary(String serviceName,
 String name)

Creates a new unary GrpcClientMethodDescriptor.Builder with the specified name.

Parameters:

serviceName - the name of the owning gRPC service

name - the method name

Returns:

a new instance of a GrpcClientMethodDescriptor.Builder

clientStreaming

public static GrpcClientMethodDescriptor.Builder clientStreaming(String serviceName,
 String name)

Creates a new client Streaming GrpcClientMethodDescriptor.Builder with the specified name.

Parameters:

serviceName - the name of the owning gRPC service

name - the method name

Returns:

a new instance of a GrpcClientMethodDescriptor.Builder

serverStreaming

public static GrpcClientMethodDescriptor.Builder serverStreaming(String serviceName,
 String name)

Creates a new server streaming GrpcClientMethodDescriptor.Builder with the specified name.

Parameters:

serviceName - the name of the owning gRPC service

name - the method name

Returns:

a new instance of a GrpcClientMethodDescriptor.Builder

bidirectional

public static GrpcClientMethodDescriptor.Builder bidirectional(String serviceName,
 String name)

Creates a new bidirectional GrpcClientMethodDescriptor.Builder with the specified name.

Parameters:

serviceName - the name of the owning gRPC service

name - the method name

Returns:

a new instance of a GrpcClientMethodDescriptor.Builder

callCredentials

public io.grpc.CallCredentials callCredentials()

Return the CallCredentials set on this service.

Returns:

the CallCredentials set on this service

builder

public static GrpcClientMethodDescriptor.Builder builder(String serviceName,
 String name,
 io.grpc.MethodDescriptor.MethodType methodType)

Creates a new GrpcClientMethodDescriptor.Builder with the specified name.

Parameters:

serviceName - the name of the owning gRPC service

name - the method name

methodType - the gRPC method type

Returns:

a new instance of a GrpcClientMethodDescriptor.Builder

name

public String name()

Returns the simple name of the method.

Returns:

The simple name of the method.

descriptor

public <ReqT,
RespT>
io.grpc.MethodDescriptor<ReqT,RespT> descriptor()

Returns the MethodDescriptor of this method.

Type Parameters:

ReqT - the request type

RespT - the response type

Returns:

The MethodDescriptor of this method.

type

public io.grpc.MethodDescriptor.MethodType type()

Returns the MethodDescriptor.MethodType of this method.

Returns:

the method type

methodHandler

public MethodHandler<?,?> methodHandler()

Obtain the MethodHandler to use to make client calls.

Returns:

the MethodHandler to use to make client calls