Package grpc.gateway.protoc_gen_openapiv2.options

Class Openapiv2.HeaderParameter

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.HeaderParameter

All Implemented Interfaces:

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

Enclosing class:

Openapiv2

public static final class Openapiv2.HeaderParameter
extends com.google.protobuf.GeneratedMessageV3
implements Openapiv2.HeaderParameterOrBuilder

 `HeaderParameter` a HTTP header parameter.
 See: https://swagger.io/specification/v2/#parameter-object
 

Protobuf type grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Openapiv2.HeaderParameter.Builder	`HeaderParameter` a HTTP header parameter.
static class	Openapiv2.HeaderParameter.Type	`Type` is a a supported HTTP header type.

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	Description
static int	DESCRIPTION_FIELD_NUMBER
static int	FORMAT_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	REQUIRED_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	Description
boolean	equals(java.lang.Object obj)
static Openapiv2.HeaderParameter	getDefaultInstance()
Openapiv2.HeaderParameter	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.
java.lang.String	getName()	`Name` is the header name.
com.google.protobuf.ByteString	getNameBytes()	`Name` is the header name.
com.google.protobuf.Parser<Openapiv2.HeaderParameter>	getParserForType()
boolean	getRequired()	`Required` indicates if the header is optional
int	getSerializedSize()
Openapiv2.HeaderParameter.Type	getType()	`Type` is the type of the object.
int	getTypeValue()	`Type` is the type of the object.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Openapiv2.HeaderParameter.Builder	newBuilder()
static Openapiv2.HeaderParameter.Builder	newBuilder(Openapiv2.HeaderParameter prototype)
Openapiv2.HeaderParameter.Builder	newBuilderForType()
protected Openapiv2.HeaderParameter.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected java.lang.Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Openapiv2.HeaderParameter	parseDelimitedFrom(java.io.InputStream input)
static Openapiv2.HeaderParameter	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Openapiv2.HeaderParameter	parseFrom(byte[] data)
static Openapiv2.HeaderParameter	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Openapiv2.HeaderParameter	parseFrom(com.google.protobuf.ByteString data)
static Openapiv2.HeaderParameter	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Openapiv2.HeaderParameter	parseFrom(com.google.protobuf.CodedInputStream input)
static Openapiv2.HeaderParameter	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Openapiv2.HeaderParameter	parseFrom(java.io.InputStream input)
static Openapiv2.HeaderParameter	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Openapiv2.HeaderParameter	parseFrom(java.nio.ByteBuffer data)
static Openapiv2.HeaderParameter	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Openapiv2.HeaderParameter>	parser()
Openapiv2.HeaderParameter.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

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

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.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

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

REQUIRED_FIELD_NUMBER

public static final int REQUIRED_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

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

getName

public java.lang.String getName()

 `Name` is the header name.
 

string name = 1;

Specified by:

getName in interface Openapiv2.HeaderParameterOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 `Name` is the header name.
 

string name = 1;

Specified by:

getNameBytes in interface Openapiv2.HeaderParameterOrBuilder

Returns:

The bytes for name.

getDescription

public java.lang.String getDescription()

 `Description` is a short description of the header.
 

string description = 2;

Specified by:

getDescription in interface Openapiv2.HeaderParameterOrBuilder

Returns:

The description.

getDescriptionBytes

public com.google.protobuf.ByteString getDescriptionBytes()

 `Description` is a short description of the header.
 

string description = 2;

Specified by:

getDescriptionBytes in interface Openapiv2.HeaderParameterOrBuilder

Returns:

The bytes for description.

getTypeValue

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

Specified by:

getTypeValue in interface Openapiv2.HeaderParameterOrBuilder

Returns:

The enum numeric value on the wire for type.

getType

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

Specified by:

getType in interface Openapiv2.HeaderParameterOrBuilder

Returns:

The type.

getFormat

public java.lang.String getFormat()

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

string format = 4;

Specified by:

getFormat in interface Openapiv2.HeaderParameterOrBuilder

Returns:

The format.

getFormatBytes

public com.google.protobuf.ByteString getFormatBytes()

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

string format = 4;

Specified by:

getFormatBytes in interface Openapiv2.HeaderParameterOrBuilder

Returns:

The bytes for format.

getRequired

public boolean getRequired()

 `Required` indicates if the header is optional
 

bool required = 5;

Specified by:

getRequired in interface Openapiv2.HeaderParameterOrBuilder

Returns:

The required.

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

newBuilderForType

public Openapiv2.HeaderParameter.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Openapiv2.HeaderParameter.Builder newBuilder()

newBuilder

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

toBuilder

public Openapiv2.HeaderParameter.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Openapiv2.HeaderParameter getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder