Package grpc.gateway.protoc_gen_openapiv2.options

Class Openapiv2.JSONSchema

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.JSONSchema
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Openapiv2.JSONSchemaOrBuilder, Serializable
Enclosing class:
Openapiv2
public static final class Openapiv2.JSONSchema extends com.google.protobuf.GeneratedMessage 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
See Also:

  • Field Details

  • 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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

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

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

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

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

    • getReadOnly

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

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

    • getMultipleOf

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

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

    • getExclusiveMaximum

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

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

    • getExclusiveMinimum

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

    • getMaxLength

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

    • getMinLength

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

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

    • getMaxItems

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

    • getMinItems

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

    • getUniqueItems

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

    • getMaxProperties

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

    • getMinProperties

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

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

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

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

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

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

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

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

    • 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

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Openapiv2.JSONSchema parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Openapiv2.JSONSchema parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Openapiv2.JSONSchema parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Openapiv2.JSONSchema parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Openapiv2.JSONSchema parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Openapiv2.JSONSchema parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Openapiv2.JSONSchema parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Openapiv2.JSONSchema parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Openapiv2.JSONSchema parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Openapiv2.JSONSchema parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Openapiv2.JSONSchema parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Openapiv2.JSONSchema parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static Openapiv2.JSONSchema.Builder newBuilder()

    • newBuilder

      public static Openapiv2.JSONSchema.Builder newBuilder(Openapiv2.JSONSchema prototype)

    • toBuilder

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

    • newBuilderForType

      protected Openapiv2.JSONSchema.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Openapiv2.JSONSchema getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Openapiv2.JSONSchema> parser()

    • getParserForType

      public com.google.protobuf.Parser<Openapiv2.JSONSchema> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

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