com.grpc.gateway.protoc_gen_openapiv2.options

Class Response

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.grpc.gateway.protoc_gen_openapiv2.options.Response

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ResponseOrBuilder, java.io.Serializable

public final class Response
extends com.google.protobuf.GeneratedMessage
implements 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 and Description
static class	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>, 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

Field Summary

Fields

Modifier and Type	Field and Description
static int	DESCRIPTION_FIELD_NUMBER
static int	EXAMPLES_FIELD_NUMBER
static int	EXTENSIONS_FIELD_NUMBER
static int	HEADERS_FIELD_NUMBER
static int	SCHEMA_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and 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 Response	getDefaultInstance()
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,Header>	getHeaders() Deprecated.
int	getHeadersCount() `Headers` A list of headers that are sent with the response.
java.util.Map<java.lang.String,Header>	getHeadersMap() `Headers` A list of headers that are sent with the response.
Header	getHeadersOrDefault(java.lang.String key, Header defaultValue) `Headers` A list of headers that are sent with the response.
Header	getHeadersOrThrow(java.lang.String key) `Headers` A list of headers that are sent with the response.
com.google.protobuf.Parser<Response>	getParserForType()
Schema	getSchema() `Schema` optionally defines the structure of the response.
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 Response.Builder	newBuilder()
static Response.Builder	newBuilder(Response prototype)
Response.Builder	newBuilderForType()
protected Response.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static Response	parseDelimitedFrom(java.io.InputStream input)
static Response	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Response	parseFrom(byte[] data)
static Response	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Response	parseFrom(java.nio.ByteBuffer data)
static Response	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Response	parseFrom(com.google.protobuf.ByteString data)
static Response	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Response	parseFrom(com.google.protobuf.CodedInputStream input)
static Response	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Response	parseFrom(java.io.InputStream input)
static Response	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Response>	parser()
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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

See Also:

Constant Field Values

SCHEMA_FIELD_NUMBER

public static final int SCHEMA_FIELD_NUMBER

See Also:

Constant Field Values

HEADERS_FIELD_NUMBER

public static final int HEADERS_FIELD_NUMBER

See Also:

Constant Field Values

EXAMPLES_FIELD_NUMBER

public static final int EXAMPLES_FIELD_NUMBER

See Also:

Constant Field Values

EXTENSIONS_FIELD_NUMBER

public static final int EXTENSIONS_FIELD_NUMBER

See Also:

Constant Field Values

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 [json_name = "description"];

Specified by:

getDescription in interface 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 [json_name = "description"];

Specified by:

getDescriptionBytes in interface 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 [json_name = "schema"];

Specified by:

hasSchema in interface ResponseOrBuilder

Returns:

Whether the schema field is set.

getSchema

public 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 [json_name = "schema"];

Specified by:

getSchema in interface ResponseOrBuilder

Returns:

The schema.

getSchemaOrBuilder

public 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 [json_name = "schema"];

Specified by:

getSchemaOrBuilder in interface ResponseOrBuilder

getHeadersCount

public int getHeadersCount()

Description copied from interface: 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 [json_name = "headers"];

Specified by:

getHeadersCount in interface 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 [json_name = "headers"];

Specified by:

containsHeaders in interface ResponseOrBuilder

getHeaders

@Deprecated
public java.util.Map<java.lang.String,Header> getHeaders()

Deprecated.

Use getHeadersMap() instead.

Specified by:

getHeaders in interface ResponseOrBuilder

getHeadersMap

public java.util.Map<java.lang.String,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 [json_name = "headers"];

Specified by:

getHeadersMap in interface ResponseOrBuilder

getHeadersOrDefault

public Header getHeadersOrDefault(java.lang.String key,
                                  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 [json_name = "headers"];

Specified by:

getHeadersOrDefault in interface ResponseOrBuilder

getHeadersOrThrow

public 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 [json_name = "headers"];

Specified by:

getHeadersOrThrow in interface ResponseOrBuilder

getExamplesCount

public int getExamplesCount()

Description copied from interface: 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 [json_name = "examples"];

Specified by:

getExamplesCount in interface 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 [json_name = "examples"];

Specified by:

containsExamples in interface ResponseOrBuilder

getExamples

@Deprecated
public java.util.Map<java.lang.String,java.lang.String> getExamples()

Deprecated.

Use getExamplesMap() instead.

Specified by:

getExamples in interface 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 [json_name = "examples"];

Specified by:

getExamplesMap in interface 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 [json_name = "examples"];

Specified by:

getExamplesOrDefault in interface 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 [json_name = "examples"];

Specified by:

getExamplesOrThrow in interface ResponseOrBuilder

getExtensionsCount

public int getExtensionsCount()

Description copied from interface: 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 [json_name = "extensions"];

Specified by:

getExtensionsCount in interface 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 [json_name = "extensions"];

Specified by:

containsExtensions in interface ResponseOrBuilder

getExtensions

@Deprecated
public java.util.Map<java.lang.String,com.google.protobuf.Value> getExtensions()

Deprecated.

Use getExtensionsMap() instead.

Specified by:

getExtensions in interface 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 [json_name = "extensions"];

Specified by:

getExtensionsMap in interface 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 [json_name = "extensions"];

Specified by:

getExtensionsOrDefault in interface 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 [json_name = "extensions"];

Specified by:

getExtensionsOrThrow in interface 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 Response parseFrom(java.nio.ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Response parseFrom(java.nio.ByteBuffer data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static 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 Response parseFrom(byte[] data)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Response parseFrom(java.io.InputStream input)
                          throws java.io.IOException

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

public static Response parseDelimitedFrom(java.io.InputStream input)
                                   throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseFrom

public static Response parseFrom(com.google.protobuf.CodedInputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public Response.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Response.Builder newBuilder()

newBuilder

public static Response.Builder newBuilder(Response prototype)

toBuilder

public Response.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Response.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static Response getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<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 Response getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder