grpc.gateway.protoc_gen_openapiv2.options

Class Openapiv2.Header

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Header

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Openapiv2.HeaderOrBuilder, java.io.Serializable

Enclosing class:

Openapiv2

public static final class Openapiv2.Header
extends com.google.protobuf.GeneratedMessageV3
implements Openapiv2.HeaderOrBuilder

 `Header` is a representation of OpenAPI v2 specification's Header object.
 See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#headerObject
 

Protobuf type grpc.gateway.protoc_gen_openapiv2.options.Header

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Openapiv2.Header.Builder `Header` is a representation of OpenAPI v2 specification's Header object.

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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 and Description
static int	DEFAULT_FIELD_NUMBER
static int	DESCRIPTION_FIELD_NUMBER
static int	FORMAT_FIELD_NUMBER
static int	PATTERN_FIELD_NUMBER
static int	TYPE_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 and Description
boolean	equals(java.lang.Object obj)
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.
static Openapiv2.Header	getDefaultInstance()
Openapiv2.Header	getDefaultInstanceForType()
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.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.Parser<Openapiv2.Header>	getParserForType()
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.
int	getSerializedSize()
java.lang.String	getType() The type of the object.
com.google.protobuf.ByteString	getTypeBytes() The type of the object.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Openapiv2.Header.Builder	newBuilder()
static Openapiv2.Header.Builder	newBuilder(Openapiv2.Header prototype)
Openapiv2.Header.Builder	newBuilderForType()
protected Openapiv2.Header.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected java.lang.Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Openapiv2.Header	parseDelimitedFrom(java.io.InputStream input)
static Openapiv2.Header	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Openapiv2.Header	parseFrom(byte[] data)
static Openapiv2.Header	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Openapiv2.Header	parseFrom(java.nio.ByteBuffer data)
static Openapiv2.Header	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Openapiv2.Header	parseFrom(com.google.protobuf.ByteString data)
static Openapiv2.Header	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Openapiv2.Header	parseFrom(com.google.protobuf.CodedInputStream input)
static Openapiv2.Header	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Openapiv2.Header	parseFrom(java.io.InputStream input)
static Openapiv2.Header	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Openapiv2.Header>	parser()
Openapiv2.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, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

See Also:

Constant Field Values

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER

See Also:

Constant Field Values

FORMAT_FIELD_NUMBER

public static final int FORMAT_FIELD_NUMBER

See Also:

Constant Field Values

DEFAULT_FIELD_NUMBER

public static final int DEFAULT_FIELD_NUMBER

See Also:

Constant Field Values

PATTERN_FIELD_NUMBER

public static final int PATTERN_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected java.lang.Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields 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 java.lang.String getDescription()

 `Description` is a short description of the header.
 

string description = 1;

Specified by:

getDescription in interface Openapiv2.HeaderOrBuilder

Returns:

The description.

getDescriptionBytes

public com.google.protobuf.ByteString getDescriptionBytes()

 `Description` is a short description of the header.
 

string description = 1;

Specified by:

getDescriptionBytes in interface Openapiv2.HeaderOrBuilder

Returns:

The bytes for description.

getType

public 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;

Specified by:

getType in interface Openapiv2.HeaderOrBuilder

Returns:

The type.

getTypeBytes

public 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;

Specified by:

getTypeBytes in interface Openapiv2.HeaderOrBuilder

Returns:

The bytes for type.

getFormat

public java.lang.String getFormat()

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

string format = 3;

Specified by:

getFormat in interface Openapiv2.HeaderOrBuilder

Returns:

The format.

getFormatBytes

public com.google.protobuf.ByteString getFormatBytes()

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

string format = 3;

Specified by:

getFormatBytes in interface Openapiv2.HeaderOrBuilder

Returns:

The bytes for format.

getDefault

public 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;

Specified by:

getDefault in interface Openapiv2.HeaderOrBuilder

Returns:

The default.

getDefaultBytes

public 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;

Specified by:

getDefaultBytes in interface Openapiv2.HeaderOrBuilder

Returns:

The bytes for default.

getPattern

public java.lang.String getPattern()

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

string pattern = 13;

Specified by:

getPattern in interface Openapiv2.HeaderOrBuilder

Returns:

The pattern.

getPatternBytes

public 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;

Specified by:

getPatternBytes in interface Openapiv2.HeaderOrBuilder

Returns:

The bytes for pattern.

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 java.io.IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

java.io.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(java.lang.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.Header parseFrom(java.nio.ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Openapiv2.Header parseFrom(java.nio.ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Openapiv2.Header parseFrom(java.io.InputStream input)
                                  throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Openapiv2.Header parseFrom(java.io.InputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Openapiv2.Header parseDelimitedFrom(java.io.InputStream input)
                                           throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Openapiv2.Header parseDelimitedFrom(java.io.InputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Openapiv2.Header parseFrom(com.google.protobuf.CodedInputStream input)
                                  throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Openapiv2.Header parseFrom(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public Openapiv2.Header.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Openapiv2.Header.Builder newBuilder()

newBuilder

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

toBuilder

public Openapiv2.Header.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Openapiv2.Header.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Openapiv2.Header getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<Openapiv2.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 Openapiv2.Header getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder