Class Openapiv2.Parameters.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<Openapiv2.Parameters.Builder>
com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Parameters.Builder>
grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Parameters.Builder
- All Implemented Interfaces:
com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Openapiv2.ParametersOrBuilder,Cloneable
- Enclosing class:
Openapiv2.Parameters
public static final class Openapiv2.Parameters.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Parameters.Builder>
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-objectProtobuf type
grpc.gateway.protoc_gen_openapiv2.options.Parameters-
Method Summary
Modifier and TypeMethodDescriptionaddAllHeaders(Iterable<? extends Openapiv2.HeaderParameter> values) `Headers` is one or more HTTP header parameter.addHeaders(int index, Openapiv2.HeaderParameter value) `Headers` is one or more HTTP header parameter.addHeaders(int index, Openapiv2.HeaderParameter.Builder builderForValue) `Headers` is one or more HTTP header parameter.`Headers` is one or more HTTP header parameter.addHeaders(Openapiv2.HeaderParameter.Builder builderForValue) `Headers` is one or more HTTP header parameter.`Headers` is one or more HTTP header parameter.addHeadersBuilder(int index) `Headers` is one or more HTTP header parameter.addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) build()clear()clearField(com.google.protobuf.Descriptors.FieldDescriptor field) `Headers` is one or more HTTP header parameter.clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) clone()static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorgetHeaders(int index) `Headers` is one or more HTTP header parameter.getHeadersBuilder(int index) `Headers` is one or more HTTP header parameter.`Headers` is one or more HTTP header parameter.int`Headers` is one or more HTTP header parameter.`Headers` is one or more HTTP header parameter.getHeadersOrBuilder(int index) `Headers` is one or more HTTP header parameter.List<? extends Openapiv2.HeaderParameterOrBuilder> `Headers` is one or more HTTP header parameter.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanmergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) mergeFrom(Openapiv2.Parameters other) mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) removeHeaders(int index) `Headers` is one or more HTTP header parameter.setHeaders(int index, Openapiv2.HeaderParameter value) `Headers` is one or more HTTP header parameter.setHeaders(int index, Openapiv2.HeaderParameter.Builder builderForValue) `Headers` is one or more HTTP header parameter.setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Parameters.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Parameters.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Parameters.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Parameters.Builder>
-
setField
public Openapiv2.Parameters.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Parameters.Builder>
-
clearField
public Openapiv2.Parameters.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field) - Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Parameters.Builder>
-
clearOneof
public Openapiv2.Parameters.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) - Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Parameters.Builder>
-
setRepeatedField
public Openapiv2.Parameters.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) - Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Parameters.Builder>
-
addRepeatedField
public Openapiv2.Parameters.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Parameters.Builder>
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<Openapiv2.Parameters.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Parameters.Builder>
-
mergeFrom
public Openapiv2.Parameters.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<Openapiv2.Parameters.Builder>- Throws:
IOException
-
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
-
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
`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
-
setHeaders
`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; -
setHeaders
public Openapiv2.Parameters.Builder setHeaders(int index, Openapiv2.HeaderParameter.Builder builderForValue) `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; -
addHeaders
`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; -
addHeaders
`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; -
addHeaders
`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; -
addHeaders
public Openapiv2.Parameters.Builder addHeaders(int index, Openapiv2.HeaderParameter.Builder builderForValue) `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; -
addAllHeaders
public Openapiv2.Parameters.Builder addAllHeaders(Iterable<? extends Openapiv2.HeaderParameter> values) `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; -
clearHeaders
`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; -
removeHeaders
`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; -
getHeadersBuilder
`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; -
getHeadersOrBuilder
`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
-
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
-
addHeadersBuilder
`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; -
addHeadersBuilder
`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; -
getHeadersBuilderList
`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; -
setUnknownFields
public final Openapiv2.Parameters.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Parameters.Builder>
-
mergeUnknownFields
public final Openapiv2.Parameters.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Parameters.Builder>
-