Package com.openapi.v3

Class Header

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.openapi.v3.Header
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, HeaderOrBuilder, Serializable
public final class Header extends com.google.protobuf.GeneratedMessageV3 implements HeaderOrBuilder
 The Header Object follows the structure of the Parameter Object with the following changes:  1. `name` MUST NOT be specified, it is given in the corresponding `headers` map. 1. `in` MUST NOT be specified, it is implicitly in `header`. 1. All traits that are affected by the location MUST be applicable to a location of `header` (for example, `style`).
Protobuf type openapi.v3.Header
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Header.Builder
    The Header Object follows the structure of the Parameter Object with the following changes: 1.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    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
    ALLOW_EMPTY_VALUE_FIELD_NUMBER
     
    static final int
    ALLOW_RESERVED_FIELD_NUMBER
     
    static final int
    CONTENT_FIELD_NUMBER
     
    static final int
    DEPRECATED_FIELD_NUMBER
     
    static final int
    DESCRIPTION_FIELD_NUMBER
     
    static final int
    EXAMPLE_FIELD_NUMBER
     
    static final int
    EXAMPLES_FIELD_NUMBER
     
    static final int
    EXPLODE_FIELD_NUMBER
     
    static final int
    REQUIRED_FIELD_NUMBER
     
    static final int
    SCHEMA_FIELD_NUMBER
     
    static final int
    SPECIFICATION_EXTENSION_FIELD_NUMBER
     
    static final int
    STYLE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    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)
     
    boolean
    getAllowEmptyValue()
    bool allow_empty_value = 4 [json_name = "allowEmptyValue"];
    boolean
    getAllowReserved()
    bool allow_reserved = 7 [json_name = "allowReserved"];
    MediaTypes
    getContent()
    .openapi.v3.MediaTypes content = 11 [json_name = "content"];
    MediaTypesOrBuilder
    getContentOrBuilder()
    .openapi.v3.MediaTypes content = 11 [json_name = "content"];
    static Header
    getDefaultInstance()
     
    Header
    getDefaultInstanceForType()
     
    boolean
    getDeprecated()
    bool deprecated = 3 [json_name = "deprecated"];
    String
    getDescription()
    string description = 1 [json_name = "description"];
    com.google.protobuf.ByteString
    getDescriptionBytes()
    string description = 1 [json_name = "description"];
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    Any
    getExample()
    .openapi.v3.Any example = 9 [json_name = "example"];
    AnyOrBuilder
    getExampleOrBuilder()
    .openapi.v3.Any example = 9 [json_name = "example"];
    ExamplesOrReferences
    getExamples()
    .openapi.v3.ExamplesOrReferences examples = 10 [json_name = "examples"];
    ExamplesOrReferencesOrBuilder
    getExamplesOrBuilder()
    .openapi.v3.ExamplesOrReferences examples = 10 [json_name = "examples"];
    boolean
    getExplode()
    bool explode = 6 [json_name = "explode"];
    com.google.protobuf.Parser<Header>
    getParserForType()
     
    boolean
    getRequired()
    bool required = 2 [json_name = "required"];
    SchemaOrReference
    getSchema()
    .openapi.v3.SchemaOrReference schema = 8 [json_name = "schema"];
    SchemaOrReferenceOrBuilder
    getSchemaOrBuilder()
    .openapi.v3.SchemaOrReference schema = 8 [json_name = "schema"];
    int
    getSerializedSize()
     
    NamedAny
    getSpecificationExtension(int index)
    repeated .openapi.v3.NamedAny specification_extension = 12 [json_name = "specificationExtension"];
    int
    getSpecificationExtensionCount()
    repeated .openapi.v3.NamedAny specification_extension = 12 [json_name = "specificationExtension"];
    List<NamedAny>
    getSpecificationExtensionList()
    repeated .openapi.v3.NamedAny specification_extension = 12 [json_name = "specificationExtension"];
    NamedAnyOrBuilder
    getSpecificationExtensionOrBuilder(int index)
    repeated .openapi.v3.NamedAny specification_extension = 12 [json_name = "specificationExtension"];
    List<? extends NamedAnyOrBuilder>
    getSpecificationExtensionOrBuilderList()
    repeated .openapi.v3.NamedAny specification_extension = 12 [json_name = "specificationExtension"];
    String
    getStyle()
    string style = 5 [json_name = "style"];
    com.google.protobuf.ByteString
    getStyleBytes()
    string style = 5 [json_name = "style"];
    boolean
    hasContent()
    .openapi.v3.MediaTypes content = 11 [json_name = "content"];
    boolean
    hasExample()
    .openapi.v3.Any example = 9 [json_name = "example"];
    boolean
    hasExamples()
    .openapi.v3.ExamplesOrReferences examples = 10 [json_name = "examples"];
    int
    hashCode()
     
    boolean
    hasSchema()
    .openapi.v3.SchemaOrReference schema = 8 [json_name = "schema"];
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Header.Builder
    newBuilder()
     
    static Header.Builder
    newBuilder(Header prototype)
     
    Header.Builder
    newBuilderForType()
     
    protected Header.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Header
    parseDelimitedFrom(InputStream input)
     
    static Header
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Header
    parseFrom(byte[] data)
     
    static Header
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Header
    parseFrom(com.google.protobuf.ByteString data)
     
    static Header
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Header
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Header
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Header
    parseFrom(InputStream input)
     
    static Header
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Header
    parseFrom(ByteBuffer data)
     
    static Header
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Header>
    parser()
     
    Header.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, 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

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • REQUIRED_FIELD_NUMBER

      public static final int REQUIRED_FIELD_NUMBER
      See Also:

    • DEPRECATED_FIELD_NUMBER

      public static final int DEPRECATED_FIELD_NUMBER
      See Also:

    • ALLOW_EMPTY_VALUE_FIELD_NUMBER

      public static final int ALLOW_EMPTY_VALUE_FIELD_NUMBER
      See Also:

    • STYLE_FIELD_NUMBER

      public static final int STYLE_FIELD_NUMBER
      See Also:

    • EXPLODE_FIELD_NUMBER

      public static final int EXPLODE_FIELD_NUMBER
      See Also:

    • ALLOW_RESERVED_FIELD_NUMBER

      public static final int ALLOW_RESERVED_FIELD_NUMBER
      See Also:

    • SCHEMA_FIELD_NUMBER

      public static final int SCHEMA_FIELD_NUMBER
      See Also:

    • EXAMPLE_FIELD_NUMBER

      public static final int EXAMPLE_FIELD_NUMBER
      See Also:

    • EXAMPLES_FIELD_NUMBER

      public static final int EXAMPLES_FIELD_NUMBER
      See Also:

    • CONTENT_FIELD_NUMBER

      public static final int CONTENT_FIELD_NUMBER
      See Also:

    • SPECIFICATION_EXTENSION_FIELD_NUMBER

      public static final int SPECIFICATION_EXTENSION_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • getDescription

      public String getDescription()
      string description = 1 [json_name = "description"];
      Specified by:
      getDescription in interface HeaderOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
      string description = 1 [json_name = "description"];
      Specified by:
      getDescriptionBytes in interface HeaderOrBuilder
      Returns:
      The bytes for description.

    • getRequired

      public boolean getRequired()
      bool required = 2 [json_name = "required"];
      Specified by:
      getRequired in interface HeaderOrBuilder
      Returns:
      The required.

    • getDeprecated

      public boolean getDeprecated()
      bool deprecated = 3 [json_name = "deprecated"];
      Specified by:
      getDeprecated in interface HeaderOrBuilder
      Returns:
      The deprecated.

    • getAllowEmptyValue

      public boolean getAllowEmptyValue()
      bool allow_empty_value = 4 [json_name = "allowEmptyValue"];
      Specified by:
      getAllowEmptyValue in interface HeaderOrBuilder
      Returns:
      The allowEmptyValue.

    • getStyle

      public String getStyle()
      string style = 5 [json_name = "style"];
      Specified by:
      getStyle in interface HeaderOrBuilder
      Returns:
      The style.

    • getStyleBytes

      public com.google.protobuf.ByteString getStyleBytes()
      string style = 5 [json_name = "style"];
      Specified by:
      getStyleBytes in interface HeaderOrBuilder
      Returns:
      The bytes for style.

    • getExplode

      public boolean getExplode()
      bool explode = 6 [json_name = "explode"];
      Specified by:
      getExplode in interface HeaderOrBuilder
      Returns:
      The explode.

    • getAllowReserved

      public boolean getAllowReserved()
      bool allow_reserved = 7 [json_name = "allowReserved"];
      Specified by:
      getAllowReserved in interface HeaderOrBuilder
      Returns:
      The allowReserved.

    • hasSchema

      public boolean hasSchema()
      .openapi.v3.SchemaOrReference schema = 8 [json_name = "schema"];
      Specified by:
      hasSchema in interface HeaderOrBuilder
      Returns:
      Whether the schema field is set.

    • getSchema

      public SchemaOrReference getSchema()
      .openapi.v3.SchemaOrReference schema = 8 [json_name = "schema"];
      Specified by:
      getSchema in interface HeaderOrBuilder
      Returns:
      The schema.

    • getSchemaOrBuilder

      public SchemaOrReferenceOrBuilder getSchemaOrBuilder()
      .openapi.v3.SchemaOrReference schema = 8 [json_name = "schema"];
      Specified by:
      getSchemaOrBuilder in interface HeaderOrBuilder

    • hasExample

      public boolean hasExample()
      .openapi.v3.Any example = 9 [json_name = "example"];
      Specified by:
      hasExample in interface HeaderOrBuilder
      Returns:
      Whether the example field is set.

    • getExample

      public Any getExample()
      .openapi.v3.Any example = 9 [json_name = "example"];
      Specified by:
      getExample in interface HeaderOrBuilder
      Returns:
      The example.

    • getExampleOrBuilder

      public AnyOrBuilder getExampleOrBuilder()
      .openapi.v3.Any example = 9 [json_name = "example"];
      Specified by:
      getExampleOrBuilder in interface HeaderOrBuilder

    • hasExamples

      public boolean hasExamples()
      .openapi.v3.ExamplesOrReferences examples = 10 [json_name = "examples"];
      Specified by:
      hasExamples in interface HeaderOrBuilder
      Returns:
      Whether the examples field is set.

    • getExamples

      public ExamplesOrReferences getExamples()
      .openapi.v3.ExamplesOrReferences examples = 10 [json_name = "examples"];
      Specified by:
      getExamples in interface HeaderOrBuilder
      Returns:
      The examples.

    • getExamplesOrBuilder

      public ExamplesOrReferencesOrBuilder getExamplesOrBuilder()
      .openapi.v3.ExamplesOrReferences examples = 10 [json_name = "examples"];
      Specified by:
      getExamplesOrBuilder in interface HeaderOrBuilder

    • hasContent

      public boolean hasContent()
      .openapi.v3.MediaTypes content = 11 [json_name = "content"];
      Specified by:
      hasContent in interface HeaderOrBuilder
      Returns:
      Whether the content field is set.

    • getContent

      public MediaTypes getContent()
      .openapi.v3.MediaTypes content = 11 [json_name = "content"];
      Specified by:
      getContent in interface HeaderOrBuilder
      Returns:
      The content.

    • getContentOrBuilder

      public MediaTypesOrBuilder getContentOrBuilder()
      .openapi.v3.MediaTypes content = 11 [json_name = "content"];
      Specified by:
      getContentOrBuilder in interface HeaderOrBuilder

    • getSpecificationExtensionList

      public List<NamedAny> getSpecificationExtensionList()
      repeated .openapi.v3.NamedAny specification_extension = 12 [json_name = "specificationExtension"];
      Specified by:
      getSpecificationExtensionList in interface HeaderOrBuilder

    • getSpecificationExtensionOrBuilderList

      public List<? extends NamedAnyOrBuilder> getSpecificationExtensionOrBuilderList()
      repeated .openapi.v3.NamedAny specification_extension = 12 [json_name = "specificationExtension"];
      Specified by:
      getSpecificationExtensionOrBuilderList in interface HeaderOrBuilder

    • getSpecificationExtensionCount

      public int getSpecificationExtensionCount()
      repeated .openapi.v3.NamedAny specification_extension = 12 [json_name = "specificationExtension"];
      Specified by:
      getSpecificationExtensionCount in interface HeaderOrBuilder

    • getSpecificationExtension

      public NamedAny getSpecificationExtension(int index)
      repeated .openapi.v3.NamedAny specification_extension = 12 [json_name = "specificationExtension"];
      Specified by:
      getSpecificationExtension in interface HeaderOrBuilder

    • getSpecificationExtensionOrBuilder

      public NamedAnyOrBuilder getSpecificationExtensionOrBuilder(int index)
      repeated .openapi.v3.NamedAny specification_extension = 12 [json_name = "specificationExtension"];
      Specified by:
      getSpecificationExtensionOrBuilder in interface HeaderOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • 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.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • 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 Header parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Header.Builder newBuilder()

    • newBuilder

      public static Header.Builder newBuilder(Header prototype)

    • toBuilder

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

    • newBuilderForType

      protected Header.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Header getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<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.GeneratedMessageV3

    • getDefaultInstanceForType

      public Header getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder