com.grpc.gateway.protoc_gen_openapiv2.options

Class Header

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.grpc.gateway.protoc_gen_openapiv2.options.Header

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, HeaderOrBuilder, Serializable

public final class Header
extends com.google.protobuf.GeneratedMessageV3
implements 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	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<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, 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
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 Header	getDefaultInstance()
Header	getDefaultInstanceForType()
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()
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<Header>	getParserForType()
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.
String	getType() The type of the object.
com.google.protobuf.ByteString	getTypeBytes() The type of the object.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
static Header.Builder	newBuilder()
static Header.Builder	newBuilder(Header prototype)
Header.Builder	newBuilderForType()
protected Header.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Header	parseDelimitedFrom(InputStream input)
static Header	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Header	parseFrom(byte[] data)
static Header	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Header	parseFrom(ByteBuffer data)
static Header	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Header	parseFrom(com.google.protobuf.ByteString data)
static Header	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Header	parseFrom(com.google.protobuf.CodedInputStream input)
static Header	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Header	parseFrom(InputStream input)
static Header	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Header>	parser()
Header.Builder	toBuilder()

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getSerializedSize, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isInitialized, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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, writeTo

Methods inherited from class com.google.protobuf.AbstractMessage

equals, findInitializationErrors, getInitializationErrorString, hashBoolean, hashCode, 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, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

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 Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance 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 String getDescription()

 `Description` is a short description of the header.
 

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

Specified by:

getDescription in interface HeaderOrBuilder

Returns:

The description.

getDescriptionBytes

public com.google.protobuf.ByteString getDescriptionBytes()

 `Description` is a short description of the header.
 

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

Specified by:

getDescriptionBytes in interface HeaderOrBuilder

Returns:

The bytes for description.

getType

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

Specified by:

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

Specified by:

getTypeBytes in interface HeaderOrBuilder

Returns:

The bytes for type.

getFormat

public String getFormat()

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

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

Specified by:

getFormat in interface HeaderOrBuilder

Returns:

The format.

getFormatBytes

public com.google.protobuf.ByteString getFormatBytes()

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

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

Specified by:

getFormatBytes in interface HeaderOrBuilder

Returns:

The bytes for format.

getDefault

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

Specified by:

getDefault in interface 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 [json_name = "default"];

Specified by:

getDefaultBytes in interface HeaderOrBuilder

Returns:

The bytes for default.

getPattern

public String getPattern()

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

string pattern = 13 [json_name = "pattern"];

Specified by:

getPattern in interface 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 [json_name = "pattern"];

Specified by:

getPatternBytes in interface HeaderOrBuilder

Returns:

The bytes for pattern.

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Header parseFrom(InputStream input)
                        throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static Header parseDelimitedFrom(InputStream input)
                                 throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Header.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Header.Builder newBuilder()

newBuilder

public static Header.Builder newBuilder(Header prototype)

toBuilder

public Header.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Header getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder