Package grpc.gateway.protoc_gen_openapiv2.options

Class Openapiv2.HeaderParameter.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Openapiv2.HeaderParameterOrBuilder, java.lang.Cloneable
    Enclosing class:
    Openapiv2.HeaderParameter
    public static final class Openapiv2.HeaderParameter.Builder
extends com.google.protobuf.GeneratedMessage.Builder<Openapiv2.HeaderParameter.Builder>
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

    • Method Detail

      • 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.HeaderParameter.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.HeaderParameter.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • isInitialized

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

      • mergeFrom

        public Openapiv2.HeaderParameter.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws java.io.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.HeaderParameter.Builder>
        Throws:
        java.io.IOException

      • setName

        public Openapiv2.HeaderParameter.Builder setName​(java.lang.String value)
         `Name` is the header name.
        string name = 1;
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.

      • setNameBytes

        public Openapiv2.HeaderParameter.Builder setNameBytes​(com.google.protobuf.ByteString value)
         `Name` is the header name.
        string name = 1;
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

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

      • setDescription

        public Openapiv2.HeaderParameter.Builder setDescription​(java.lang.String value)
         `Description` is a short description of the header.
        string description = 2;
        Parameters:
        value - The description to set.
        Returns:
        This builder for chaining.

      • clearDescription

        public Openapiv2.HeaderParameter.Builder clearDescription()
         `Description` is a short description of the header.
        string description = 2;
        Returns:
        This builder for chaining.

      • setDescriptionBytes

        public Openapiv2.HeaderParameter.Builder setDescriptionBytes​(com.google.protobuf.ByteString value)
         `Description` is a short description of the header.
        string description = 2;
        Parameters:
        value - The bytes for description to set.
        Returns:
        This builder for chaining.

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

      • setTypeValue

        public Openapiv2.HeaderParameter.Builder setTypeValue​(int value)
         `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;
        Parameters:
        value - The enum numeric value on the wire for type to set.
        Returns:
        This builder for chaining.

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

      • setType

        public Openapiv2.HeaderParameter.Builder setType​(Openapiv2.HeaderParameter.Type value)
         `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;
        Parameters:
        value - The type to set.
        Returns:
        This builder for chaining.

      • clearType

        public Openapiv2.HeaderParameter.Builder clearType()
         `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;
        Returns:
        This builder for chaining.

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

      • setFormat

        public Openapiv2.HeaderParameter.Builder setFormat​(java.lang.String value)
         `Format` The extending format for the previously mentioned type.
        string format = 4;
        Parameters:
        value - The format to set.
        Returns:
        This builder for chaining.

      • clearFormat

        public Openapiv2.HeaderParameter.Builder clearFormat()
         `Format` The extending format for the previously mentioned type.
        string format = 4;
        Returns:
        This builder for chaining.

      • setFormatBytes

        public Openapiv2.HeaderParameter.Builder setFormatBytes​(com.google.protobuf.ByteString value)
         `Format` The extending format for the previously mentioned type.
        string format = 4;
        Parameters:
        value - The bytes for format to set.
        Returns:
        This builder for chaining.

      • setRequired

        public Openapiv2.HeaderParameter.Builder setRequired​(boolean value)
         `Required` indicates if the header is optional
        bool required = 5;
        Parameters:
        value - The required to set.
        Returns:
        This builder for chaining.

      • clearRequired

        public Openapiv2.HeaderParameter.Builder clearRequired()
         `Required` indicates if the header is optional
        bool required = 5;
        Returns:
        This builder for chaining.