Package io.grpc.stub.annotations
Annotation Type RpcMethod
-
@Retention(CLASS) @Target(METHOD) public @interface RpcMethodRpcMethodcontains a limited subset of information about the RPC to assist Java Annotation Processors.This annotation is used by the gRPC stub compiler to annotate
MethodDescriptorgetters. 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 java.lang.StringfullMethodNameThe fully qualified method name.MethodDescriptor.MethodTypemethodTypeThe call type of the method.java.lang.Class<?>requestTypeThe request type of the method.java.lang.Class<?>responseTypeThe response type of the method.
-
-
-
Element Detail
-
fullMethodName
java.lang.String fullMethodName
The fully qualified method name. This should match the name as returned byMethodDescriptor.generateFullMethodName(String, String).
-
-
-
requestType
java.lang.Class<?> requestType
The request type of the method. The request type class should be assignable from (i.e.Class.isAssignableFrom(Class)the request typeReqTof theMethodDescriptor. Additionally, if the requestMethodDescriptor.Marshalleris aMethodDescriptor.ReflectableMarshaller, the request type should be assignable fromMethodDescriptor.ReflectableMarshaller#getMessageClass().
-
-
-
responseType
java.lang.Class<?> responseType
The response type of the method. The response type class should be assignable from (i.e.Class.isAssignableFrom(Class)the response typeRespTof theMethodDescriptor. Additionally, if the responseMethodDescriptor.Marshalleris aMethodDescriptor.ReflectableMarshaller, the response type should be assignable fromMethodDescriptor.ReflectableMarshaller#getMessageClass().
-
-
-
methodType
MethodDescriptor.MethodType methodType
The call type of the method.
-
-