Package grpc.gateway.protoc_gen_openapiv2.options

Class Openapiv2.Response

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Openapiv2.ResponseOrBuilder, java.io.Serializable
    Enclosing class:
    Openapiv2
    public static final class Openapiv2.Response
extends com.google.protobuf.GeneratedMessage
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:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Openapiv2.Response.Builder
      `Response` is a representation of OpenAPI v2 specification's Response object.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

        com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,​T extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

        com.google.protobuf.AbstractMessage.BuilderParent

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Summary

      All Methods Static Methods Instance Methods Concrete 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.
      boolean equals​(java.lang.Object obj)  
      static Openapiv2.Response getDefaultInstance()  
      Openapiv2.Response getDefaultInstanceForType()  
      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.
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      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.
      com.google.protobuf.Parser<Openapiv2.Response> getParserForType()  
      Openapiv2.Schema getSchema()
      `Schema` optionally defines the structure of the response.
      Openapiv2.SchemaOrBuilder getSchemaOrBuilder()
      `Schema` optionally defines the structure of the response.
      int getSerializedSize()  
      int hashCode()  
      boolean hasSchema()
      `Schema` optionally defines the structure of the response.
      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()  
      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection​(int number)  
      boolean isInitialized()  
      static Openapiv2.Response.Builder newBuilder()  
      static Openapiv2.Response.Builder newBuilder​(Openapiv2.Response prototype)  
      Openapiv2.Response.Builder newBuilderForType()  
      protected Openapiv2.Response.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)  
      static Openapiv2.Response parseDelimitedFrom​(java.io.InputStream input)  
      static Openapiv2.Response parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Openapiv2.Response parseFrom​(byte[] data)  
      static Openapiv2.Response parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Openapiv2.Response parseFrom​(com.google.protobuf.ByteString data)  
      static Openapiv2.Response parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Openapiv2.Response parseFrom​(com.google.protobuf.CodedInputStream input)  
      static Openapiv2.Response parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Openapiv2.Response parseFrom​(java.io.InputStream input)  
      static Openapiv2.Response parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Openapiv2.Response parseFrom​(java.nio.ByteBuffer data)  
      static Openapiv2.Response parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Openapiv2.Response> parser()  
      Openapiv2.Response.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessage

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashFields, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

        toByteArray, toByteString, writeDelimitedTo, writeTo

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

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

    • Method Detail

      • getDescriptor

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

      • internalGetMapFieldReflection

        protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection​(int number)
        Overrides:
        internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

      • internalGetFieldAccessorTable

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

      • getDescription

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

      • getHeadersCount

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

      • containsHeaders

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

      • getHeadersMap

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

      • getHeadersOrDefault

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

      • getHeadersOrThrow

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

      • getExamplesMap

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

      • getExamplesOrDefault

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

      • getExamplesOrThrow

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

      • getExtensionsCount

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

      • containsExtensions

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

      • getExtensionsMap

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

      • getExtensionsOrDefault

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

      • getExtensionsOrThrow

        public 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;
        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.GeneratedMessage

      • writeTo

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

      • getSerializedSize

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

      • equals

        public boolean equals​(java.lang.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​(java.nio.ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Openapiv2.Response parseFrom​(java.nio.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​(java.io.InputStream input)
                                    throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

        public static Openapiv2.Response parseFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws java.io.IOException
        Throws:
        java.io.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

      • 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.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage

      • 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.GeneratedMessage

      • getDefaultInstanceForType

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