Class Openapiv2.Parameters.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.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.GeneratedMessage.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-object
 
Protobuf type grpc.gateway.protoc_gen_openapiv2.options.Parameters
  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Openapiv2.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.GeneratedMessage.Builder<Openapiv2.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.GeneratedMessage.Builder<Openapiv2.Parameters.Builder>
    • getDefaultInstanceForType

      public Openapiv2.Parameters getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
    • build

      public Openapiv2.Parameters build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder
    • buildPartial

      public Openapiv2.Parameters buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder
    • mergeFrom

      public Openapiv2.Parameters.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Openapiv2.Parameters.Builder>
    • mergeFrom

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Openapiv2.Parameters.Builder>
    • mergeFrom

      public Openapiv2.Parameters.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Openapiv2.Parameters.Builder>
      Throws:
      IOException
    • getHeadersList

      public 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:
      getHeadersList in interface Openapiv2.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:
      getHeadersCount in interface Openapiv2.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:
      getHeaders in interface Openapiv2.ParametersOrBuilder
    • setHeaders

      public Openapiv2.Parameters.Builder setHeaders(int index, Openapiv2.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;
    • 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

      public Openapiv2.Parameters.Builder addHeaders(int index, Openapiv2.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;
    • 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

      public Openapiv2.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;
    • removeHeaders

      public Openapiv2.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;
    • getHeadersBuilder

      public Openapiv2.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;
    • 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:
      getHeadersOrBuilder in interface Openapiv2.ParametersOrBuilder
    • getHeadersOrBuilderList

      public 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:
      getHeadersOrBuilderList in interface Openapiv2.ParametersOrBuilder
    • addHeadersBuilder

      public Openapiv2.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;
    • addHeadersBuilder

      public Openapiv2.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;
    • getHeadersBuilderList

      public List<Openapiv2.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;