Package grpc.gateway.protoc_gen_openapiv2.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 Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean containsExtensions​(java.lang.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.
      java.lang.String getArray​(int index)
      Items in 'array' must be unique.
      com.google.protobuf.ByteString getArrayBytes​(int index)
      Items in 'array' must be unique.
      int getArrayCount()
      Items in 'array' must be unique.
      java.util.List<java.lang.String> getArrayList()
      Items in 'array' must be unique.
      java.lang.String getDefault()
      string default = 7;
      com.google.protobuf.ByteString getDefaultBytes()
      string default = 7;
      java.lang.String getDescription()
      A short description of the schema.
      com.google.protobuf.ByteString getDescriptionBytes()
      A short description of the schema.
      java.lang.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
      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
      int getEnumCount()
      Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1
      java.util.List<java.lang.String> getEnumList()
      Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1
      java.lang.String getExample()
      A free-form property to include a JSON example of this field.
      com.google.protobuf.ByteString getExampleBytes()
      A free-form property to include a JSON example of this field.
      boolean getExclusiveMaximum()
      bool exclusive_maximum = 12;
      boolean getExclusiveMinimum()
      bool exclusive_minimum = 14;
      java.util.Map<java.lang.String,​com.google.protobuf.Value> getExtensions()
      Deprecated.
      int getExtensionsCount()
      Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.
      java.util.Map<java.lang.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.
      com.google.protobuf.Value getExtensionsOrDefault​(java.lang.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.
      com.google.protobuf.Value getExtensionsOrThrow​(java.lang.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.
      Openapiv2.JSONSchema.FieldConfiguration getFieldConfiguration()
      Additional field level properties used when generating the OpenAPI v2 file.
      Openapiv2.JSONSchema.FieldConfigurationOrBuilder getFieldConfigurationOrBuilder()
      Additional field level properties used when generating the OpenAPI v2 file.
      java.lang.String getFormat()
      `Format`
      com.google.protobuf.ByteString getFormatBytes()
      `Format`
      double getMaximum()
      Maximum represents an inclusive upper limit for a numeric instance.
      long getMaxItems()
      uint64 max_items = 20;
      long getMaxLength()
      uint64 max_length = 15;
      long getMaxProperties()
      uint64 max_properties = 24;
      double getMinimum()
      minimum represents an inclusive lower limit for a numeric instance.
      long getMinItems()
      uint64 min_items = 21;
      long getMinLength()
      uint64 min_length = 16;
      long getMinProperties()
      uint64 min_properties = 25;
      double getMultipleOf()
      double multiple_of = 10;
      java.lang.String getPattern()
      string pattern = 17;
      com.google.protobuf.ByteString getPatternBytes()
      string pattern = 17;
      boolean getReadOnly()
      bool read_only = 8;
      java.lang.String getRef()
      Ref is used to define an external reference to include in the message.
      com.google.protobuf.ByteString getRefBytes()
      Ref is used to define an external reference to include in the message.
      java.lang.String getRequired​(int index)
      repeated string required = 26;
      com.google.protobuf.ByteString getRequiredBytes​(int index)
      repeated string required = 26;
      int getRequiredCount()
      repeated string required = 26;
      java.util.List<java.lang.String> getRequiredList()
      repeated string required = 26;
      java.lang.String getTitle()
      The title of the schema.
      com.google.protobuf.ByteString getTitleBytes()
      The title of the schema.
      Openapiv2.JSONSchema.JSONSchemaSimpleTypes getType​(int index)
      repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;
      int getTypeCount()
      repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;
      java.util.List<Openapiv2.JSONSchema.JSONSchemaSimpleTypes> getTypeList()
      repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;
      int getTypeValue​(int index)
      repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;
      java.util.List<java.lang.Integer> getTypeValueList()
      repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;
      boolean getUniqueItems()
      bool unique_items = 22;
      boolean hasFieldConfiguration()
      Additional field level properties used when generating the OpenAPI v2 file.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getRef

        java.lang.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

        java.lang.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

        java.lang.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

        java.lang.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.

      • getExample

        java.lang.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;
        Returns:
        The example.

      • getExampleBytes

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

      • 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

        java.lang.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

        java.util.List<java.lang.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

        java.lang.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

        java.util.List<java.lang.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

        java.lang.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.

      • getTypeList

        java.util.List<Openapiv2.JSONSchema.JSONSchemaSimpleTypes> getTypeList()
        repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;
        Returns:
        A list containing the type.

      • getTypeCount

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

      • getType

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

      • getTypeValueList

        java.util.List<java.lang.Integer> getTypeValueList()
        repeated .grpc.gateway.protoc_gen_openapiv2.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_openapiv2.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.

      • getFormat

        java.lang.String getFormat()
         `Format`
        string format = 36;
        Returns:
        The format.

      • getFormatBytes

        com.google.protobuf.ByteString getFormatBytes()
         `Format`
        string format = 36;
        Returns:
        The bytes for format.

      • getEnumList

        java.util.List<java.lang.String> 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;
        Returns:
        A list containing the enum.

      • getEnumCount

        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;
        Returns:
        The count of enum.

      • getEnum

        java.lang.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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The enum at the given index.

      • getEnumBytes

        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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the enum at the given index.

      • hasFieldConfiguration

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

      • getFieldConfiguration

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

      • getFieldConfigurationOrBuilder

        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;

      • getExtensionsCount

        int getExtensionsCount()
         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;

      • containsExtensions

        boolean containsExtensions​(java.lang.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;

      • getExtensions

        @Deprecated
java.util.Map<java.lang.String,​com.google.protobuf.Value> getExtensions()
        Deprecated.
        Use getExtensionsMap() instead.

      • getExtensionsMap

        java.util.Map<java.lang.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;

      • getExtensionsOrDefault

        com.google.protobuf.Value getExtensionsOrDefault​(java.lang.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;

      • getExtensionsOrThrow

        com.google.protobuf.Value getExtensionsOrThrow​(java.lang.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;