Package grpc.gateway.protoc_gen_swagger.options

Interface Openapiv2.JSONSchemaOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Openapiv2.JSONSchema, Openapiv2.JSONSchema.Builder
    Enclosing class:
    Openapiv2
    public static interface Openapiv2.JSONSchemaOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getRef

        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;
        Returns:
        The ref.

      • getRefBytes

        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;
        Returns:
        The bytes for ref.

      • getTitle

        String getTitle()
         The title of the schema.
        string title = 5;
        Returns:
        The title.

      • getTitleBytes

        com.google.protobuf.ByteString getTitleBytes()
         The title of the schema.
        string title = 5;
        Returns:
        The bytes for title.

      • getDescription

        String getDescription()
         A short description of the schema.
        string description = 6;
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         A short description of the schema.
        string description = 6;
        Returns:
        The bytes for description.

      • getDefault

        String getDefault()
        string default = 7;
        Returns:
        The default.

      • getDefaultBytes

        com.google.protobuf.ByteString getDefaultBytes()
        string default = 7;
        Returns:
        The bytes for default.

      • getReadOnly

        boolean getReadOnly()
        bool read_only = 8;
        Returns:
        The readOnly.

      • getMultipleOf

        double getMultipleOf()
        double multiple_of = 10;
        Returns:
        The multipleOf.

      • getMaximum

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

      • getExclusiveMaximum

        boolean getExclusiveMaximum()
        bool exclusive_maximum = 12;
        Returns:
        The exclusiveMaximum.

      • getMinimum

        double getMinimum()
         minimum represents an inclusive lower limit for a numeric instance. The 
 value of MUST be a number,
        double minimum = 13;
        Returns:
        The minimum.

      • getExclusiveMinimum

        boolean getExclusiveMinimum()
        bool exclusive_minimum = 14;
        Returns:
        The exclusiveMinimum.

      • getMaxLength

        long getMaxLength()
        uint64 max_length = 15;
        Returns:
        The maxLength.

      • getMinLength

        long getMinLength()
        uint64 min_length = 16;
        Returns:
        The minLength.

      • getPattern

        String getPattern()
        string pattern = 17;
        Returns:
        The pattern.

      • getPatternBytes

        com.google.protobuf.ByteString getPatternBytes()
        string pattern = 17;
        Returns:
        The bytes for pattern.

      • getMaxItems

        long getMaxItems()
        uint64 max_items = 20;
        Returns:
        The maxItems.

      • getMinItems

        long getMinItems()
        uint64 min_items = 21;
        Returns:
        The minItems.

      • getUniqueItems

        boolean getUniqueItems()
        bool unique_items = 22;
        Returns:
        The uniqueItems.

      • getMaxProperties

        long getMaxProperties()
        uint64 max_properties = 24;
        Returns:
        The maxProperties.

      • getMinProperties

        long getMinProperties()
        uint64 min_properties = 25;
        Returns:
        The minProperties.

      • getRequiredList

        List<String> getRequiredList()
        repeated string required = 26;
        Returns:
        A list containing the required.

      • getRequiredCount

        int getRequiredCount()
        repeated string required = 26;
        Returns:
        The count of required.

      • getRequired

        String getRequired​(int index)
        repeated string required = 26;
        Parameters:
        index - The index of the element to return.
        Returns:
        The required at the given index.

      • getRequiredBytes

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

      • getArrayList

        List<String> getArrayList()
         Items in 'array' must be unique.
        repeated string array = 34;
        Returns:
        A list containing the array.

      • getArrayCount

        int getArrayCount()
         Items in 'array' must be unique.
        repeated string array = 34;
        Returns:
        The count of array.

      • getArray

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

      • getArrayBytes

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

      • getTypeCount

        int getTypeCount()
        repeated .grpc.gateway.protoc_gen_swagger.options.JSONSchema.JSONSchemaSimpleTypes type = 35;
        Returns:
        The count of type.

      • getType

        Openapiv2.JSONSchema.JSONSchemaSimpleTypes getType​(int index)
        repeated .grpc.gateway.protoc_gen_swagger.options.JSONSchema.JSONSchemaSimpleTypes type = 35;
        Parameters:
        index - The index of the element to return.
        Returns:
        The type at the given index.

      • getTypeValueList

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

      • getTypeValue

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