Package io.grpc.stub.annotations
Annotation Type RpcMethod
-
@Retention(CLASS) @Target(METHOD) public @interface RpcMethod
RpcMethod
contains a limited subset of information about the RPC to assist Java Annotation Processors.This annotation is used by the gRPC stub compiler to annotate
MethodDescriptor
getters. Users should not annotate their own classes with this annotation. Not all stubs may have this annotation, so consumers should not assume that it is present.- Since:
- 1.14.0
-
-
Required Element Summary
Required Elements Modifier and Type Required Element Description String
fullMethodName
The fully qualified method name.MethodDescriptor.MethodType
methodType
The call type of the method.Class<?>
requestType
The request type of the method.Class<?>
responseType
The response type of the method.
-
-
-
Element Detail
-
fullMethodName
String fullMethodName
The fully qualified method name. This should match the name as returned byMethodDescriptor.generateFullMethodName(String, String)
.
-
-
-
requestType
Class<?> requestType
The request type of the method. The request type class should be assignable from (i.e.Class.isAssignableFrom(Class)
the request typeReqT
of theMethodDescriptor
. Additionally, if the requestMethodDescriptor.Marshaller
is aMethodDescriptor.ReflectableMarshaller
, the request type should be assignable fromMethodDescriptor.ReflectableMarshaller#getMessageClass()
.
-
-
-
responseType
Class<?> responseType
The response type of the method. The response type class should be assignable from (i.e.Class.isAssignableFrom(Class)
the response typeRespT
of theMethodDescriptor
. Additionally, if the responseMethodDescriptor.Marshaller
is aMethodDescriptor.ReflectableMarshaller
, the response type should be assignable fromMethodDescriptor.ReflectableMarshaller#getMessageClass()
.
-
-
-
methodType
MethodDescriptor.MethodType methodType
The call type of the method.
-
-