Class Openapiv2.Response
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
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.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#responseObjectProtobuf type
grpc.gateway.protoc_gen_openapiv2.options.Response- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class`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 Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleancontainsExamples(String key) `Examples` gives per-mimetype response examples.booleancontainsExtensions(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.booleancontainsHeaders(String key) `Headers` A list of headers that are sent with the response.booleanstatic Openapiv2.Response`Description` is a short description of the response.com.google.protobuf.ByteString`Description` is a short description of the response.static final com.google.protobuf.Descriptors.DescriptorDeprecated.int`Examples` gives per-mimetype response examples.`Examples` gives per-mimetype response examples.getExamplesOrDefault(String key, String defaultValue) `Examples` gives per-mimetype response examples.getExamplesOrThrow(String key) `Examples` gives per-mimetype response examples.Deprecated.intCustom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.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.ValuegetExtensionsOrDefault(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.ValueCustom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.Deprecated.int`Headers` A list of headers that are sent with the response.`Headers` A list of headers that are sent with the response.getHeadersOrDefault(String key, Openapiv2.Header defaultValue) `Headers` A list of headers that are sent with the response.getHeadersOrThrow(String key) `Headers` A list of headers that are sent with the response.com.google.protobuf.Parser<Openapiv2.Response>`Schema` optionally defines the structure of the response.`Schema` optionally defines the structure of the response.intinthashCode()boolean`Schema` optionally defines the structure of the response.protected com.google.protobuf.GeneratedMessage.FieldAccessorTableprotected com.google.protobuf.MapFieldReflectionAccessorinternalGetMapFieldReflection(int number) final booleanstatic Openapiv2.Response.Builderstatic Openapiv2.Response.BuildernewBuilder(Openapiv2.Response prototype) protected Openapiv2.Response.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static Openapiv2.ResponseparseDelimitedFrom(InputStream input) static Openapiv2.ResponseparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Openapiv2.ResponseparseFrom(byte[] data) static Openapiv2.ResponseparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Openapiv2.ResponseparseFrom(com.google.protobuf.ByteString data) static Openapiv2.ResponseparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Openapiv2.ResponseparseFrom(com.google.protobuf.CodedInputStream input) static Openapiv2.ResponseparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Openapiv2.ResponseparseFrom(InputStream input) static Openapiv2.ResponseparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Openapiv2.ResponseparseFrom(ByteBuffer data) static Openapiv2.ResponseparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<Openapiv2.Response>parser()voidwriteTo(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, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER- See Also:
-
SCHEMA_FIELD_NUMBER
public static final int SCHEMA_FIELD_NUMBER- See Also:
-
HEADERS_FIELD_NUMBER
public static final int HEADERS_FIELD_NUMBER- See Also:
-
EXAMPLES_FIELD_NUMBER
public static final int EXAMPLES_FIELD_NUMBER- See Also:
-
EXTENSIONS_FIELD_NUMBER
public static final int EXTENSIONS_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number) - Overrides:
internalGetMapFieldReflectionin classcom.google.protobuf.GeneratedMessage
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
getDescription
`Description` is a short description of the response. GFM syntax can be used for rich text representation.
string description = 1;- Specified by:
getDescriptionin interfaceOpenapiv2.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:
getDescriptionBytesin interfaceOpenapiv2.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:
hasSchemain interfaceOpenapiv2.ResponseOrBuilder- Returns:
- Whether the schema field is set.
-
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:
getSchemain interfaceOpenapiv2.ResponseOrBuilder- Returns:
- The schema.
-
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:
getSchemaOrBuilderin interfaceOpenapiv2.ResponseOrBuilder
-
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:
getHeadersCountin interfaceOpenapiv2.ResponseOrBuilder
-
containsHeaders
`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:
containsHeadersin interfaceOpenapiv2.ResponseOrBuilder
-
getHeaders
Deprecated.UsegetHeadersMap()instead.- Specified by:
getHeadersin interfaceOpenapiv2.ResponseOrBuilder
-
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:
getHeadersMapin interfaceOpenapiv2.ResponseOrBuilder
-
getHeadersOrDefault
`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:
getHeadersOrDefaultin interfaceOpenapiv2.ResponseOrBuilder
-
getHeadersOrThrow
`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:
getHeadersOrThrowin interfaceOpenapiv2.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:
getExamplesCountin interfaceOpenapiv2.ResponseOrBuilder
-
containsExamples
`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:
containsExamplesin interfaceOpenapiv2.ResponseOrBuilder
-
getExamples
Deprecated.UsegetExamplesMap()instead.- Specified by:
getExamplesin interfaceOpenapiv2.ResponseOrBuilder
-
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:
getExamplesMapin interfaceOpenapiv2.ResponseOrBuilder
-
getExamplesOrDefault
`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:
getExamplesOrDefaultin interfaceOpenapiv2.ResponseOrBuilder
-
getExamplesOrThrow
`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:
getExamplesOrThrowin interfaceOpenapiv2.ResponseOrBuilder
-
getExtensionsCount
public int getExtensionsCount()Description copied from interface:Openapiv2.ResponseOrBuilderCustom 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:
getExtensionsCountin interfaceOpenapiv2.ResponseOrBuilder
-
containsExtensions
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:
containsExtensionsin interfaceOpenapiv2.ResponseOrBuilder
-
getExtensions
Deprecated.UsegetExtensionsMap()instead.- Specified by:
getExtensionsin interfaceOpenapiv2.ResponseOrBuilder
-
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:
getExtensionsMapin interfaceOpenapiv2.ResponseOrBuilder
-
getExtensionsOrDefault
public com.google.protobuf.Value getExtensionsOrDefault(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:
getExtensionsOrDefaultin interfaceOpenapiv2.ResponseOrBuilder
-
getExtensionsOrThrow
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:
getExtensionsOrThrowin interfaceOpenapiv2.ResponseOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.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
- Throws:
IOException
-
parseFrom
public static Openapiv2.Response parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- 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
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Openapiv2.Response.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-