Class Openapiv2.Response.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderType>
com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Response.Builder>
grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Response.Builder
- All Implemented Interfaces:
com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Openapiv2.ResponseOrBuilder
,Cloneable
- Enclosing class:
- Openapiv2.Response
public static final class Openapiv2.Response.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Response.Builder>
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
-
Method Summary
Modifier and TypeMethodDescriptionaddRepeatedField
(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) build()
clear()
`Description` is a short description of the response.clearField
(com.google.protobuf.Descriptors.FieldDescriptor field) clearOneof
(com.google.protobuf.Descriptors.OneofDescriptor oneof) `Schema` optionally defines the structure of the response.clone()
boolean
containsExamples
(String key) `Examples` gives per-mimetype response examples.boolean
containsExtensions
(String key) map<string, .google.protobuf.Value> extensions = 5;
`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.Descriptor
com.google.protobuf.Descriptors.Descriptor
Deprecated.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.int
map<string, .google.protobuf.Value> extensions = 5;
map<string, .google.protobuf.Value> extensions = 5;
getExtensionsOrDefault
(String key, Value defaultValue) map<string, .google.protobuf.Value> extensions = 5;
map<string, .google.protobuf.Value> extensions = 5;
Deprecated.Deprecated.`Schema` optionally defines the structure of the response.`Schema` optionally defines the structure of the response.`Schema` optionally defines the structure of the response.boolean
`Schema` optionally defines the structure of the response.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
protected com.google.protobuf.MapField
internalGetMapField
(int number) protected com.google.protobuf.MapField
internalGetMutableMapField
(int number) final boolean
mergeFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom
(com.google.protobuf.Message other) mergeFrom
(Openapiv2.Response other) mergeSchema
(Openapiv2.Schema value) `Schema` optionally defines the structure of the response.mergeUnknownFields
(com.google.protobuf.UnknownFieldSet unknownFields) putAllExamples
(Map<String, String> values) `Examples` gives per-mimetype response examples.putAllExtensions
(Map<String, Value> values) map<string, .google.protobuf.Value> extensions = 5;
putExamples
(String key, String value) `Examples` gives per-mimetype response examples.putExtensions
(String key, Value value) map<string, .google.protobuf.Value> extensions = 5;
removeExamples
(String key) `Examples` gives per-mimetype response examples.removeExtensions
(String key) map<string, .google.protobuf.Value> extensions = 5;
setDescription
(String value) `Description` is a short description of the response.setDescriptionBytes
(com.google.protobuf.ByteString value) `Description` is a short description of the response.setRepeatedField
(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) setSchema
(Openapiv2.Schema value) `Schema` optionally defines the structure of the response.setSchema
(Openapiv2.Schema.Builder builderForValue) `Schema` optionally defines the structure of the response.setUnknownFields
(com.google.protobuf.UnknownFieldSet unknownFields) Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetMapField
protected com.google.protobuf.MapField internalGetMapField(int number) - Overrides:
internalGetMapField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Response.Builder>
-
internalGetMutableMapField
protected com.google.protobuf.MapField internalGetMutableMapField(int number) - Overrides:
internalGetMutableMapField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Response.Builder>
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Response.Builder>
-
clear
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Response.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Response.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clone
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clone
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clone
in classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Response.Builder>
-
setField
public Openapiv2.Response.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
setField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Response.Builder>
-
clearField
- Specified by:
clearField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Response.Builder>
-
clearOneof
- Specified by:
clearOneof
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearOneof
in classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Response.Builder>
-
setRepeatedField
public Openapiv2.Response.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) - Specified by:
setRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Response.Builder>
-
addRepeatedField
public Openapiv2.Response.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
addRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Response.Builder>
-
mergeFrom
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<Openapiv2.Response.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Response.Builder>
-
mergeFrom
public Openapiv2.Response.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<Openapiv2.Response.Builder>
- Throws:
IOException
-
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 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:
getDescriptionBytes
in interfaceOpenapiv2.ResponseOrBuilder
- Returns:
- The bytes for description.
-
setDescription
`Description` is a short description of the response. GFM syntax can be used for rich text representation.
string description = 1;
- Parameters:
value
- The description to set.- Returns:
- This builder for chaining.
-
clearDescription
`Description` is a short description of the response. GFM syntax can be used for rich text representation.
string description = 1;
- Returns:
- This builder for chaining.
-
setDescriptionBytes
`Description` is a short description of the response. GFM syntax can be used for rich text representation.
string description = 1;
- Parameters:
value
- The bytes for description to set.- Returns:
- This builder for chaining.
-
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 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:
getSchema
in interfaceOpenapiv2.ResponseOrBuilder
- Returns:
- The schema.
-
setSchema
`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;
-
setSchema
`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;
-
mergeSchema
`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;
-
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;
-
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;
-
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:
getSchemaOrBuilder
in 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:
getExamplesCount
in 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:
containsExamples
in interfaceOpenapiv2.ResponseOrBuilder
-
getExamples
Deprecated.UsegetExamplesMap()
instead.- Specified by:
getExamples
in 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:
getExamplesMap
in 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:
getExamplesOrDefault
in 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:
getExamplesOrThrow
in interfaceOpenapiv2.ResponseOrBuilder
-
clearExamples
-
removeExamples
`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;
-
getMutableExamples
Deprecated.Use alternate mutation accessors instead. -
putExamples
`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;
-
putAllExamples
`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;
-
getExtensionsCount
public int getExtensionsCount()Description copied from interface:Openapiv2.ResponseOrBuilder
map<string, .google.protobuf.Value> extensions = 5;
- Specified by:
getExtensionsCount
in interfaceOpenapiv2.ResponseOrBuilder
-
containsExtensions
map<string, .google.protobuf.Value> extensions = 5;
- Specified by:
containsExtensions
in interfaceOpenapiv2.ResponseOrBuilder
-
getExtensions
Deprecated.UsegetExtensionsMap()
instead.- Specified by:
getExtensions
in interfaceOpenapiv2.ResponseOrBuilder
-
getExtensionsMap
map<string, .google.protobuf.Value> extensions = 5;
- Specified by:
getExtensionsMap
in interfaceOpenapiv2.ResponseOrBuilder
-
getExtensionsOrDefault
map<string, .google.protobuf.Value> extensions = 5;
- Specified by:
getExtensionsOrDefault
in interfaceOpenapiv2.ResponseOrBuilder
-
getExtensionsOrThrow
map<string, .google.protobuf.Value> extensions = 5;
- Specified by:
getExtensionsOrThrow
in interfaceOpenapiv2.ResponseOrBuilder
-
clearExtensions
-
removeExtensions
map<string, .google.protobuf.Value> extensions = 5;
-
getMutableExtensions
Deprecated.Use alternate mutation accessors instead. -
putExtensions
map<string, .google.protobuf.Value> extensions = 5;
-
putAllExtensions
map<string, .google.protobuf.Value> extensions = 5;
-
setUnknownFields
public final Openapiv2.Response.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
setUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Response.Builder>
-
mergeUnknownFields
public final Openapiv2.Response.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
mergeUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Response.Builder>
-