Package grpc.gateway.protoc_gen_swagger.options

Class Openapiv2.JSONSchema.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Openapiv2.JSONSchemaOrBuilder, Cloneable
    Enclosing class:
    Openapiv2.JSONSchema
    public static final class Openapiv2.JSONSchema.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.JSONSchema.Builder>
implements Openapiv2.JSONSchemaOrBuilder
     `JSONSchema` represents properties from JSON Schema taken, and as used, in
 the OpenAPI v2 spec.
 This includes changes made by OpenAPI v2.
 See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject
 See also: https://cswr.github.io/JsonSchema/spec/basic_types/,
 https://github.com/json-schema-org/json-schema-spec/blob/master/schema.json
 Example:
  message SimpleMessage {
    option (grpc.gateway.protoc_gen_swagger.options.openapiv2_schema) = {
      json_schema: {
        title: "SimpleMessage"
        description: "A simple message."
        required: ["id"]
      }
    };
    // Id represents the message identifier.
    string id = 1; [
        (grpc.gateway.protoc_gen_swagger.options.openapiv2_field) = {
          {description: "The unique identifier of the simple message."
        }];
  }
    Protobuf type grpc.gateway.protoc_gen_swagger.options.JSONSchema

    • Field Detail

      • bitField0_

        private int bitField0_

      • title_

        private Object title_

      • description_

        private Object description_

      • default_

        private Object default_

      • readOnly_

        private boolean readOnly_

      • multipleOf_

        private double multipleOf_

      • maximum_

        private double maximum_

      • exclusiveMaximum_

        private boolean exclusiveMaximum_

      • minimum_

        private double minimum_

      • exclusiveMinimum_

        private boolean exclusiveMinimum_

      • maxLength_

        private long maxLength_

      • minLength_

        private long minLength_

      • pattern_

        private Object pattern_

      • maxItems_

        private long maxItems_

      • minItems_

        private long minItems_

      • uniqueItems_

        private boolean uniqueItems_

      • maxProperties_

        private long maxProperties_

      • minProperties_

        private long minProperties_

      • required_

        private com.google.protobuf.LazyStringList required_

      • array_

        private com.google.protobuf.LazyStringList array_

    • Constructor Detail

      • Builder

        private Builder()

      • Builder

        private Builder​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

    • 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<Openapiv2.JSONSchema.Builder>

      • clear

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

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • buildPartialRepeatedFields

        private void buildPartialRepeatedFields​(Openapiv2.JSONSchema result)

      • clone

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

      • setField

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

      • clearField

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

      • clearOneof

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

      • setRepeatedField

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

      • addRepeatedField

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

      • isInitialized

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

      • mergeFrom

        public Openapiv2.JSONSchema.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.JSONSchema.Builder>
        Throws:
        IOException

      • getRef

        public String getRef()
         Ref is used to define an external reference to include in the message.
 This could be a fully qualified proto message reference, and that type must
 be imported into the protofile. If no message is identified, the Ref will
 be used verbatim in the output.
 For example:
  `ref: ".google.protobuf.Timestamp"`.
        string ref = 3;
        Specified by:
        getRef in interface Openapiv2.JSONSchemaOrBuilder
        Returns:
        The ref.

      • getRefBytes

        public com.google.protobuf.ByteString getRefBytes()
         Ref is used to define an external reference to include in the message.
 This could be a fully qualified proto message reference, and that type must
 be imported into the protofile. If no message is identified, the Ref will
 be used verbatim in the output.
 For example:
  `ref: ".google.protobuf.Timestamp"`.
        string ref = 3;
        Specified by:
        getRefBytes in interface Openapiv2.JSONSchemaOrBuilder
        Returns:
        The bytes for ref.

      • setRef

        public Openapiv2.JSONSchema.Builder setRef​(String value)
         Ref is used to define an external reference to include in the message.
 This could be a fully qualified proto message reference, and that type must
 be imported into the protofile. If no message is identified, the Ref will
 be used verbatim in the output.
 For example:
  `ref: ".google.protobuf.Timestamp"`.
        string ref = 3;
        Parameters:
        value - The ref to set.
        Returns:
        This builder for chaining.

      • clearRef

        public Openapiv2.JSONSchema.Builder clearRef()
         Ref is used to define an external reference to include in the message.
 This could be a fully qualified proto message reference, and that type must
 be imported into the protofile. If no message is identified, the Ref will
 be used verbatim in the output.
 For example:
  `ref: ".google.protobuf.Timestamp"`.
        string ref = 3;
        Returns:
        This builder for chaining.

      • setRefBytes

        public Openapiv2.JSONSchema.Builder setRefBytes​(com.google.protobuf.ByteString value)
         Ref is used to define an external reference to include in the message.
 This could be a fully qualified proto message reference, and that type must
 be imported into the protofile. If no message is identified, the Ref will
 be used verbatim in the output.
 For example:
  `ref: ".google.protobuf.Timestamp"`.
        string ref = 3;
        Parameters:
        value - The bytes for ref to set.
        Returns:
        This builder for chaining.

      • getTitleBytes

        public com.google.protobuf.ByteString getTitleBytes()
         The title of the schema.
        string title = 5;
        Specified by:
        getTitleBytes in interface Openapiv2.JSONSchemaOrBuilder
        Returns:
        The bytes for title.

      • setTitle

        public Openapiv2.JSONSchema.Builder setTitle​(String value)
         The title of the schema.
        string title = 5;
        Parameters:
        value - The title to set.
        Returns:
        This builder for chaining.

      • clearTitle

        public Openapiv2.JSONSchema.Builder clearTitle()
         The title of the schema.
        string title = 5;
        Returns:
        This builder for chaining.

      • setTitleBytes

        public Openapiv2.JSONSchema.Builder setTitleBytes​(com.google.protobuf.ByteString value)
         The title of the schema.
        string title = 5;
        Parameters:
        value - The bytes for title to set.
        Returns:
        This builder for chaining.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         A short description of the schema.
        string description = 6;
        Specified by:
        getDescriptionBytes in interface Openapiv2.JSONSchemaOrBuilder
        Returns:
        The bytes for description.

      • setDescription

        public Openapiv2.JSONSchema.Builder setDescription​(String value)
         A short description of the schema.
        string description = 6;
        Parameters:
        value - The description to set.
        Returns:
        This builder for chaining.

      • clearDescription

        public Openapiv2.JSONSchema.Builder clearDescription()
         A short description of the schema.
        string description = 6;
        Returns:
        This builder for chaining.

      • setDescriptionBytes

        public Openapiv2.JSONSchema.Builder setDescriptionBytes​(com.google.protobuf.ByteString value)
         A short description of the schema.
        string description = 6;
        Parameters:
        value - The bytes for description to set.
        Returns:
        This builder for chaining.

      • setDefault

        public Openapiv2.JSONSchema.Builder setDefault​(String value)
        string default = 7;
        Parameters:
        value - The default to set.
        Returns:
        This builder for chaining.

      • setDefaultBytes

        public Openapiv2.JSONSchema.Builder setDefaultBytes​(com.google.protobuf.ByteString value)
        string default = 7;
        Parameters:
        value - The bytes for default to set.
        Returns:
        This builder for chaining.

      • setReadOnly

        public Openapiv2.JSONSchema.Builder setReadOnly​(boolean value)
        bool read_only = 8;
        Parameters:
        value - The readOnly to set.
        Returns:
        This builder for chaining.

      • setMultipleOf

        public Openapiv2.JSONSchema.Builder setMultipleOf​(double value)
        double multiple_of = 10;
        Parameters:
        value - The multipleOf to set.
        Returns:
        This builder for chaining.

      • getMaximum

        public double getMaximum()
         Maximum represents an inclusive upper limit for a numeric instance. The 
 value of MUST be a number,
        double maximum = 11;
        Specified by:
        getMaximum in interface Openapiv2.JSONSchemaOrBuilder
        Returns:
        The maximum.

      • setMaximum

        public Openapiv2.JSONSchema.Builder setMaximum​(double value)
         Maximum represents an inclusive upper limit for a numeric instance. The 
 value of MUST be a number,
        double maximum = 11;
        Parameters:
        value - The maximum to set.
        Returns:
        This builder for chaining.

      • clearMaximum

        public Openapiv2.JSONSchema.Builder clearMaximum()
         Maximum represents an inclusive upper limit for a numeric instance. The 
 value of MUST be a number,
        double maximum = 11;
        Returns:
        This builder for chaining.

      • setExclusiveMaximum

        public Openapiv2.JSONSchema.Builder setExclusiveMaximum​(boolean value)
        bool exclusive_maximum = 12;
        Parameters:
        value - The exclusiveMaximum to set.
        Returns:
        This builder for chaining.

      • clearExclusiveMaximum

        public Openapiv2.JSONSchema.Builder clearExclusiveMaximum()
        bool exclusive_maximum = 12;
        Returns:
        This builder for chaining.

      • getMinimum

        public double getMinimum()
         minimum represents an inclusive lower limit for a numeric instance. The 
 value of MUST be a number,
        double minimum = 13;
        Specified by:
        getMinimum in interface Openapiv2.JSONSchemaOrBuilder
        Returns:
        The minimum.

      • setMinimum

        public Openapiv2.JSONSchema.Builder setMinimum​(double value)
         minimum represents an inclusive lower limit for a numeric instance. The 
 value of MUST be a number,
        double minimum = 13;
        Parameters:
        value - The minimum to set.
        Returns:
        This builder for chaining.

      • clearMinimum

        public Openapiv2.JSONSchema.Builder clearMinimum()
         minimum represents an inclusive lower limit for a numeric instance. The 
 value of MUST be a number,
        double minimum = 13;
        Returns:
        This builder for chaining.

      • setExclusiveMinimum

        public Openapiv2.JSONSchema.Builder setExclusiveMinimum​(boolean value)
        bool exclusive_minimum = 14;
        Parameters:
        value - The exclusiveMinimum to set.
        Returns:
        This builder for chaining.

      • clearExclusiveMinimum

        public Openapiv2.JSONSchema.Builder clearExclusiveMinimum()
        bool exclusive_minimum = 14;
        Returns:
        This builder for chaining.

      • setMaxLength

        public Openapiv2.JSONSchema.Builder setMaxLength​(long value)
        uint64 max_length = 15;
        Parameters:
        value - The maxLength to set.
        Returns:
        This builder for chaining.

      • setMinLength

        public Openapiv2.JSONSchema.Builder setMinLength​(long value)
        uint64 min_length = 16;
        Parameters:
        value - The minLength to set.
        Returns:
        This builder for chaining.

      • setPattern

        public Openapiv2.JSONSchema.Builder setPattern​(String value)
        string pattern = 17;
        Parameters:
        value - The pattern to set.
        Returns:
        This builder for chaining.

      • setPatternBytes

        public Openapiv2.JSONSchema.Builder setPatternBytes​(com.google.protobuf.ByteString value)
        string pattern = 17;
        Parameters:
        value - The bytes for pattern to set.
        Returns:
        This builder for chaining.

      • setMaxItems

        public Openapiv2.JSONSchema.Builder setMaxItems​(long value)
        uint64 max_items = 20;
        Parameters:
        value - The maxItems to set.
        Returns:
        This builder for chaining.

      • setMinItems

        public Openapiv2.JSONSchema.Builder setMinItems​(long value)
        uint64 min_items = 21;
        Parameters:
        value - The minItems to set.
        Returns:
        This builder for chaining.

      • setUniqueItems

        public Openapiv2.JSONSchema.Builder setUniqueItems​(boolean value)
        bool unique_items = 22;
        Parameters:
        value - The uniqueItems to set.
        Returns:
        This builder for chaining.

      • setMaxProperties

        public Openapiv2.JSONSchema.Builder setMaxProperties​(long value)
        uint64 max_properties = 24;
        Parameters:
        value - The maxProperties to set.
        Returns:
        This builder for chaining.

      • clearMaxProperties

        public Openapiv2.JSONSchema.Builder clearMaxProperties()
        uint64 max_properties = 24;
        Returns:
        This builder for chaining.

      • setMinProperties

        public Openapiv2.JSONSchema.Builder setMinProperties​(long value)
        uint64 min_properties = 25;
        Parameters:
        value - The minProperties to set.
        Returns:
        This builder for chaining.

      • clearMinProperties

        public Openapiv2.JSONSchema.Builder clearMinProperties()
        uint64 min_properties = 25;
        Returns:
        This builder for chaining.

      • ensureRequiredIsMutable

        private void ensureRequiredIsMutable()

      • getRequiredList

        public com.google.protobuf.ProtocolStringList getRequiredList()
        repeated string required = 26;
        Specified by:
        getRequiredList in interface Openapiv2.JSONSchemaOrBuilder
        Returns:
        A list containing the required.

      • getRequired

        public String getRequired​(int index)
        repeated string required = 26;
        Specified by:
        getRequired in interface Openapiv2.JSONSchemaOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The required at the given index.

      • getRequiredBytes

        public com.google.protobuf.ByteString getRequiredBytes​(int index)
        repeated string required = 26;
        Specified by:
        getRequiredBytes in interface Openapiv2.JSONSchemaOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the required at the given index.

      • setRequired

        public Openapiv2.JSONSchema.Builder setRequired​(int index,
                                                String value)
        repeated string required = 26;
        Parameters:
        index - The index to set the value at.
        value - The required to set.
        Returns:
        This builder for chaining.

      • addRequired

        public Openapiv2.JSONSchema.Builder addRequired​(String value)
        repeated string required = 26;
        Parameters:
        value - The required to add.
        Returns:
        This builder for chaining.

      • addRequiredBytes

        public Openapiv2.JSONSchema.Builder addRequiredBytes​(com.google.protobuf.ByteString value)
        repeated string required = 26;
        Parameters:
        value - The bytes of the required to add.
        Returns:
        This builder for chaining.

      • ensureArrayIsMutable

        private void ensureArrayIsMutable()

      • getArrayList

        public com.google.protobuf.ProtocolStringList getArrayList()
         Items in 'array' must be unique.
        repeated string array = 34;
        Specified by:
        getArrayList in interface Openapiv2.JSONSchemaOrBuilder
        Returns:
        A list containing the array.

      • getArray

        public String getArray​(int index)
         Items in 'array' must be unique.
        repeated string array = 34;
        Specified by:
        getArray in interface Openapiv2.JSONSchemaOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The array at the given index.

      • getArrayBytes

        public com.google.protobuf.ByteString getArrayBytes​(int index)
         Items in 'array' must be unique.
        repeated string array = 34;
        Specified by:
        getArrayBytes in interface Openapiv2.JSONSchemaOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the array at the given index.

      • setArray

        public Openapiv2.JSONSchema.Builder setArray​(int index,
                                             String value)
         Items in 'array' must be unique.
        repeated string array = 34;
        Parameters:
        index - The index to set the value at.
        value - The array to set.
        Returns:
        This builder for chaining.

      • addArray

        public Openapiv2.JSONSchema.Builder addArray​(String value)
         Items in 'array' must be unique.
        repeated string array = 34;
        Parameters:
        value - The array to add.
        Returns:
        This builder for chaining.

      • addAllArray

        public Openapiv2.JSONSchema.Builder addAllArray​(Iterable<String> values)
         Items in 'array' must be unique.
        repeated string array = 34;
        Parameters:
        values - The array to add.
        Returns:
        This builder for chaining.

      • clearArray

        public Openapiv2.JSONSchema.Builder clearArray()
         Items in 'array' must be unique.
        repeated string array = 34;
        Returns:
        This builder for chaining.

      • addArrayBytes

        public Openapiv2.JSONSchema.Builder addArrayBytes​(com.google.protobuf.ByteString value)
         Items in 'array' must be unique.
        repeated string array = 34;
        Parameters:
        value - The bytes of the array to add.
        Returns:
        This builder for chaining.

      • ensureTypeIsMutable

        private void ensureTypeIsMutable()

      • getTypeCount

        public int getTypeCount()
        repeated .grpc.gateway.protoc_gen_swagger.options.JSONSchema.JSONSchemaSimpleTypes type = 35;
        Specified by:
        getTypeCount in interface Openapiv2.JSONSchemaOrBuilder
        Returns:
        The count of type.

      • clearType

        public Openapiv2.JSONSchema.Builder clearType()
        repeated .grpc.gateway.protoc_gen_swagger.options.JSONSchema.JSONSchemaSimpleTypes type = 35;
        Returns:
        This builder for chaining.

      • getTypeValueList

        public List<Integer> getTypeValueList()
        repeated .grpc.gateway.protoc_gen_swagger.options.JSONSchema.JSONSchemaSimpleTypes type = 35;
        Specified by:
        getTypeValueList in interface Openapiv2.JSONSchemaOrBuilder
        Returns:
        A list containing the enum numeric values on the wire for type.

      • getTypeValue

        public int getTypeValue​(int index)
        repeated .grpc.gateway.protoc_gen_swagger.options.JSONSchema.JSONSchemaSimpleTypes type = 35;
        Specified by:
        getTypeValue in interface Openapiv2.JSONSchemaOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of type at the given index.

      • setTypeValue

        public Openapiv2.JSONSchema.Builder setTypeValue​(int index,
                                                 int value)
        repeated .grpc.gateway.protoc_gen_swagger.options.JSONSchema.JSONSchemaSimpleTypes type = 35;
        Parameters:
        index - The index to set the value at.
        value - The enum numeric value on the wire for type to set.
        Returns:
        This builder for chaining.

      • addTypeValue

        public Openapiv2.JSONSchema.Builder addTypeValue​(int value)
        repeated .grpc.gateway.protoc_gen_swagger.options.JSONSchema.JSONSchemaSimpleTypes type = 35;
        Parameters:
        value - The enum numeric value on the wire for type to add.
        Returns:
        This builder for chaining.

      • addAllTypeValue

        public Openapiv2.JSONSchema.Builder addAllTypeValue​(Iterable<Integer> values)
        repeated .grpc.gateway.protoc_gen_swagger.options.JSONSchema.JSONSchemaSimpleTypes type = 35;
        Parameters:
        values - The enum numeric values on the wire for type to add.
        Returns:
        This builder for chaining.

      • setUnknownFields

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

      • mergeUnknownFields

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