Class 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.GeneratedMessageV3
    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
    See Also:
    Serialized Form
    • Field Detail

      • ref_

        private volatile Object ref_
      • title_

        private volatile Object title_
      • DESCRIPTION_FIELD_NUMBER

        public static final int DESCRIPTION_FIELD_NUMBER
        See Also:
        Constant Field Values
      • description_

        private volatile Object description_
      • default_

        private volatile Object default_
      • readOnly_

        private boolean readOnly_
      • MULTIPLE_OF_FIELD_NUMBER

        public static final int MULTIPLE_OF_FIELD_NUMBER
        See Also:
        Constant Field Values
      • multipleOf_

        private double multipleOf_
      • maximum_

        private double maximum_
      • EXCLUSIVE_MAXIMUM_FIELD_NUMBER

        public static final int EXCLUSIVE_MAXIMUM_FIELD_NUMBER
        See Also:
        Constant Field Values
      • exclusiveMaximum_

        private boolean exclusiveMaximum_
      • minimum_

        private double minimum_
      • EXCLUSIVE_MINIMUM_FIELD_NUMBER

        public static final int EXCLUSIVE_MINIMUM_FIELD_NUMBER
        See Also:
        Constant Field Values
      • exclusiveMinimum_

        private boolean exclusiveMinimum_
      • MAX_LENGTH_FIELD_NUMBER

        public static final int MAX_LENGTH_FIELD_NUMBER
        See Also:
        Constant Field Values
      • maxLength_

        private long maxLength_
      • MIN_LENGTH_FIELD_NUMBER

        public static final int MIN_LENGTH_FIELD_NUMBER
        See Also:
        Constant Field Values
      • minLength_

        private long minLength_
      • pattern_

        private volatile Object pattern_
      • maxItems_

        private long maxItems_
      • minItems_

        private long minItems_
      • UNIQUE_ITEMS_FIELD_NUMBER

        public static final int UNIQUE_ITEMS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • uniqueItems_

        private boolean uniqueItems_
      • MAX_PROPERTIES_FIELD_NUMBER

        public static final int MAX_PROPERTIES_FIELD_NUMBER
        See Also:
        Constant Field Values
      • maxProperties_

        private long maxProperties_
      • MIN_PROPERTIES_FIELD_NUMBER

        public static final int MIN_PROPERTIES_FIELD_NUMBER
        See Also:
        Constant Field Values
      • minProperties_

        private long minProperties_
      • required_

        private com.google.protobuf.LazyStringList required_
      • array_

        private com.google.protobuf.LazyStringList array_
      • typeMemoizedSerializedSize

        private int typeMemoizedSerializedSize
      • memoizedIsInitialized

        private byte memoizedIsInitialized
    • Constructor Detail

      • JSONSchema

        private JSONSchema​(com.google.protobuf.GeneratedMessageV3.Builder<?> builder)
      • JSONSchema

        private JSONSchema()
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3
      • 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
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • isInitialized

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

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • 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
      • newBuilderForType

        public Openapiv2.JSONSchema.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • 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.GeneratedMessageV3
      • getDefaultInstanceForType

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