com.grpc.gateway.protoc_gen_openapiv2.options

Interface HeaderParameterOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

HeaderParameter, HeaderParameter.Builder

public interface HeaderParameterOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() `Description` is a short description of the header.
com.google.protobuf.ByteString	getDescriptionBytes() `Description` is a short description of the header.
java.lang.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.
java.lang.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
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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

java.lang.String getName()

 `Name` is the header name.
 

string name = 1 [json_name = "name"];

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 `Name` is the header name.
 

string name = 1 [json_name = "name"];

Returns:

The bytes for name.

getDescription

java.lang.String getDescription()

 `Description` is a short description of the header.
 

string description = 2 [json_name = "description"];

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

 `Description` is a short description of the header.
 

string description = 2 [json_name = "description"];

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 [json_name = "type"];

Returns:

The enum numeric value on the wire for type.

getType

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 [json_name = "type"];

Returns:

The type.

getFormat

java.lang.String getFormat()

 `Format` The extending format for the previously mentioned type.
 

string format = 4 [json_name = "format"];

Returns:

The format.

getFormatBytes

com.google.protobuf.ByteString getFormatBytes()

 `Format` The extending format for the previously mentioned type.
 

string format = 4 [json_name = "format"];

Returns:

The bytes for format.

getRequired

boolean getRequired()

 `Required` indicates if the header is optional
 

bool required = 5 [json_name = "required"];

Returns:

The required.