Package grpc.gateway.protoc_gen_openapiv2.options

Class Openapiv2.Header.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Openapiv2.HeaderOrBuilder, java.lang.Cloneable
    Enclosing class:
    Openapiv2.Header
    public static final class Openapiv2.Header.Builder
extends com.google.protobuf.GeneratedMessage.Builder<Openapiv2.Header.Builder>
implements Openapiv2.HeaderOrBuilder
     `Header` is a representation of OpenAPI v2 specification's Header object.

 See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#headerObject
    Protobuf type grpc.gateway.protoc_gen_openapiv2.options.Header

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Openapiv2.Header build()  
      Openapiv2.Header buildPartial()  
      Openapiv2.Header.Builder clear()  
      Openapiv2.Header.Builder clearDefault()
      `Default` Declares the value of the header that the server will use if none is provided.
      Openapiv2.Header.Builder clearDescription()
      `Description` is a short description of the header.
      Openapiv2.Header.Builder clearFormat()
      `Format` The extending format for the previously mentioned type.
      Openapiv2.Header.Builder clearPattern()
      'Pattern' See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3.
      Openapiv2.Header.Builder clearType()
      The type of the object.
      java.lang.String getDefault()
      `Default` Declares the value of the header that the server will use if none is provided.
      com.google.protobuf.ByteString getDefaultBytes()
      `Default` Declares the value of the header that the server will use if none is provided.
      Openapiv2.Header getDefaultInstanceForType()  
      java.lang.String getDescription()
      `Description` is a short description of the header.
      com.google.protobuf.ByteString getDescriptionBytes()
      `Description` is a short description of the header.
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Descriptors.Descriptor getDescriptorForType()  
      java.lang.String getFormat()
      `Format` The extending format for the previously mentioned type.
      com.google.protobuf.ByteString getFormatBytes()
      `Format` The extending format for the previously mentioned type.
      java.lang.String getPattern()
      'Pattern' See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3.
      com.google.protobuf.ByteString getPatternBytes()
      'Pattern' See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3.
      java.lang.String getType()
      The type of the object.
      com.google.protobuf.ByteString getTypeBytes()
      The type of the object.
      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      Openapiv2.Header.Builder mergeFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      Openapiv2.Header.Builder mergeFrom​(com.google.protobuf.Message other)  
      Openapiv2.Header.Builder mergeFrom​(Openapiv2.Header other)  
      Openapiv2.Header.Builder setDefault​(java.lang.String value)
      `Default` Declares the value of the header that the server will use if none is provided.
      Openapiv2.Header.Builder setDefaultBytes​(com.google.protobuf.ByteString value)
      `Default` Declares the value of the header that the server will use if none is provided.
      Openapiv2.Header.Builder setDescription​(java.lang.String value)
      `Description` is a short description of the header.
      Openapiv2.Header.Builder setDescriptionBytes​(com.google.protobuf.ByteString value)
      `Description` is a short description of the header.
      Openapiv2.Header.Builder setFormat​(java.lang.String value)
      `Format` The extending format for the previously mentioned type.
      Openapiv2.Header.Builder setFormatBytes​(com.google.protobuf.ByteString value)
      `Format` The extending format for the previously mentioned type.
      Openapiv2.Header.Builder setPattern​(java.lang.String value)
      'Pattern' See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3.
      Openapiv2.Header.Builder setPatternBytes​(com.google.protobuf.ByteString value)
      'Pattern' See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3.
      Openapiv2.Header.Builder setType​(java.lang.String value)
      The type of the object.
      Openapiv2.Header.Builder setTypeBytes​(com.google.protobuf.ByteString value)
      The type of the object.

      • Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

        addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

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

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

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

        addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

      • Methods inherited from class java.lang.Object

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

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

        mergeDelimitedFrom, mergeDelimitedFrom

      • Methods inherited from interface com.google.protobuf.MessageLite.Builder

        mergeFrom

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

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

      • clear

        public Openapiv2.Header.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.Header.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.Header.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • mergeFrom

        public Openapiv2.Header.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.Header.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.Header.Builder>

      • mergeFrom

        public Openapiv2.Header.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.Header.Builder>
        Throws:
        java.io.IOException

      • getDescription

        public java.lang.String getDescription()
         `Description` is a short description of the header.
        string description = 1;
        Specified by:
        getDescription in interface Openapiv2.HeaderOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         `Description` is a short description of the header.
        string description = 1;
        Specified by:
        getDescriptionBytes in interface Openapiv2.HeaderOrBuilder
        Returns:
        The bytes for description.

      • setDescription

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

      • clearDescription

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

      • setDescriptionBytes

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

      • getType

        public java.lang.String getType()
         The type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported.
        string type = 2;
        Specified by:
        getType in interface Openapiv2.HeaderOrBuilder
        Returns:
        The type.

      • getTypeBytes

        public com.google.protobuf.ByteString getTypeBytes()
         The type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported.
        string type = 2;
        Specified by:
        getTypeBytes in interface Openapiv2.HeaderOrBuilder
        Returns:
        The bytes for type.

      • setType

        public Openapiv2.Header.Builder setType​(java.lang.String value)
         The type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported.
        string type = 2;
        Parameters:
        value - The type to set.
        Returns:
        This builder for chaining.

      • clearType

        public Openapiv2.Header.Builder clearType()
         The type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported.
        string type = 2;
        Returns:
        This builder for chaining.

      • setTypeBytes

        public Openapiv2.Header.Builder setTypeBytes​(com.google.protobuf.ByteString value)
         The type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported.
        string type = 2;
        Parameters:
        value - The bytes for type to set.
        Returns:
        This builder for chaining.

      • getFormat

        public java.lang.String getFormat()
         `Format` The extending format for the previously mentioned type.
        string format = 3;
        Specified by:
        getFormat in interface Openapiv2.HeaderOrBuilder
        Returns:
        The format.

      • getFormatBytes

        public com.google.protobuf.ByteString getFormatBytes()
         `Format` The extending format for the previously mentioned type.
        string format = 3;
        Specified by:
        getFormatBytes in interface Openapiv2.HeaderOrBuilder
        Returns:
        The bytes for format.

      • setFormat

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

      • clearFormat

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

      • setFormatBytes

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

      • getDefault

        public java.lang.String getDefault()
         `Default` Declares the value of the header that the server will use if none is provided.
 See: https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2.
 Unlike JSON Schema this value MUST conform to the defined type for the header.
        string default = 6;
        Specified by:
        getDefault in interface Openapiv2.HeaderOrBuilder
        Returns:
        The default.

      • getDefaultBytes

        public com.google.protobuf.ByteString getDefaultBytes()
         `Default` Declares the value of the header that the server will use if none is provided.
 See: https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2.
 Unlike JSON Schema this value MUST conform to the defined type for the header.
        string default = 6;
        Specified by:
        getDefaultBytes in interface Openapiv2.HeaderOrBuilder
        Returns:
        The bytes for default.

      • setDefault

        public Openapiv2.Header.Builder setDefault​(java.lang.String value)
         `Default` Declares the value of the header that the server will use if none is provided.
 See: https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2.
 Unlike JSON Schema this value MUST conform to the defined type for the header.
        string default = 6;
        Parameters:
        value - The default to set.
        Returns:
        This builder for chaining.

      • clearDefault

        public Openapiv2.Header.Builder clearDefault()
         `Default` Declares the value of the header that the server will use if none is provided.
 See: https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2.
 Unlike JSON Schema this value MUST conform to the defined type for the header.
        string default = 6;
        Returns:
        This builder for chaining.

      • setDefaultBytes

        public Openapiv2.Header.Builder setDefaultBytes​(com.google.protobuf.ByteString value)
         `Default` Declares the value of the header that the server will use if none is provided.
 See: https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2.
 Unlike JSON Schema this value MUST conform to the defined type for the header.
        string default = 6;
        Parameters:
        value - The bytes for default to set.
        Returns:
        This builder for chaining.

      • getPattern

        public java.lang.String getPattern()
         'Pattern' See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3.
        string pattern = 13;
        Specified by:
        getPattern in interface Openapiv2.HeaderOrBuilder
        Returns:
        The pattern.

      • getPatternBytes

        public com.google.protobuf.ByteString getPatternBytes()
         'Pattern' See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3.
        string pattern = 13;
        Specified by:
        getPatternBytes in interface Openapiv2.HeaderOrBuilder
        Returns:
        The bytes for pattern.

      • setPattern

        public Openapiv2.Header.Builder setPattern​(java.lang.String value)
         'Pattern' See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3.
        string pattern = 13;
        Parameters:
        value - The pattern to set.
        Returns:
        This builder for chaining.

      • clearPattern

        public Openapiv2.Header.Builder clearPattern()
         'Pattern' See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3.
        string pattern = 13;
        Returns:
        This builder for chaining.

      • setPatternBytes

        public Openapiv2.Header.Builder setPatternBytes​(com.google.protobuf.ByteString value)
         'Pattern' See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3.
        string pattern = 13;
        Parameters:
        value - The bytes for pattern to set.
        Returns:
        This builder for chaining.