Package grpc.gateway.protoc_gen_openapiv2.options

Interface Openapiv2.ResponseOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Openapiv2.Response, Openapiv2.Response.Builder
Enclosing class:
Openapiv2
public static interface Openapiv2.ResponseOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getDescription

      String getDescription()
       `Description` is a short description of the response.
 GFM syntax can be used for rich text representation.
      string description = 1;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       `Description` is a short description of the response.
 GFM syntax can be used for rich text representation.
      string description = 1;
      Returns:
      The bytes for description.

    • hasSchema

      boolean hasSchema()
       `Schema` optionally defines the structure of the response.
 If `Schema` is not provided, it means there is no content to the response.
      .grpc.gateway.protoc_gen_openapiv2.options.Schema schema = 2;
      Returns:
      Whether the schema field is set.

    • getSchema

      Openapiv2.Schema getSchema()
       `Schema` optionally defines the structure of the response.
 If `Schema` is not provided, it means there is no content to the response.
      .grpc.gateway.protoc_gen_openapiv2.options.Schema schema = 2;
      Returns:
      The schema.

    • getSchemaOrBuilder

      Openapiv2.SchemaOrBuilder getSchemaOrBuilder()
       `Schema` optionally defines the structure of the response.
 If `Schema` is not provided, it means there is no content to the response.
      .grpc.gateway.protoc_gen_openapiv2.options.Schema schema = 2;

    • getExamplesCount

      int getExamplesCount()
       `Examples` gives per-mimetype response examples.
 See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#example-object
      map<string, string> examples = 4;

    • containsExamples

      boolean containsExamples(String key)
       `Examples` gives per-mimetype response examples.
 See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#example-object
      map<string, string> examples = 4;

    • getExamples

      @Deprecated Map<String,String> getExamples()
      Deprecated.
      Use getExamplesMap() instead.

    • getExamplesMap

      Map<String,String> getExamplesMap()
       `Examples` gives per-mimetype response examples.
 See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#example-object
      map<string, string> examples = 4;

    • getExamplesOrDefault

      String getExamplesOrDefault(String key, String defaultValue)
       `Examples` gives per-mimetype response examples.
 See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#example-object
      map<string, string> examples = 4;

    • getExamplesOrThrow

      String getExamplesOrThrow(String key)
       `Examples` gives per-mimetype response examples.
 See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#example-object
      map<string, string> examples = 4;

    • getExtensionsCount

      int getExtensionsCount()
      map<string, .google.protobuf.Value> extensions = 5;

    • containsExtensions

      boolean containsExtensions(String key)
      map<string, .google.protobuf.Value> extensions = 5;

    • getExtensions

      @Deprecated Map<String,Value> getExtensions()
      Deprecated.
      Use getExtensionsMap() instead.

    • getExtensionsMap

      Map<String,Value> getExtensionsMap()
      map<string, .google.protobuf.Value> extensions = 5;

    • getExtensionsOrDefault

      Value getExtensionsOrDefault(String key, Value defaultValue)
      map<string, .google.protobuf.Value> extensions = 5;

    • getExtensionsOrThrow

      Value getExtensionsOrThrow(String key)
      map<string, .google.protobuf.Value> extensions = 5;