Package grpc.gateway.protoc_gen_openapiv2.options

Class Openapiv2.Response

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Response
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Openapiv2.ResponseOrBuilder, Serializable
Enclosing class:
Openapiv2
public static final class Openapiv2.Response extends com.google.protobuf.GeneratedMessageV3 implements Openapiv2.ResponseOrBuilder
 `Response` is a representation of OpenAPI v2 specification's Response object.
 See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#responseObject
Protobuf type grpc.gateway.protoc_gen_openapiv2.options.Response
See Also:

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getUnknownFields

      public final com.google.protobuf.UnknownFieldSet getUnknownFields()
      Specified by:
      getUnknownFields in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getUnknownFields in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapField

      protected com.google.protobuf.MapField internalGetMapField(int number)
      Overrides:
      internalGetMapField in class com.google.protobuf.GeneratedMessageV3

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getDescription

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

    • getDescriptionBytes

      public 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;
      Specified by:
      getDescriptionBytes in interface Openapiv2.ResponseOrBuilder
      Returns:
      The bytes for description.

    • hasSchema

      public 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;
      Specified by:
      hasSchema in interface Openapiv2.ResponseOrBuilder
      Returns:
      Whether the schema field is set.

    • getSchema

      public 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;
      Specified by:
      getSchema in interface Openapiv2.ResponseOrBuilder
      Returns:
      The schema.

    • getSchemaOrBuilder

      public 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;
      Specified by:
      getSchemaOrBuilder in interface Openapiv2.ResponseOrBuilder

    • getExamplesCount

      public int getExamplesCount()
      Description copied from interface: Openapiv2.ResponseOrBuilder
       `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;
      Specified by:
      getExamplesCount in interface Openapiv2.ResponseOrBuilder

    • containsExamples

      public 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;
      Specified by:
      containsExamples in interface Openapiv2.ResponseOrBuilder

    • getExamples

      @Deprecated public Map<String,String> getExamples()
      Deprecated.
      Use getExamplesMap() instead.
      Specified by:
      getExamples in interface Openapiv2.ResponseOrBuilder

    • getExamplesMap

      public 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;
      Specified by:
      getExamplesMap in interface Openapiv2.ResponseOrBuilder

    • getExamplesOrDefault

      public 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;
      Specified by:
      getExamplesOrDefault in interface Openapiv2.ResponseOrBuilder

    • getExamplesOrThrow

      public 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;
      Specified by:
      getExamplesOrThrow in interface Openapiv2.ResponseOrBuilder

    • getExtensionsCount

      public int getExtensionsCount()
      Description copied from interface: Openapiv2.ResponseOrBuilder
      map<string, .google.protobuf.Value> extensions = 5;
      Specified by:
      getExtensionsCount in interface Openapiv2.ResponseOrBuilder

    • containsExtensions

      public boolean containsExtensions(String key)
      map<string, .google.protobuf.Value> extensions = 5;
      Specified by:
      containsExtensions in interface Openapiv2.ResponseOrBuilder

    • getExtensions

      @Deprecated public Map<String,Value> getExtensions()
      Deprecated.
      Use getExtensionsMap() instead.
      Specified by:
      getExtensions in interface Openapiv2.ResponseOrBuilder

    • getExtensionsMap

      public Map<String,Value> getExtensionsMap()
      map<string, .google.protobuf.Value> extensions = 5;
      Specified by:
      getExtensionsMap in interface Openapiv2.ResponseOrBuilder

    • getExtensionsOrDefault

      public Value getExtensionsOrDefault(String key, Value defaultValue)
      map<string, .google.protobuf.Value> extensions = 5;
      Specified by:
      getExtensionsOrDefault in interface Openapiv2.ResponseOrBuilder

    • getExtensionsOrThrow

      public Value getExtensionsOrThrow(String key)
      map<string, .google.protobuf.Value> extensions = 5;
      Specified by:
      getExtensionsOrThrow in interface Openapiv2.ResponseOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Openapiv2.Response parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Openapiv2.Response parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Openapiv2.Response parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Openapiv2.Response parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Openapiv2.Response parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Openapiv2.Response parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Openapiv2.Response parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Openapiv2.Response parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Openapiv2.Response parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Openapiv2.Response parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Openapiv2.Response parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Openapiv2.Response parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Openapiv2.Response.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Openapiv2.Response.Builder newBuilder()

    • newBuilder

      public static Openapiv2.Response.Builder newBuilder(Openapiv2.Response prototype)

    • toBuilder

      public Openapiv2.Response.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Openapiv2.Response.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Openapiv2.Response getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Openapiv2.Response> parser()

    • getParserForType

      public com.google.protobuf.Parser<Openapiv2.Response> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public Openapiv2.Response getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder