Package grpc.gateway.protoc_gen_openapiv2.options

Class Openapiv2.HeaderParameter

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.HeaderParameter
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Openapiv2.HeaderParameterOrBuilder, Serializable
Enclosing class:
Openapiv2
public static final class Openapiv2.HeaderParameter extends com.google.protobuf.GeneratedMessage implements Openapiv2.HeaderParameterOrBuilder
 `HeaderParameter` a HTTP header parameter.
 See: https://swagger.io/specification/v2/#parameter-object
Protobuf type grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter
See Also:

  • 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

    • getName

      public String getName()
       `Name` is the header name.
      string name = 1;
      Specified by:
      getName in interface Openapiv2.HeaderParameterOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       `Name` is the header name.
      string name = 1;
      Specified by:
      getNameBytes in interface Openapiv2.HeaderParameterOrBuilder
      Returns:
      The bytes for name.

    • getDescription

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

    • getDescriptionBytes

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

    • getTypeValue

      public int getTypeValue()
       `Type` is the type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported.
 See: https://swagger.io/specification/v2/#parameterType.
      .grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter.Type type = 3;
      Specified by:
      getTypeValue in interface Openapiv2.HeaderParameterOrBuilder
      Returns:
      The enum numeric value on the wire for type.

    • getType

      public Openapiv2.HeaderParameter.Type getType()
       `Type` is the type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported.
 See: https://swagger.io/specification/v2/#parameterType.
      .grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter.Type type = 3;
      Specified by:
      getType in interface Openapiv2.HeaderParameterOrBuilder
      Returns:
      The type.

    • getFormat

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

    • getFormatBytes

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

    • getRequired

      public boolean getRequired()
       `Required` indicates if the header is optional
      bool required = 5;
      Specified by:
      getRequired in interface Openapiv2.HeaderParameterOrBuilder
      Returns:
      The required.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Openapiv2.HeaderParameter.Builder newBuilder()

    • newBuilder

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

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Openapiv2.HeaderParameter getDefaultInstance()

    • parser

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

    • getParserForType

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