-
- All Implemented Interfaces:
-
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.HeaderOrBuilder,java.io.Serializable
public final class Openapiv2.Header extends GeneratedMessageV3 implements Openapiv2.HeaderOrBuilder
Protobuf type`Header` is a representation of OpenAPI v2 specification's Header object. See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#headerObjectgrpc.gateway.protoc_gen_openapiv2.options.Header
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classOpenapiv2.Header.Builder
Protobuf type`Header` is a representation of OpenAPI v2 specification's Header object. See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#headerObjectgrpc.gateway.protoc_gen_openapiv2.options.Header
-
Field Summary
Fields Modifier and Type Field Description public final static intDESCRIPTION_FIELD_NUMBERpublic final static intTYPE_FIELD_NUMBERpublic final static intFORMAT_FIELD_NUMBERpublic final static intDEFAULT_FIELD_NUMBERpublic final static intPATTERN_FIELD_NUMBER
-
Method Summary
Modifier and Type Method Description final UnknownFieldSetgetUnknownFields()final static Descriptors.DescriptorgetDescriptor()StringgetDescription()`Description` is a short description of the header.string description = 1;ByteStringgetDescriptionBytes()`Description` is a short description of the header.string description = 1;StringgetType()The type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported.string type = 2;ByteStringgetTypeBytes()The type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported.string type = 2;StringgetFormat()`Format` The extending format for the previously mentioned type.string format = 3;ByteStringgetFormatBytes()`Format` The extending format for the previously mentioned type.string format = 3;StringgetDefault()`Default` Declares the value of the header that the server will use if none is provided. See: https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2. Unlike JSON Schema this value MUST conform to the defined type for the header.string default = 6;ByteStringgetDefaultBytes()`Default` Declares the value of the header that the server will use if none is provided. See: https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2. Unlike JSON Schema this value MUST conform to the defined type for the header.string default = 6;StringgetPattern()'Pattern' See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3.string pattern = 13;ByteStringgetPatternBytes()'Pattern' See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3.string pattern = 13;final booleanisInitialized()voidwriteTo(CodedOutputStream output)intgetSerializedSize()booleanequals(Object obj)inthashCode()static Openapiv2.HeaderparseFrom(ByteBuffer data)static Openapiv2.HeaderparseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)static Openapiv2.HeaderparseFrom(ByteString data)static Openapiv2.HeaderparseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)static Openapiv2.HeaderparseFrom(Array<byte> data)static Openapiv2.HeaderparseFrom(Array<byte> data, ExtensionRegistryLite extensionRegistry)static Openapiv2.HeaderparseFrom(InputStream input)static Openapiv2.HeaderparseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)static Openapiv2.HeaderparseDelimitedFrom(InputStream input)static Openapiv2.HeaderparseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)static Openapiv2.HeaderparseFrom(CodedInputStream input)static Openapiv2.HeaderparseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)Openapiv2.Header.BuildernewBuilderForType()static Openapiv2.Header.BuildernewBuilder()static Openapiv2.Header.BuildernewBuilder(Openapiv2.Header prototype)Openapiv2.Header.BuildertoBuilder()static Openapiv2.HeadergetDefaultInstance()static Parser<Openapiv2.Header>parser()Parser<Openapiv2.Header>getParserForType()Openapiv2.HeadergetDefaultInstanceForType()-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof -
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, toString -
Methods inherited from class com.google.protobuf.AbstractMessageLite
toByteArray, toByteString, writeDelimitedTo -
Methods inherited from class com.google.protobuf.MessageLite
getParserForType, toBuilder -
Methods inherited from class com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType -
Methods inherited from class com.google.protobuf.Message
getParserForType -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
getUnknownFields
final UnknownFieldSet getUnknownFields()
-
getDescriptor
final static Descriptors.Descriptor getDescriptor()
-
getDescription
String getDescription()
`Description` is a short description of the header.string description = 1;
-
getDescriptionBytes
ByteString getDescriptionBytes()
`Description` is a short description of the header.string description = 1;
-
getType
String getType()
The type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported.string type = 2;
-
getTypeBytes
ByteString getTypeBytes()
The type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported.string type = 2;
-
getFormat
String getFormat()
`Format` The extending format for the previously mentioned type.string format = 3;
-
getFormatBytes
ByteString getFormatBytes()
`Format` The extending format for the previously mentioned type.string format = 3;
-
getDefault
String getDefault()
`Default` Declares the value of the header that the server will use if none is provided. See: https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2. Unlike JSON Schema this value MUST conform to the defined type for the header.string default = 6;
-
getDefaultBytes
ByteString getDefaultBytes()
`Default` Declares the value of the header that the server will use if none is provided. See: https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2. Unlike JSON Schema this value MUST conform to the defined type for the header.string default = 6;
-
getPattern
String getPattern()
'Pattern' See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3.string pattern = 13;
-
getPatternBytes
ByteString getPatternBytes()
'Pattern' See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3.string pattern = 13;
-
isInitialized
final boolean isInitialized()
-
writeTo
void writeTo(CodedOutputStream output)
-
getSerializedSize
int getSerializedSize()
-
equals
boolean equals(Object obj)
-
hashCode
int hashCode()
-
parseFrom
static Openapiv2.Header parseFrom(ByteBuffer data)
-
parseFrom
static Openapiv2.Header parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
-
parseFrom
static Openapiv2.Header parseFrom(ByteString data)
-
parseFrom
static Openapiv2.Header parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
-
parseFrom
static Openapiv2.Header parseFrom(Array<byte> data)
-
parseFrom
static Openapiv2.Header parseFrom(Array<byte> data, ExtensionRegistryLite extensionRegistry)
-
parseFrom
static Openapiv2.Header parseFrom(InputStream input)
-
parseFrom
static Openapiv2.Header parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
-
parseDelimitedFrom
static Openapiv2.Header parseDelimitedFrom(InputStream input)
-
parseDelimitedFrom
static Openapiv2.Header parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
-
parseFrom
static Openapiv2.Header parseFrom(CodedInputStream input)
-
parseFrom
static Openapiv2.Header parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
-
newBuilderForType
Openapiv2.Header.Builder newBuilderForType()
-
newBuilder
static Openapiv2.Header.Builder newBuilder()
-
newBuilder
static Openapiv2.Header.Builder newBuilder(Openapiv2.Header prototype)
-
toBuilder
Openapiv2.Header.Builder toBuilder()
-
getDefaultInstance
static Openapiv2.Header getDefaultInstance()
-
parser
static Parser<Openapiv2.Header> parser()
-
getParserForType
Parser<Openapiv2.Header> getParserForType()
-
getDefaultInstanceForType
Openapiv2.Header getDefaultInstanceForType()
-
-
-
-