java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - grpc.gateway.protoc_gen_swagger.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_swagger.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.
`private static class`	`Openapiv2.Response.ExamplesDefaultEntryHolder`
`private static class`	`Openapiv2.Response.ExtensionsDefaultEntryHolder`

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

Field Summary

Fields
Modifier and Type	Field	Description
`private static Openapiv2.Response`	`DEFAULT_INSTANCE`
`private Object`	`description_`
`static int`	`DESCRIPTION_FIELD_NUMBER`
`private com.google.protobuf.MapField<String,String>`	`examples_`
`static int`	`EXAMPLES_FIELD_NUMBER`
`private com.google.protobuf.MapField<String,com.google.protobuf.Value>`	`extensions_`
`static int`	`EXTENSIONS_FIELD_NUMBER`
`private byte`	`memoizedIsInitialized`
`private static com.google.protobuf.Parser<Openapiv2.Response>`	`PARSER`
`private Openapiv2.Schema`	`schema_`
`static int`	`SCHEMA_FIELD_NUMBER`
`private static long`	`serialVersionUID`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Constructor Summary

Constructors
Modifier Constructor Description

private Response()

private Response(com.google.protobuf.GeneratedMessageV3.Builder<?> builder)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`boolean`	`containsExamples(String key)`	`Examples` gives per-mimetype response examples.
`boolean`	`containsExtensions(String key)`	`map<string, .google.protobuf.Value> extensions = 5;`
`boolean`	`equals(Object obj)`
`static Openapiv2.Response`	`getDefaultInstance()`
`Openapiv2.Response`	`getDefaultInstanceForType()`
`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()`
`Map<String,String>`	`getExamples()`	Deprecated.
`int`	`getExamplesCount()`	`Examples` gives per-mimetype response examples.
`Map<String,String>`	`getExamplesMap()`	`Examples` gives per-mimetype response examples.
`String`	`getExamplesOrDefault(String key, String defaultValue)`	`Examples` gives per-mimetype response examples.
`String`	`getExamplesOrThrow(String key)`	`Examples` gives per-mimetype response examples.
`Map<String,com.google.protobuf.Value>`	`getExtensions()`	Deprecated.
`int`	`getExtensionsCount()`	`map<string, .google.protobuf.Value> extensions = 5;`
`Map<String,com.google.protobuf.Value>`	`getExtensionsMap()`	`map<string, .google.protobuf.Value> extensions = 5;`
`com.google.protobuf.Value`	`getExtensionsOrDefault(String key, com.google.protobuf.Value defaultValue)`	`map<string, .google.protobuf.Value> extensions = 5;`
`com.google.protobuf.Value`	`getExtensionsOrThrow(String key)`	`map<string, .google.protobuf.Value> extensions = 5;`
`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()`
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`int`	`hashCode()`
`boolean`	`hasSchema()`	`Schema` optionally defines the structure of the response.
`private com.google.protobuf.MapField<String,String>`	`internalGetExamples()`
`private com.google.protobuf.MapField<String,com.google.protobuf.Value>`	`internalGetExtensions()`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapField`	`internalGetMapField(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.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static Openapiv2.Response`	`parseDelimitedFrom(InputStream input)`
`static Openapiv2.Response`	`parseDelimitedFrom(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(InputStream input)`
`static Openapiv2.Response`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Openapiv2.Response`	`parseFrom(ByteBuffer data)`
`static Openapiv2.Response`	`parseFrom(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.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, 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, hasField, hasOneof

Field Detail

serialVersionUID
```
private static final long serialVersionUID
```
See Also:

Constant Field Values

DESCRIPTION_FIELD_NUMBER
```
public static final int DESCRIPTION_FIELD_NUMBER
```
See Also:

Constant Field Values

description_
```
private volatile Object description_
```

SCHEMA_FIELD_NUMBER
```
public static final int SCHEMA_FIELD_NUMBER
```
See Also:

Constant Field Values

schema_
```
private Openapiv2.Schema schema_
```

EXAMPLES_FIELD_NUMBER
```
public static final int EXAMPLES_FIELD_NUMBER
```
See Also:

Constant Field Values

examples_

private com.google.protobuf.MapField<String,String> examples_

EXTENSIONS_FIELD_NUMBER
```
public static final int EXTENSIONS_FIELD_NUMBER
```
See Also:

Constant Field Values

extensions_

private com.google.protobuf.MapField<String,com.google.protobuf.Value> extensions_

memoizedIsInitialized
```
private byte memoizedIsInitialized
```

DEFAULT_INSTANCE

private static final Openapiv2.Response DEFAULT_INSTANCE

PARSER

private static final com.google.protobuf.Parser<Openapiv2.Response> PARSER

Constructor Detail

Response

private Response(com.google.protobuf.GeneratedMessageV3.Builder<?> builder)

Response
```
private Response()
```

Method Detail

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_swagger.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_swagger.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_swagger.options.Schema schema = 2;

Specified by:: getSchemaOrBuilder in interface Openapiv2.ResponseOrBuilder

internalGetExamples

private com.google.protobuf.MapField<String,String> internalGetExamples()