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 Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean containsExamples​(java.lang.String key)
      `Examples` gives per-mimetype response examples.
      boolean containsExtensions​(java.lang.String key)
      Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.
      boolean containsHeaders​(java.lang.String key)
      `Headers` A list of headers that are sent with the response.
      java.lang.String getDescription()
      `Description` is a short description of the response.
      com.google.protobuf.ByteString getDescriptionBytes()
      `Description` is a short description of the response.
      java.util.Map<java.lang.String,​java.lang.String> getExamples()
      Deprecated.
      int getExamplesCount()
      `Examples` gives per-mimetype response examples.
      java.util.Map<java.lang.String,​java.lang.String> getExamplesMap()
      `Examples` gives per-mimetype response examples.
      java.lang.String getExamplesOrDefault​(java.lang.String key, java.lang.String defaultValue)
      `Examples` gives per-mimetype response examples.
      java.lang.String getExamplesOrThrow​(java.lang.String key)
      `Examples` gives per-mimetype response examples.
      java.util.Map<java.lang.String,​com.google.protobuf.Value> getExtensions()
      Deprecated.
      int getExtensionsCount()
      Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.
      java.util.Map<java.lang.String,​com.google.protobuf.Value> getExtensionsMap()
      Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.
      com.google.protobuf.Value getExtensionsOrDefault​(java.lang.String key, com.google.protobuf.Value defaultValue)
      Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.
      com.google.protobuf.Value getExtensionsOrThrow​(java.lang.String key)
      Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.
      java.util.Map<java.lang.String,​Openapiv2.Header> getHeaders()
      Deprecated.
      int getHeadersCount()
      `Headers` A list of headers that are sent with the response.
      java.util.Map<java.lang.String,​Openapiv2.Header> getHeadersMap()
      `Headers` A list of headers that are sent with the response.
      Openapiv2.Header getHeadersOrDefault​(java.lang.String key, Openapiv2.Header defaultValue)
      `Headers` A list of headers that are sent with the response.
      Openapiv2.Header getHeadersOrThrow​(java.lang.String key)
      `Headers` A list of headers that are sent with the response.
      Openapiv2.Schema getSchema()
      `Schema` optionally defines the structure of the response.
      Openapiv2.SchemaOrBuilder getSchemaOrBuilder()
      `Schema` optionally defines the structure of the response.
      boolean hasSchema()
      `Schema` optionally defines the structure of the response.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getDescription

        java.lang.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;

      • getHeadersCount

        int getHeadersCount()
         `Headers` A list of headers that are sent with the response.
 `Header` name is expected to be a string in the canonical format of the MIME header key
 See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey
        map<string, .grpc.gateway.protoc_gen_openapiv2.options.Header> headers = 3;

      • containsHeaders

        boolean containsHeaders​(java.lang.String key)
         `Headers` A list of headers that are sent with the response.
 `Header` name is expected to be a string in the canonical format of the MIME header key
 See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey
        map<string, .grpc.gateway.protoc_gen_openapiv2.options.Header> headers = 3;

      • getHeadersMap

        java.util.Map<java.lang.String,​Openapiv2.Header> getHeadersMap()
         `Headers` A list of headers that are sent with the response.
 `Header` name is expected to be a string in the canonical format of the MIME header key
 See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey
        map<string, .grpc.gateway.protoc_gen_openapiv2.options.Header> headers = 3;

      • getHeadersOrDefault

        Openapiv2.Header getHeadersOrDefault​(java.lang.String key,
                                     Openapiv2.Header defaultValue)
         `Headers` A list of headers that are sent with the response.
 `Header` name is expected to be a string in the canonical format of the MIME header key
 See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey
        map<string, .grpc.gateway.protoc_gen_openapiv2.options.Header> headers = 3;

      • getHeadersOrThrow

        Openapiv2.Header getHeadersOrThrow​(java.lang.String key)
         `Headers` A list of headers that are sent with the response.
 `Header` name is expected to be a string in the canonical format of the MIME header key
 See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey
        map<string, .grpc.gateway.protoc_gen_openapiv2.options.Header> headers = 3;

      • 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​(java.lang.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
java.util.Map<java.lang.String,​java.lang.String> getExamples()
        Deprecated.
        Use getExamplesMap() instead.

      • getExamplesMap

        java.util.Map<java.lang.String,​java.lang.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

        java.lang.String getExamplesOrDefault​(java.lang.String key,
                                      java.lang.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

        java.lang.String getExamplesOrThrow​(java.lang.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()
         Custom properties that start with "x-" such as "x-foo" used to describe
 extra functionality that is not covered by the standard OpenAPI Specification.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
        map<string, .google.protobuf.Value> extensions = 5;

      • containsExtensions

        boolean containsExtensions​(java.lang.String key)
         Custom properties that start with "x-" such as "x-foo" used to describe
 extra functionality that is not covered by the standard OpenAPI Specification.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
        map<string, .google.protobuf.Value> extensions = 5;

      • getExtensions

        @Deprecated
java.util.Map<java.lang.String,​com.google.protobuf.Value> getExtensions()
        Deprecated.
        Use getExtensionsMap() instead.

      • getExtensionsMap

        java.util.Map<java.lang.String,​com.google.protobuf.Value> getExtensionsMap()
         Custom properties that start with "x-" such as "x-foo" used to describe
 extra functionality that is not covered by the standard OpenAPI Specification.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
        map<string, .google.protobuf.Value> extensions = 5;

      • getExtensionsOrDefault

        com.google.protobuf.Value getExtensionsOrDefault​(java.lang.String key,
                                                 com.google.protobuf.Value defaultValue)
         Custom properties that start with "x-" such as "x-foo" used to describe
 extra functionality that is not covered by the standard OpenAPI Specification.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
        map<string, .google.protobuf.Value> extensions = 5;

      • getExtensionsOrThrow

        com.google.protobuf.Value getExtensionsOrThrow​(java.lang.String key)
         Custom properties that start with "x-" such as "x-foo" used to describe
 extra functionality that is not covered by the standard OpenAPI Specification.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
        map<string, .google.protobuf.Value> extensions = 5;