com.grpc.gateway.protoc_gen_openapiv2.options

Class Parameters.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<Parameters.Builder>

com.grpc.gateway.protoc_gen_openapiv2.options.Parameters.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ParametersOrBuilder, Cloneable

Enclosing class:

Parameters

public static final class Parameters.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Parameters.Builder>
implements 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 type grpc.gateway.protoc_gen_openapiv2.options.Parameters

Method Summary

Modifier and Type	Method and Description
Parameters.Builder	addAllHeaders(Iterable<? extends HeaderParameter> values) `Headers` is one or more HTTP header parameter.
Parameters.Builder	addHeaders(HeaderParameter.Builder builderForValue) `Headers` is one or more HTTP header parameter.
Parameters.Builder	addHeaders(HeaderParameter value) `Headers` is one or more HTTP header parameter.
Parameters.Builder	addHeaders(int index, HeaderParameter.Builder builderForValue) `Headers` is one or more HTTP header parameter.
Parameters.Builder	addHeaders(int index, HeaderParameter value) `Headers` is one or more HTTP header parameter.
HeaderParameter.Builder	addHeadersBuilder() `Headers` is one or more HTTP header parameter.
HeaderParameter.Builder	addHeadersBuilder(int index) `Headers` is one or more HTTP header parameter.
Parameters.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Parameters	build()
Parameters	buildPartial()
Parameters.Builder	clear()
Parameters.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Parameters.Builder	clearHeaders() `Headers` is one or more HTTP header parameter.
Parameters.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Parameters.Builder	clone()
Parameters	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
HeaderParameter	getHeaders(int index) `Headers` is one or more HTTP header parameter.
HeaderParameter.Builder	getHeadersBuilder(int index) `Headers` is one or more HTTP header parameter.
List<HeaderParameter.Builder>	getHeadersBuilderList() `Headers` is one or more HTTP header parameter.
int	getHeadersCount() `Headers` is one or more HTTP header parameter.
List<HeaderParameter>	getHeadersList() `Headers` is one or more HTTP header parameter.
HeaderParameterOrBuilder	getHeadersOrBuilder(int index) `Headers` is one or more HTTP header parameter.
List<? extends HeaderParameterOrBuilder>	getHeadersOrBuilderList() `Headers` is one or more HTTP header parameter.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
Parameters.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Parameters.Builder	removeHeaders(int index) `Headers` is one or more HTTP header parameter.
Parameters.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Parameters.Builder	setHeaders(int index, HeaderParameter.Builder builderForValue) `Headers` is one or more HTTP header parameter.
Parameters.Builder	setHeaders(int index, HeaderParameter value) `Headers` is one or more HTTP header parameter.
Parameters.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
Parameters.Builder	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, isInitialized, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

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.Builder<Parameters.Builder>

clear

public Parameters.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<Parameters.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Parameters.Builder>

getDefaultInstanceForType

public Parameters getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Parameters build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Parameters buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public Parameters.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Parameters.Builder>

setField

public Parameters.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                   Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<Parameters.Builder>

clearField

public Parameters.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Parameters.Builder>

clearOneof

public Parameters.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Parameters.Builder>

setRepeatedField

public Parameters.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                           int index,
                                           Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Parameters.Builder>

addRepeatedField

public Parameters.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                           Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Parameters.Builder>

getHeadersList

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

Specified by:

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

Specified by:

getHeadersCount in interface ParametersOrBuilder

getHeaders

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

Specified by:

getHeaders in interface ParametersOrBuilder

setHeaders

public Parameters.Builder setHeaders(int index,
                                     HeaderParameter value)

 `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 [json_name = "headers"];

setHeaders

public Parameters.Builder setHeaders(int index,
                                     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 [json_name = "headers"];

addHeaders

public Parameters.Builder addHeaders(HeaderParameter value)

 `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 [json_name = "headers"];

addHeaders

public Parameters.Builder addHeaders(int index,
                                     HeaderParameter value)

 `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 [json_name = "headers"];

addHeaders

public Parameters.Builder addHeaders(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 [json_name = "headers"];

addHeaders

public Parameters.Builder addHeaders(int index,
                                     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 [json_name = "headers"];

addAllHeaders

public Parameters.Builder addAllHeaders(Iterable<? extends 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 [json_name = "headers"];

clearHeaders

public Parameters.Builder 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 [json_name = "headers"];

removeHeaders

public Parameters.Builder removeHeaders(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 [json_name = "headers"];

getHeadersBuilder

public HeaderParameter.Builder getHeadersBuilder(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 [json_name = "headers"];

getHeadersOrBuilder

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

Specified by:

getHeadersOrBuilder in interface ParametersOrBuilder

getHeadersOrBuilderList

public List<? extends 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 [json_name = "headers"];

Specified by:

getHeadersOrBuilderList in interface ParametersOrBuilder

addHeadersBuilder

public HeaderParameter.Builder 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 [json_name = "headers"];

addHeadersBuilder

public HeaderParameter.Builder addHeadersBuilder(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 [json_name = "headers"];

getHeadersBuilderList

public List<HeaderParameter.Builder> 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 [json_name = "headers"];

setUnknownFields

public final Parameters.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Parameters.Builder>

mergeUnknownFields

public final Parameters.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Parameters.Builder>