grpc.gateway.protoc_gen_openapiv2.options

Interface Openapiv2.HeaderOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

Openapiv2.Header, Openapiv2.Header.Builder

Enclosing class:

Openapiv2

public static interface Openapiv2.HeaderOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
java.lang.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.
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	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.
java.lang.String	getType() The type of the object.
com.google.protobuf.ByteString	getTypeBytes() 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

getDescription

java.lang.String getDescription()

 `Description` is a short description of the header.
 

string description = 1;

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

 `Description` is a short description of the header.
 

string description = 1;

Returns:

The bytes for description.

getType

java.lang.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;

Returns:

The type.

getTypeBytes

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;

Returns:

The bytes for type.

getFormat

java.lang.String getFormat()

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

string format = 3;

Returns:

The format.

getFormatBytes

com.google.protobuf.ByteString getFormatBytes()

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

string format = 3;

Returns:

The bytes for format.

getDefault

java.lang.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;

Returns:

The default.

getDefaultBytes

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;

Returns:

The bytes for default.

getPattern

java.lang.String getPattern()

 'Pattern' See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3.
 

string pattern = 13;

Returns:

The pattern.

getPatternBytes

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;

Returns:

The bytes for pattern.