Class Openapiv2.Parameters
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessage
-
- grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Parameters
-
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Openapiv2.ParametersOrBuilder,java.io.Serializable
- Enclosing class:
- Openapiv2
public static final class Openapiv2.Parameters extends com.google.protobuf.GeneratedMessage implements Openapiv2.ParametersOrBuilder
`Parameters` is a representation of OpenAPI v2 specification's parameters object. Note: This technically breaks compatibility with the OpenAPI 2 definition structure as we only allow header parameters to be set here since we do not want users specifying custom non-header parameters beyond those inferred from the Protobuf schema. See: https://swagger.io/specification/v2/#parameter-object
Protobuf typegrpc.gateway.protoc_gen_openapiv2.options.Parameters- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classOpenapiv2.Parameters.Builder`Parameters` is a representation of OpenAPI v2 specification's parameters object.-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static intHEADERS_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(java.lang.Object obj)static Openapiv2.ParametersgetDefaultInstance()Openapiv2.ParametersgetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()Openapiv2.HeaderParametergetHeaders(int index)`Headers` is one or more HTTP header parameter.intgetHeadersCount()`Headers` is one or more HTTP header parameter.java.util.List<Openapiv2.HeaderParameter>getHeadersList()`Headers` is one or more HTTP header parameter.Openapiv2.HeaderParameterOrBuildergetHeadersOrBuilder(int index)`Headers` is one or more HTTP header parameter.java.util.List<? extends Openapiv2.HeaderParameterOrBuilder>getHeadersOrBuilderList()`Headers` is one or more HTTP header parameter.com.google.protobuf.Parser<Openapiv2.Parameters>getParserForType()intgetSerializedSize()inthashCode()protected com.google.protobuf.GeneratedMessage.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()static Openapiv2.Parameters.BuildernewBuilder()static Openapiv2.Parameters.BuildernewBuilder(Openapiv2.Parameters prototype)Openapiv2.Parameters.BuildernewBuilderForType()protected Openapiv2.Parameters.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)static Openapiv2.ParametersparseDelimitedFrom(java.io.InputStream input)static Openapiv2.ParametersparseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static Openapiv2.ParametersparseFrom(byte[] data)static Openapiv2.ParametersparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static Openapiv2.ParametersparseFrom(com.google.protobuf.ByteString data)static Openapiv2.ParametersparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static Openapiv2.ParametersparseFrom(com.google.protobuf.CodedInputStream input)static Openapiv2.ParametersparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static Openapiv2.ParametersparseFrom(java.io.InputStream input)static Openapiv2.ParametersparseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static Openapiv2.ParametersparseFrom(java.nio.ByteBuffer data)static Openapiv2.ParametersparseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static com.google.protobuf.Parser<Openapiv2.Parameters>parser()Openapiv2.Parameters.BuildertoBuilder()voidwriteTo(com.google.protobuf.CodedOutputStream output)-
Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
HEADERS_FIELD_NUMBER
public static final int HEADERS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
getHeadersList
public java.util.List<Openapiv2.HeaderParameter> getHeadersList()
`Headers` is one or more HTTP header parameter. See: https://swagger.io/docs/specification/2-0/describing-parameters/#header-parameters
repeated .grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter headers = 1;- Specified by:
getHeadersListin interfaceOpenapiv2.ParametersOrBuilder
-
getHeadersOrBuilderList
public java.util.List<? extends Openapiv2.HeaderParameterOrBuilder> getHeadersOrBuilderList()
`Headers` is one or more HTTP header parameter. See: https://swagger.io/docs/specification/2-0/describing-parameters/#header-parameters
repeated .grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter headers = 1;- Specified by:
getHeadersOrBuilderListin interfaceOpenapiv2.ParametersOrBuilder
-
getHeadersCount
public int getHeadersCount()
`Headers` is one or more HTTP header parameter. See: https://swagger.io/docs/specification/2-0/describing-parameters/#header-parameters
repeated .grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter headers = 1;- Specified by:
getHeadersCountin interfaceOpenapiv2.ParametersOrBuilder
-
getHeaders
public Openapiv2.HeaderParameter getHeaders(int index)
`Headers` is one or more HTTP header parameter. See: https://swagger.io/docs/specification/2-0/describing-parameters/#header-parameters
repeated .grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter headers = 1;- Specified by:
getHeadersin interfaceOpenapiv2.ParametersOrBuilder
-
getHeadersOrBuilder
public Openapiv2.HeaderParameterOrBuilder getHeadersOrBuilder(int index)
`Headers` is one or more HTTP header parameter. See: https://swagger.io/docs/specification/2-0/describing-parameters/#header-parameters
repeated .grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter headers = 1;- Specified by:
getHeadersOrBuilderin interfaceOpenapiv2.ParametersOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
java.io.IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
public boolean equals(java.lang.Object obj)
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Openapiv2.Parameters parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Openapiv2.Parameters parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Openapiv2.Parameters parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Openapiv2.Parameters 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.Parameters parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Openapiv2.Parameters parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Openapiv2.Parameters parseFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Openapiv2.Parameters parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static Openapiv2.Parameters parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static Openapiv2.Parameters parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Openapiv2.Parameters parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Openapiv2.Parameters parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
newBuilderForType
public Openapiv2.Parameters.Builder newBuilderForType()
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
public static Openapiv2.Parameters.Builder newBuilder()
-
newBuilder
public static Openapiv2.Parameters.Builder newBuilder(Openapiv2.Parameters prototype)
-
toBuilder
public Openapiv2.Parameters.Builder toBuilder()
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Openapiv2.Parameters.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
- Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
public static Openapiv2.Parameters getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<Openapiv2.Parameters> parser()
-
getParserForType
public com.google.protobuf.Parser<Openapiv2.Parameters> getParserForType()
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
public Openapiv2.Parameters getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
-