Package grpc.gateway.protoc_gen_openapiv2.options

Interface Openapiv2.HeaderParameterOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Openapiv2.HeaderParameter, Openapiv2.HeaderParameter.Builder
Enclosing class:
Openapiv2
public static interface Openapiv2.HeaderParameterOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    `Description` is a short description of the header.
    com.google.protobuf.ByteString
    getDescriptionBytes()
    `Description` is a short description of the header.
    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.
    String
    getName()
    `Name` is the header name.
    com.google.protobuf.ByteString
    getNameBytes()
    `Name` is the header name.
    boolean
    getRequired()
    `Required` indicates if the header is optional
    Openapiv2.HeaderParameter.Type
    getType()
    `Type` is the type of the object.
    int
    getTypeValue()
    `Type` is the type of the object.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getName

      String getName()
       `Name` is the header name.
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       `Name` is the header name.
      string name = 1;
      Returns:
      The bytes for name.

    • getDescription

      String getDescription()
       `Description` is a short description of the header.
      string description = 2;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       `Description` is a short description of the header.
      string description = 2;
      Returns:
      The bytes for description.

    • getTypeValue

      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;
      Returns:
      The enum numeric value on the wire for type.

    • getType

      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;
      Returns:
      The type.

    • getFormat

      String getFormat()
       `Format` The extending format for the previously mentioned type.
      string format = 4;
      Returns:
      The format.

    • getFormatBytes

      com.google.protobuf.ByteString getFormatBytes()
       `Format` The extending format for the previously mentioned type.
      string format = 4;
      Returns:
      The bytes for format.

    • getRequired

      boolean getRequired()
       `Required` indicates if the header is optional
      bool required = 5;
      Returns:
      The required.