public static final class Response.Builder extends com.google.protobuf.GeneratedMessage.Builder<Response.Builder> 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#responseObjectProtobuf type
grpc.gateway.protoc_gen_openapiv2.options.Response
Modifier and Type | Method and Description |
---|---|
Response |
build() |
Response |
buildPartial() |
Response.Builder |
clear() |
Response.Builder |
clearDescription()
`Description` is a short description of the response.
|
Response.Builder |
clearExamples() |
Response.Builder |
clearExtensions() |
Response.Builder |
clearHeaders() |
Response.Builder |
clearSchema()
`Schema` optionally defines the structure of the response.
|
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.
|
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() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
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.
|
java.util.Map<java.lang.String,java.lang.String> |
getMutableExamples()
Deprecated.
|
java.util.Map<java.lang.String,com.google.protobuf.Value> |
getMutableExtensions()
Deprecated.
|
java.util.Map<java.lang.String,Header> |
getMutableHeaders()
Deprecated.
|
Schema |
getSchema()
`Schema` optionally defines the structure of the response.
|
Schema.Builder |
getSchemaBuilder()
`Schema` optionally defines the structure of the response.
|
SchemaOrBuilder |
getSchemaOrBuilder()
`Schema` optionally defines the structure of the response.
|
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) |
protected com.google.protobuf.MapFieldReflectionAccessor |
internalGetMutableMapFieldReflection(int number) |
boolean |
isInitialized() |
Response.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
Response.Builder |
mergeFrom(com.google.protobuf.Message other) |
Response.Builder |
mergeFrom(Response other) |
Response.Builder |
mergeSchema(Schema value)
`Schema` optionally defines the structure of the response.
|
Response.Builder |
putAllExamples(java.util.Map<java.lang.String,java.lang.String> values)
`Examples` gives per-mimetype response examples.
|
Response.Builder |
putAllExtensions(java.util.Map<java.lang.String,com.google.protobuf.Value> values)
Custom properties that start with "x-" such as "x-foo" used to describe
extra functionality that is not covered by the standard OpenAPI Specification.
|
Response.Builder |
putAllHeaders(java.util.Map<java.lang.String,Header> values)
`Headers` A list of headers that are sent with the response.
|
Response.Builder |
putExamples(java.lang.String key,
java.lang.String value)
`Examples` gives per-mimetype response examples.
|
Response.Builder |
putExtensions(java.lang.String key,
com.google.protobuf.Value value)
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.Builder |
putExtensionsBuilderIfAbsent(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.
|
Response.Builder |
putHeaders(java.lang.String key,
Header value)
`Headers` A list of headers that are sent with the response.
|
Header.Builder |
putHeadersBuilderIfAbsent(java.lang.String key)
`Headers` A list of headers that are sent with the response.
|
Response.Builder |
removeExamples(java.lang.String key)
`Examples` gives per-mimetype response examples.
|
Response.Builder |
removeExtensions(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.
|
Response.Builder |
removeHeaders(java.lang.String key)
`Headers` A list of headers that are sent with the response.
|
Response.Builder |
setDescription(java.lang.String value)
`Description` is a short description of the response.
|
Response.Builder |
setDescriptionBytes(com.google.protobuf.ByteString value)
`Description` is a short description of the response.
|
Response.Builder |
setSchema(Schema.Builder builderForValue)
`Schema` optionally defines the structure of the response.
|
Response.Builder |
setSchema(Schema value)
`Schema` optionally defines the structure of the response.
|
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
internalGetMapFieldReflection
in class com.google.protobuf.GeneratedMessage.Builder<Response.Builder>
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
internalGetMutableMapFieldReflection
in class com.google.protobuf.GeneratedMessage.Builder<Response.Builder>
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessage.Builder<Response.Builder>
public Response.Builder clear()
clear
in interface com.google.protobuf.Message.Builder
clear
in interface com.google.protobuf.MessageLite.Builder
clear
in class com.google.protobuf.GeneratedMessage.Builder<Response.Builder>
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType
in interface com.google.protobuf.Message.Builder
getDescriptorForType
in interface com.google.protobuf.MessageOrBuilder
getDescriptorForType
in class com.google.protobuf.GeneratedMessage.Builder<Response.Builder>
public Response getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder
public Response build()
build
in interface com.google.protobuf.Message.Builder
build
in interface com.google.protobuf.MessageLite.Builder
public Response buildPartial()
buildPartial
in interface com.google.protobuf.Message.Builder
buildPartial
in interface com.google.protobuf.MessageLite.Builder
public Response.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom
in interface com.google.protobuf.Message.Builder
mergeFrom
in class com.google.protobuf.AbstractMessage.Builder<Response.Builder>
public Response.Builder mergeFrom(Response other)
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessage.Builder<Response.Builder>
public Response.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
mergeFrom
in interface com.google.protobuf.Message.Builder
mergeFrom
in interface com.google.protobuf.MessageLite.Builder
mergeFrom
in class com.google.protobuf.AbstractMessage.Builder<Response.Builder>
java.io.IOException
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"];
getDescription
in interface ResponseOrBuilder
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"];
getDescriptionBytes
in interface ResponseOrBuilder
public Response.Builder setDescription(java.lang.String value)
`Description` is a short description of the response. GFM syntax can be used for rich text representation.
string description = 1 [json_name = "description"];
value
- The description to set.public Response.Builder clearDescription()
`Description` is a short description of the response. GFM syntax can be used for rich text representation.
string description = 1 [json_name = "description"];
public Response.Builder setDescriptionBytes(com.google.protobuf.ByteString value)
`Description` is a short description of the response. GFM syntax can be used for rich text representation.
string description = 1 [json_name = "description"];
value
- The bytes for description to set.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"];
hasSchema
in interface ResponseOrBuilder
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"];
getSchema
in interface ResponseOrBuilder
public Response.Builder setSchema(Schema value)
`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"];
public Response.Builder setSchema(Schema.Builder builderForValue)
`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"];
public Response.Builder mergeSchema(Schema value)
`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"];
public Response.Builder clearSchema()
`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"];
public Schema.Builder getSchemaBuilder()
`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"];
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"];
getSchemaOrBuilder
in interface ResponseOrBuilder
public int getHeadersCount()
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"];
getHeadersCount
in interface ResponseOrBuilder
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"];
containsHeaders
in interface ResponseOrBuilder
@Deprecated public java.util.Map<java.lang.String,Header> getHeaders()
getHeadersMap()
instead.getHeaders
in interface ResponseOrBuilder
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"];
getHeadersMap
in interface ResponseOrBuilder
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"];
getHeadersOrDefault
in interface ResponseOrBuilder
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"];
getHeadersOrThrow
in interface ResponseOrBuilder
public Response.Builder clearHeaders()
public Response.Builder removeHeaders(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"];
@Deprecated public java.util.Map<java.lang.String,Header> getMutableHeaders()
public Response.Builder putHeaders(java.lang.String key, Header value)
`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"];
public Response.Builder putAllHeaders(java.util.Map<java.lang.String,Header> values)
`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"];
public Header.Builder putHeadersBuilderIfAbsent(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"];
public int getExamplesCount()
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"];
getExamplesCount
in interface ResponseOrBuilder
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"];
containsExamples
in interface ResponseOrBuilder
@Deprecated public java.util.Map<java.lang.String,java.lang.String> getExamples()
getExamplesMap()
instead.getExamples
in interface ResponseOrBuilder
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"];
getExamplesMap
in interface ResponseOrBuilder
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"];
getExamplesOrDefault
in interface ResponseOrBuilder
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"];
getExamplesOrThrow
in interface ResponseOrBuilder
public Response.Builder clearExamples()
public Response.Builder removeExamples(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"];
@Deprecated public java.util.Map<java.lang.String,java.lang.String> getMutableExamples()
public Response.Builder putExamples(java.lang.String key, java.lang.String value)
`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"];
public Response.Builder putAllExamples(java.util.Map<java.lang.String,java.lang.String> values)
`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"];
public int getExtensionsCount()
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"];
getExtensionsCount
in interface ResponseOrBuilder
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"];
containsExtensions
in interface ResponseOrBuilder
@Deprecated public java.util.Map<java.lang.String,com.google.protobuf.Value> getExtensions()
getExtensionsMap()
instead.getExtensions
in interface ResponseOrBuilder
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"];
getExtensionsMap
in interface ResponseOrBuilder
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"];
getExtensionsOrDefault
in interface ResponseOrBuilder
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"];
getExtensionsOrThrow
in interface ResponseOrBuilder
public Response.Builder clearExtensions()
public Response.Builder removeExtensions(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"];
@Deprecated public java.util.Map<java.lang.String,com.google.protobuf.Value> getMutableExtensions()
public Response.Builder putExtensions(java.lang.String key, com.google.protobuf.Value value)
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"];
public Response.Builder putAllExtensions(java.util.Map<java.lang.String,com.google.protobuf.Value> values)
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"];
public com.google.protobuf.Value.Builder putExtensionsBuilderIfAbsent(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"];