Package grpc.gateway.protoc_gen_openapiv2.options

Class Openapiv2.JSONSchema.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Openapiv2.JSONSchema.Builder>
grpc.gateway.protoc_gen_openapiv2.options.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.GeneratedMessage.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_openapiv2.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_openapiv2.options.openapiv2_field) = {
 description: "The unique identifier of the simple message."
 }];
 }
Protobuf type grpc.gateway.protoc_gen_openapiv2.options.JSONSchema

  • Method Details

    • getDescriptor

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

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<Openapiv2.JSONSchema.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<Openapiv2.JSONSchema.Builder>

    • internalGetFieldAccessorTable

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

    • mergeFrom

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

    • mergeFrom

      public Openapiv2.JSONSchema.Builder mergeFrom(Openapiv2.JSONSchema other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.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.

    • getTitle

      public String getTitle()
       The title of the schema.
      string title = 5;
      Specified by:
      getTitle in interface Openapiv2.JSONSchemaOrBuilder
      Returns:
      The title.

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

    • getDescription

      public String getDescription()
       A short description of the schema.
      string description = 6;
      Specified by:
      getDescription in interface Openapiv2.JSONSchemaOrBuilder
      Returns:
      The description.

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

    • getDefault

      public String getDefault()
      string default = 7;
      Specified by:
      getDefault in interface Openapiv2.JSONSchemaOrBuilder
      Returns:
      The default.

    • getDefaultBytes

      public com.google.protobuf.ByteString getDefaultBytes()
      string default = 7;
      Specified by:
      getDefaultBytes in interface Openapiv2.JSONSchemaOrBuilder
      Returns:
      The bytes for default.

    • setDefault

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

    • clearDefault

      public Openapiv2.JSONSchema.Builder clearDefault()
      string default = 7;
      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.

    • getReadOnly

      public boolean getReadOnly()
      bool read_only = 8;
      Specified by:
      getReadOnly in interface Openapiv2.JSONSchemaOrBuilder
      Returns:
      The readOnly.

    • setReadOnly

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

    • clearReadOnly

      public Openapiv2.JSONSchema.Builder clearReadOnly()
      bool read_only = 8;
      Returns:
      This builder for chaining.

    • getExample

      public String getExample()
       A free-form property to include a JSON example of this field. This is copied
 verbatim to the output swagger.json. Quotes must be escaped.
 This property is the same for 2.0 and 3.0.0 https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/3.0.0.md#schemaObject  https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject
      string example = 9;
      Specified by:
      getExample in interface Openapiv2.JSONSchemaOrBuilder
      Returns:
      The example.

    • getExampleBytes

      public com.google.protobuf.ByteString getExampleBytes()
       A free-form property to include a JSON example of this field. This is copied
 verbatim to the output swagger.json. Quotes must be escaped.
 This property is the same for 2.0 and 3.0.0 https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/3.0.0.md#schemaObject  https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject
      string example = 9;
      Specified by:
      getExampleBytes in interface Openapiv2.JSONSchemaOrBuilder
      Returns:
      The bytes for example.

    • setExample

      public Openapiv2.JSONSchema.Builder setExample(String value)
       A free-form property to include a JSON example of this field. This is copied
 verbatim to the output swagger.json. Quotes must be escaped.
 This property is the same for 2.0 and 3.0.0 https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/3.0.0.md#schemaObject  https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject
      string example = 9;
      Parameters:
      value - The example to set.
      Returns:
      This builder for chaining.

    • clearExample

      public Openapiv2.JSONSchema.Builder clearExample()
       A free-form property to include a JSON example of this field. This is copied
 verbatim to the output swagger.json. Quotes must be escaped.
 This property is the same for 2.0 and 3.0.0 https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/3.0.0.md#schemaObject  https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject
      string example = 9;
      Returns:
      This builder for chaining.

    • setExampleBytes

      public Openapiv2.JSONSchema.Builder setExampleBytes(com.google.protobuf.ByteString value)
       A free-form property to include a JSON example of this field. This is copied
 verbatim to the output swagger.json. Quotes must be escaped.
 This property is the same for 2.0 and 3.0.0 https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/3.0.0.md#schemaObject  https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject
      string example = 9;
      Parameters:
      value - The bytes for example to set.
      Returns:
      This builder for chaining.

    • getMultipleOf

      public double getMultipleOf()
      double multiple_of = 10;
      Specified by:
      getMultipleOf in interface Openapiv2.JSONSchemaOrBuilder
      Returns:
      The multipleOf.

    • setMultipleOf

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

    • clearMultipleOf

      public Openapiv2.JSONSchema.Builder clearMultipleOf()
      double multiple_of = 10;
      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.

    • getExclusiveMaximum

      public boolean getExclusiveMaximum()
      bool exclusive_maximum = 12;
      Specified by:
      getExclusiveMaximum in interface Openapiv2.JSONSchemaOrBuilder
      Returns:
      The exclusiveMaximum.

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

    • getExclusiveMinimum

      public boolean getExclusiveMinimum()
      bool exclusive_minimum = 14;
      Specified by:
      getExclusiveMinimum in interface Openapiv2.JSONSchemaOrBuilder
      Returns:
      The exclusiveMinimum.

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

    • getMaxLength

      public long getMaxLength()
      uint64 max_length = 15;
      Specified by:
      getMaxLength in interface Openapiv2.JSONSchemaOrBuilder
      Returns:
      The maxLength.

    • setMaxLength

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

    • clearMaxLength

      public Openapiv2.JSONSchema.Builder clearMaxLength()
      uint64 max_length = 15;
      Returns:
      This builder for chaining.

    • getMinLength

      public long getMinLength()
      uint64 min_length = 16;
      Specified by:
      getMinLength in interface Openapiv2.JSONSchemaOrBuilder
      Returns:
      The minLength.

    • setMinLength

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

    • clearMinLength

      public Openapiv2.JSONSchema.Builder clearMinLength()
      uint64 min_length = 16;
      Returns:
      This builder for chaining.

    • getPattern

      public String getPattern()
      string pattern = 17;
      Specified by:
      getPattern in interface Openapiv2.JSONSchemaOrBuilder
      Returns:
      The pattern.

    • getPatternBytes

      public com.google.protobuf.ByteString getPatternBytes()
      string pattern = 17;
      Specified by:
      getPatternBytes in interface Openapiv2.JSONSchemaOrBuilder
      Returns:
      The bytes for pattern.

    • setPattern

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

    • clearPattern

      public Openapiv2.JSONSchema.Builder clearPattern()
      string pattern = 17;
      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.

    • getMaxItems

      public long getMaxItems()
      uint64 max_items = 20;
      Specified by:
      getMaxItems in interface Openapiv2.JSONSchemaOrBuilder
      Returns:
      The maxItems.

    • setMaxItems

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

    • clearMaxItems

      public Openapiv2.JSONSchema.Builder clearMaxItems()
      uint64 max_items = 20;
      Returns:
      This builder for chaining.

    • getMinItems

      public long getMinItems()
      uint64 min_items = 21;
      Specified by:
      getMinItems in interface Openapiv2.JSONSchemaOrBuilder
      Returns:
      The minItems.

    • setMinItems

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

    • clearMinItems

      public Openapiv2.JSONSchema.Builder clearMinItems()
      uint64 min_items = 21;
      Returns:
      This builder for chaining.

    • getUniqueItems

      public boolean getUniqueItems()
      bool unique_items = 22;
      Specified by:
      getUniqueItems in interface Openapiv2.JSONSchemaOrBuilder
      Returns:
      The uniqueItems.

    • setUniqueItems

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

    • clearUniqueItems

      public Openapiv2.JSONSchema.Builder clearUniqueItems()
      bool unique_items = 22;
      Returns:
      This builder for chaining.

    • getMaxProperties

      public long getMaxProperties()
      uint64 max_properties = 24;
      Specified by:
      getMaxProperties in interface Openapiv2.JSONSchemaOrBuilder
      Returns:
      The maxProperties.

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

    • getMinProperties

      public long getMinProperties()
      uint64 min_properties = 25;
      Specified by:
      getMinProperties in interface Openapiv2.JSONSchemaOrBuilder
      Returns:
      The minProperties.

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

    • getRequiredList

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

    • getRequiredCount

      public int getRequiredCount()
      repeated string required = 26;
      Specified by:
      getRequiredCount in interface Openapiv2.JSONSchemaOrBuilder
      Returns:
      The count of 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.

    • addAllRequired

      public Openapiv2.JSONSchema.Builder addAllRequired(Iterable<String> values)
      repeated string required = 26;
      Parameters:
      values - The required to add.
      Returns:
      This builder for chaining.

    • clearRequired

      public Openapiv2.JSONSchema.Builder clearRequired()
      repeated string required = 26;
      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.

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

    • getArrayCount

      public int getArrayCount()
       Items in 'array' must be unique.
      repeated string array = 34;
      Specified by:
      getArrayCount in interface Openapiv2.JSONSchemaOrBuilder
      Returns:
      The count of 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.

    • getTypeList

      public List<Openapiv2.JSONSchema.JSONSchemaSimpleTypes> getTypeList()
      repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;
      Specified by:
      getTypeList in interface Openapiv2.JSONSchemaOrBuilder
      Returns:
      A list containing the type.

    • getTypeCount

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

    • getType

      public Openapiv2.JSONSchema.JSONSchemaSimpleTypes getType(int index)
      repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;
      Specified by:
      getType in interface Openapiv2.JSONSchemaOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The type at the given index.

    • setType

      public Openapiv2.JSONSchema.Builder setType(int index, Openapiv2.JSONSchema.JSONSchemaSimpleTypes value)
      repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;
      Parameters:
      index - The index to set the value at.
      value - The type to set.
      Returns:
      This builder for chaining.

    • addType

      public Openapiv2.JSONSchema.Builder addType(Openapiv2.JSONSchema.JSONSchemaSimpleTypes value)
      repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;
      Parameters:
      value - The type to add.
      Returns:
      This builder for chaining.

    • addAllType

      public Openapiv2.JSONSchema.Builder addAllType(Iterable<? extends Openapiv2.JSONSchema.JSONSchemaSimpleTypes> values)
      repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;
      Parameters:
      values - The type to add.
      Returns:
      This builder for chaining.

    • clearType

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

    • getTypeValueList

      public List<Integer> getTypeValueList()
      repeated .grpc.gateway.protoc_gen_openapiv2.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_openapiv2.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_openapiv2.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_openapiv2.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_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;
      Parameters:
      values - The enum numeric values on the wire for type to add.
      Returns:
      This builder for chaining.

    • getFormat

      public String getFormat()
       `Format`
      string format = 36;
      Specified by:
      getFormat in interface Openapiv2.JSONSchemaOrBuilder
      Returns:
      The format.

    • getFormatBytes

      public com.google.protobuf.ByteString getFormatBytes()
       `Format`
      string format = 36;
      Specified by:
      getFormatBytes in interface Openapiv2.JSONSchemaOrBuilder
      Returns:
      The bytes for format.

    • setFormat

      public Openapiv2.JSONSchema.Builder setFormat(String value)
       `Format`
      string format = 36;
      Parameters:
      value - The format to set.
      Returns:
      This builder for chaining.

    • clearFormat

      public Openapiv2.JSONSchema.Builder clearFormat()
       `Format`
      string format = 36;
      Returns:
      This builder for chaining.

    • setFormatBytes

      public Openapiv2.JSONSchema.Builder setFormatBytes(com.google.protobuf.ByteString value)
       `Format`
      string format = 36;
      Parameters:
      value - The bytes for format to set.
      Returns:
      This builder for chaining.

    • getEnumList

      public com.google.protobuf.ProtocolStringList getEnumList()
       Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1
      repeated string enum = 46;
      Specified by:
      getEnumList in interface Openapiv2.JSONSchemaOrBuilder
      Returns:
      A list containing the enum.

    • getEnumCount

      public int getEnumCount()
       Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1
      repeated string enum = 46;
      Specified by:
      getEnumCount in interface Openapiv2.JSONSchemaOrBuilder
      Returns:
      The count of enum.

    • getEnum

      public String getEnum(int index)
       Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1
      repeated string enum = 46;
      Specified by:
      getEnum in interface Openapiv2.JSONSchemaOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The enum at the given index.

    • getEnumBytes

      public com.google.protobuf.ByteString getEnumBytes(int index)
       Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1
      repeated string enum = 46;
      Specified by:
      getEnumBytes in interface Openapiv2.JSONSchemaOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the enum at the given index.

    • setEnum

      public Openapiv2.JSONSchema.Builder setEnum(int index, String value)
       Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1
      repeated string enum = 46;
      Parameters:
      index - The index to set the value at.
      value - The enum to set.
      Returns:
      This builder for chaining.

    • addEnum

      public Openapiv2.JSONSchema.Builder addEnum(String value)
       Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1
      repeated string enum = 46;
      Parameters:
      value - The enum to add.
      Returns:
      This builder for chaining.

    • addAllEnum

      public Openapiv2.JSONSchema.Builder addAllEnum(Iterable<String> values)
       Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1
      repeated string enum = 46;
      Parameters:
      values - The enum to add.
      Returns:
      This builder for chaining.

    • clearEnum

      public Openapiv2.JSONSchema.Builder clearEnum()
       Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1
      repeated string enum = 46;
      Returns:
      This builder for chaining.

    • addEnumBytes

      public Openapiv2.JSONSchema.Builder addEnumBytes(com.google.protobuf.ByteString value)
       Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1
      repeated string enum = 46;
      Parameters:
      value - The bytes of the enum to add.
      Returns:
      This builder for chaining.

    • hasFieldConfiguration

      public boolean hasFieldConfiguration()
       Additional field level properties used when generating the OpenAPI v2 file.
      .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.FieldConfiguration field_configuration = 1001;
      Specified by:
      hasFieldConfiguration in interface Openapiv2.JSONSchemaOrBuilder
      Returns:
      Whether the fieldConfiguration field is set.

    • getFieldConfiguration

      public Openapiv2.JSONSchema.FieldConfiguration getFieldConfiguration()
       Additional field level properties used when generating the OpenAPI v2 file.
      .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.FieldConfiguration field_configuration = 1001;
      Specified by:
      getFieldConfiguration in interface Openapiv2.JSONSchemaOrBuilder
      Returns:
      The fieldConfiguration.

    • setFieldConfiguration

      public Openapiv2.JSONSchema.Builder setFieldConfiguration(Openapiv2.JSONSchema.FieldConfiguration value)
       Additional field level properties used when generating the OpenAPI v2 file.
      .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.FieldConfiguration field_configuration = 1001;

    • setFieldConfiguration

      public Openapiv2.JSONSchema.Builder setFieldConfiguration(Openapiv2.JSONSchema.FieldConfiguration.Builder builderForValue)
       Additional field level properties used when generating the OpenAPI v2 file.
      .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.FieldConfiguration field_configuration = 1001;

    • mergeFieldConfiguration

      public Openapiv2.JSONSchema.Builder mergeFieldConfiguration(Openapiv2.JSONSchema.FieldConfiguration value)
       Additional field level properties used when generating the OpenAPI v2 file.
      .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.FieldConfiguration field_configuration = 1001;

    • clearFieldConfiguration

      public Openapiv2.JSONSchema.Builder clearFieldConfiguration()
       Additional field level properties used when generating the OpenAPI v2 file.
      .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.FieldConfiguration field_configuration = 1001;

    • getFieldConfigurationBuilder

      public Openapiv2.JSONSchema.FieldConfiguration.Builder getFieldConfigurationBuilder()
       Additional field level properties used when generating the OpenAPI v2 file.
      .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.FieldConfiguration field_configuration = 1001;

    • getFieldConfigurationOrBuilder

      public Openapiv2.JSONSchema.FieldConfigurationOrBuilder getFieldConfigurationOrBuilder()
       Additional field level properties used when generating the OpenAPI v2 file.
      .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.FieldConfiguration field_configuration = 1001;
      Specified by:
      getFieldConfigurationOrBuilder in interface Openapiv2.JSONSchemaOrBuilder

    • getExtensionsCount

      public int getExtensionsCount()
      Description copied from interface: Openapiv2.JSONSchemaOrBuilder
       Custom properties that start with "x-" such as "x-foo" used to describe
 extra functionality that is not covered by the standard OpenAPI Specification.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
      map<string, .google.protobuf.Value> extensions = 48;
      Specified by:
      getExtensionsCount in interface Openapiv2.JSONSchemaOrBuilder

    • containsExtensions

      public boolean containsExtensions(String key)
       Custom properties that start with "x-" such as "x-foo" used to describe
 extra functionality that is not covered by the standard OpenAPI Specification.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
      map<string, .google.protobuf.Value> extensions = 48;
      Specified by:
      containsExtensions in interface Openapiv2.JSONSchemaOrBuilder

    • getExtensions

      @Deprecated public Map<String,com.google.protobuf.Value> getExtensions()
      Deprecated.
      Use getExtensionsMap() instead.
      Specified by:
      getExtensions in interface Openapiv2.JSONSchemaOrBuilder

    • getExtensionsMap

      public Map<String,com.google.protobuf.Value> getExtensionsMap()
       Custom properties that start with "x-" such as "x-foo" used to describe
 extra functionality that is not covered by the standard OpenAPI Specification.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
      map<string, .google.protobuf.Value> extensions = 48;
      Specified by:
      getExtensionsMap in interface Openapiv2.JSONSchemaOrBuilder

    • getExtensionsOrDefault

      public com.google.protobuf.Value getExtensionsOrDefault(String key, com.google.protobuf.Value defaultValue)
       Custom properties that start with "x-" such as "x-foo" used to describe
 extra functionality that is not covered by the standard OpenAPI Specification.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
      map<string, .google.protobuf.Value> extensions = 48;
      Specified by:
      getExtensionsOrDefault in interface Openapiv2.JSONSchemaOrBuilder

    • getExtensionsOrThrow

      public com.google.protobuf.Value getExtensionsOrThrow(String key)
       Custom properties that start with "x-" such as "x-foo" used to describe
 extra functionality that is not covered by the standard OpenAPI Specification.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
      map<string, .google.protobuf.Value> extensions = 48;
      Specified by:
      getExtensionsOrThrow in interface Openapiv2.JSONSchemaOrBuilder

    • clearExtensions

      public Openapiv2.JSONSchema.Builder clearExtensions()

    • removeExtensions

      public Openapiv2.JSONSchema.Builder removeExtensions(String key)
       Custom properties that start with "x-" such as "x-foo" used to describe
 extra functionality that is not covered by the standard OpenAPI Specification.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
      map<string, .google.protobuf.Value> extensions = 48;

    • getMutableExtensions

      @Deprecated public Map<String,com.google.protobuf.Value> getMutableExtensions()
      Deprecated.
      Use alternate mutation accessors instead.

    • putExtensions

      public Openapiv2.JSONSchema.Builder putExtensions(String key, com.google.protobuf.Value value)
       Custom properties that start with "x-" such as "x-foo" used to describe
 extra functionality that is not covered by the standard OpenAPI Specification.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
      map<string, .google.protobuf.Value> extensions = 48;

    • putAllExtensions

      public Openapiv2.JSONSchema.Builder putAllExtensions(Map<String,com.google.protobuf.Value> values)
       Custom properties that start with "x-" such as "x-foo" used to describe
 extra functionality that is not covered by the standard OpenAPI Specification.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
      map<string, .google.protobuf.Value> extensions = 48;

    • putExtensionsBuilderIfAbsent

      public com.google.protobuf.Value.Builder putExtensionsBuilderIfAbsent(String key)
       Custom properties that start with "x-" such as "x-foo" used to describe
 extra functionality that is not covered by the standard OpenAPI Specification.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
      map<string, .google.protobuf.Value> extensions = 48;