package grpc.reflection.v1alpha

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc ServerReflectionInfo (stream ServerReflectionRequest, stream ServerReflectionResponse)

  reflection.proto:33

  The reflection service is structured as a bidirectional stream, ensuring all related requests go to a single server.

  message ServerReflectionResponse

  reflection.proto:81

  The message sent by the server to answer ServerReflectionInfo method.

  • string valid_host = 1

  • optional ServerReflectionRequest original_request = 2

  • oneof message_response

    The server set one of the following fields according to the message_request in the request.

    • FileDescriptorResponse file_descriptor_response = 4

      This message is used to answer file_by_filename, file_containing_symbol, file_containing_extension requests with transitive dependencies. As the repeated label is not allowed in oneof fields, we use a FileDescriptorResponse message to encapsulate the repeated fields. The reflection service is allowed to avoid sending FileDescriptorProtos that were previously sent in response to earlier requests in the stream.

    • ExtensionNumberResponse all_extension_numbers_response = 5

      This message is used to answer all_extension_numbers_of_type request.

    • ListServiceResponse list_services_response = 6

      This message is used to answer list_services request.

    • ErrorResponse error_response = 7

      This message is used when an error occurs.

The error code and error message sent by the server when an error occurs.

Used in: ServerReflectionResponse

• int32 error_code = 1

  This field uses the error codes defined in grpc::StatusCode.

• string error_message = 2

A list of extension numbers sent by the server answering all_extension_numbers_of_type request.

Used in: ServerReflectionResponse

• string base_type_name = 1

  Full name of the base type, including the package name. The format is <package>.<type>

• repeated int32 extension_number = 2

The type name and extension number sent by the client when requesting file_containing_extension.

Used in: ServerReflectionRequest

• string containing_type = 1

  Fully-qualified type name. The format should be <package>.<type>

• int32 extension_number = 2

Serialized FileDescriptorProto messages sent by the server answering a file_by_filename, file_containing_symbol, or file_containing_extension request.

Used in: ServerReflectionResponse

• repeated bytes file_descriptor_proto = 1

  Serialized FileDescriptorProto messages. We avoid taking a dependency on descriptor.proto, which uses proto2 only features, by making them opaque bytes instead.

A list of ServiceResponse sent by the server answering list_services request.

Used in: ServerReflectionResponse

• repeated ServiceResponse service = 1

  The information of each service may be expanded in the future, so we use ServiceResponse message to encapsulate it.

The message sent by the client when calling ServerReflectionInfo method.

Used as request type in: ServerReflection.ServerReflectionInfo

Used as field type in: ServerReflectionResponse

• string host = 1

• oneof message_request

  To use reflection service, the client should set one of the following fields in message_request. The server distinguishes requests by their defined field and then handles them using corresponding methods.

  • string file_by_filename = 3

    Find a proto file by the file name.

  • string file_containing_symbol = 4

    Find the proto file that declares the given fully-qualified symbol name. This field should be a fully-qualified symbol name (e.g. <package>.<service>[.<method>] or <package>.<type>).

  • ExtensionRequest file_containing_extension = 5

    Find the proto file which defines an extension extending the given message type with the given field number.

  • string all_extension_numbers_of_type = 6

    Finds the tag numbers used by all known extensions of extendee_type, and appends them to ExtensionNumberResponse in an undefined order. Its corresponding method is best-effort: it's not guaranteed that the reflection service will implement this method, and it's not guaranteed that this method will provide all extensions. Returns StatusCode::UNIMPLEMENTED if it's not implemented. This field should be a fully-qualified type name. The format is <package>.<type>

  • string list_services = 7

    List the full names of registered services. The content will not be checked.

The information of a single service used by ListServiceResponse to answer list_services request.

Used in: ListServiceResponse

• string name = 1

  Full name of a registered service, including its package name. The format is <package>.<service>