Package grpc.gateway.protoc_gen_openapiv2.options

Class Openapiv2.Header

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Header
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Openapiv2.HeaderOrBuilder, Serializable
Enclosing class:
Openapiv2
public static final class Openapiv2.Header extends com.google.protobuf.GeneratedMessage implements Openapiv2.HeaderOrBuilder
 `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#headerObject
Protobuf type grpc.gateway.protoc_gen_openapiv2.options.Header
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Openapiv2.Header.Builder
    `Header` is a representation of OpenAPI v2 specification's Header 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 extends Object>, 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
    Description
    static final int
    DEFAULT_FIELD_NUMBER
     
    static final int
    DESCRIPTION_FIELD_NUMBER
     
    static final int
    FORMAT_FIELD_NUMBER
     
    static final int
    PATTERN_FIELD_NUMBER
     
    static final int
    TYPE_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
    Description
    boolean
    equals(Object obj)
     
    String
    getDefault()
    `Default` Declares the value of the header that the server will use if none is provided.
    com.google.protobuf.ByteString
    getDefaultBytes()
    `Default` Declares the value of the header that the server will use if none is provided.
    static Openapiv2.Header
    getDefaultInstance()
     
    Openapiv2.Header
    getDefaultInstanceForType()
     
    String
    getDescription()
    `Description` is a short description of the header.
    com.google.protobuf.ByteString
    getDescriptionBytes()
    `Description` is a short description of the header.
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getFormat()
    `Format` The extending format for the previously mentioned type.
    com.google.protobuf.ByteString
    getFormatBytes()
    `Format` The extending format for the previously mentioned type.
    com.google.protobuf.Parser<Openapiv2.Header>
    getParserForType()
     
    String
    getPattern()
    'Pattern' See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3.
    com.google.protobuf.ByteString
    getPatternBytes()
    'Pattern' See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3.
    int
    getSerializedSize()
     
    String
    getType()
    The type of the object.
    com.google.protobuf.ByteString
    getTypeBytes()
    The type of the object.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Openapiv2.Header.Builder
    newBuilder()
     
    static Openapiv2.Header.Builder
    newBuilder(Openapiv2.Header prototype)
     
    Openapiv2.Header.Builder
    newBuilderForType()
     
    protected Openapiv2.Header.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Openapiv2.Header
    parseDelimitedFrom(InputStream input)
     
    static Openapiv2.Header
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Openapiv2.Header
    parseFrom(byte[] data)
     
    static Openapiv2.Header
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Openapiv2.Header
    parseFrom(com.google.protobuf.ByteString data)
     
    static Openapiv2.Header
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Openapiv2.Header
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Openapiv2.Header
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Openapiv2.Header
    parseFrom(InputStream input)
     
    static Openapiv2.Header
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Openapiv2.Header
    parseFrom(ByteBuffer data)
     
    static Openapiv2.Header
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Openapiv2.Header>
    parser()
     
    Openapiv2.Header.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, internalGetMapFieldReflection, 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.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getDescription

      public String getDescription()
       `Description` is a short description of the header.
      string description = 1;
      Specified by:
      getDescription in interface Openapiv2.HeaderOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       `Description` is a short description of the header.
      string description = 1;
      Specified by:
      getDescriptionBytes in interface Openapiv2.HeaderOrBuilder
      Returns:
      The bytes for description.

    • getType

      public 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;
      Specified by:
      getType in interface Openapiv2.HeaderOrBuilder
      Returns:
      The type.

    • getTypeBytes

      public com.google.protobuf.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;
      Specified by:
      getTypeBytes in interface Openapiv2.HeaderOrBuilder
      Returns:
      The bytes for type.

    • getFormat

      public String getFormat()
       `Format` The extending format for the previously mentioned type.
      string format = 3;
      Specified by:
      getFormat in interface Openapiv2.HeaderOrBuilder
      Returns:
      The format.

    • getFormatBytes

      public com.google.protobuf.ByteString getFormatBytes()
       `Format` The extending format for the previously mentioned type.
      string format = 3;
      Specified by:
      getFormatBytes in interface Openapiv2.HeaderOrBuilder
      Returns:
      The bytes for format.

    • getDefault

      public 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;
      Specified by:
      getDefault in interface Openapiv2.HeaderOrBuilder
      Returns:
      The default.

    • getDefaultBytes

      public com.google.protobuf.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;
      Specified by:
      getDefaultBytes in interface Openapiv2.HeaderOrBuilder
      Returns:
      The bytes for default.

    • getPattern

      public String getPattern()
       'Pattern' See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3.
      string pattern = 13;
      Specified by:
      getPattern in interface Openapiv2.HeaderOrBuilder
      Returns:
      The pattern.

    • getPatternBytes

      public com.google.protobuf.ByteString getPatternBytes()
       'Pattern' See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3.
      string pattern = 13;
      Specified by:
      getPatternBytes in interface Openapiv2.HeaderOrBuilder
      Returns:
      The bytes for pattern.

    • 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      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(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 Openapiv2.Header parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Openapiv2.Header parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Openapiv2.Header parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Openapiv2.Header parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Openapiv2.Header parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Openapiv2.Header parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Openapiv2.Header parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Openapiv2.Header parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Openapiv2.Header parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Openapiv2.Header parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Openapiv2.Header parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Openapiv2.Header parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Openapiv2.Header.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Openapiv2.Header.Builder newBuilder()

    • newBuilder

      public static Openapiv2.Header.Builder newBuilder(Openapiv2.Header prototype)

    • toBuilder

      public Openapiv2.Header.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Openapiv2.Header.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Openapiv2.Header getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Openapiv2.Header> 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 Openapiv2.Header getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder