JSONSchema (nakama-java 2.5.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessage
    - - com.grpc.gateway.protoc_gen_openapiv2.options.JSONSchema

All Implemented Interfaces:: com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, JSONSchemaOrBuilder, java.io.Serializable

public final class JSONSchema
extends com.google.protobuf.GeneratedMessage
implements 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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`JSONSchema.Builder` `JSONSchema` represents properties from JSON Schema taken, and as used, in the OpenAPI v2 spec.
`static class`	`JSONSchema.FieldConfiguration` 'FieldConfiguration' provides additional field level properties used when generating the OpenAPI v2 file.
`static interface`	`JSONSchema.FieldConfigurationOrBuilder`
`static class`	`JSONSchema.JSONSchemaSimpleTypes` Protobuf enum `grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes`

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ARRAY_FIELD_NUMBER`
`static int`	`DEFAULT_FIELD_NUMBER`
`static int`	`DESCRIPTION_FIELD_NUMBER`
`static int`	`ENUM_FIELD_NUMBER`
`static int`	`EXAMPLE_FIELD_NUMBER`
`static int`	`EXCLUSIVE_MAXIMUM_FIELD_NUMBER`
`static int`	`EXCLUSIVE_MINIMUM_FIELD_NUMBER`
`static int`	`EXTENSIONS_FIELD_NUMBER`
`static int`	`FIELD_CONFIGURATION_FIELD_NUMBER`
`static int`	`FORMAT_FIELD_NUMBER`
`static int`	`MAX_ITEMS_FIELD_NUMBER`
`static int`	`MAX_LENGTH_FIELD_NUMBER`
`static int`	`MAX_PROPERTIES_FIELD_NUMBER`
`static int`	`MAXIMUM_FIELD_NUMBER`
`static int`	`MIN_ITEMS_FIELD_NUMBER`
`static int`	`MIN_LENGTH_FIELD_NUMBER`
`static int`	`MIN_PROPERTIES_FIELD_NUMBER`
`static int`	`MINIMUM_FIELD_NUMBER`
`static int`	`MULTIPLE_OF_FIELD_NUMBER`
`static int`	`PATTERN_FIELD_NUMBER`
`static int`	`READ_ONLY_FIELD_NUMBER`
`static int`	`REF_FIELD_NUMBER`
`static int`	`REQUIRED_FIELD_NUMBER`
`static int`	`TITLE_FIELD_NUMBER`
`static int`	`TYPE_FIELD_NUMBER`
`static int`	`UNIQUE_ITEMS_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and 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.
`boolean`	`equals(java.lang.Object obj)`
`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.
`com.google.protobuf.ProtocolStringList`	`getArrayList()` Items in 'array' must be unique.
`java.lang.String`	`getDefault()` `string default = 7 [json_name = "default"];`
`com.google.protobuf.ByteString`	`getDefaultBytes()` `string default = 7 [json_name = "default"];`
`static JSONSchema`	`getDefaultInstance()`
`JSONSchema`	`getDefaultInstanceForType()`
`java.lang.String`	`getDescription()` A short description of the schema.
`com.google.protobuf.ByteString`	`getDescriptionBytes()` A short description of the schema.
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`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
`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
`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 [json_name = "exclusiveMaximum"];`
`boolean`	`getExclusiveMinimum()` `bool exclusive_minimum = 14 [json_name = "exclusiveMinimum"];`
`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.
`JSONSchema.FieldConfiguration`	`getFieldConfiguration()` Additional field level properties used when generating the OpenAPI v2 file.
`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 [json_name = "maxItems"];`
`long`	`getMaxLength()` `uint64 max_length = 15 [json_name = "maxLength"];`
`long`	`getMaxProperties()` `uint64 max_properties = 24 [json_name = "maxProperties"];`
`double`	`getMinimum()` minimum represents an inclusive lower limit for a numeric instance.
`long`	`getMinItems()` `uint64 min_items = 21 [json_name = "minItems"];`
`long`	`getMinLength()` `uint64 min_length = 16 [json_name = "minLength"];`
`long`	`getMinProperties()` `uint64 min_properties = 25 [json_name = "minProperties"];`
`double`	`getMultipleOf()` `double multiple_of = 10 [json_name = "multipleOf"];`
`com.google.protobuf.Parser<JSONSchema>`	`getParserForType()`
`java.lang.String`	`getPattern()` `string pattern = 17 [json_name = "pattern"];`
`com.google.protobuf.ByteString`	`getPatternBytes()` `string pattern = 17 [json_name = "pattern"];`
`boolean`	`getReadOnly()` `bool read_only = 8 [json_name = "readOnly"];`
`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 [json_name = "required"];`
`com.google.protobuf.ByteString`	`getRequiredBytes(int index)` `repeated string required = 26 [json_name = "required"];`
`int`	`getRequiredCount()` `repeated string required = 26 [json_name = "required"];`
`com.google.protobuf.ProtocolStringList`	`getRequiredList()` `repeated string required = 26 [json_name = "required"];`
`int`	`getSerializedSize()`
`java.lang.String`	`getTitle()` The title of the schema.
`com.google.protobuf.ByteString`	`getTitleBytes()` The title of the schema.
`JSONSchema.JSONSchemaSimpleTypes`	`getType(int index)` `repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35 [json_name = "type"];`
`int`	`getTypeCount()` `repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35 [json_name = "type"];`
`java.util.List<JSONSchema.JSONSchemaSimpleTypes>`	`getTypeList()` `repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35 [json_name = "type"];`
`int`	`getTypeValue(int index)` `repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35 [json_name = "type"];`
`java.util.List<java.lang.Integer>`	`getTypeValueList()` `repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35 [json_name = "type"];`
`boolean`	`getUniqueItems()` `bool unique_items = 22 [json_name = "uniqueItems"];`
`boolean`	`hasFieldConfiguration()` Additional field level properties used when generating the OpenAPI v2 file.
`int`	`hashCode()`
`protected com.google.protobuf.GeneratedMessage.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapFieldReflectionAccessor`	`internalGetMapFieldReflection(int number)`
`boolean`	`isInitialized()`
`static JSONSchema.Builder`	`newBuilder()`
`static JSONSchema.Builder`	`newBuilder(JSONSchema prototype)`
`JSONSchema.Builder`	`newBuilderForType()`
`protected JSONSchema.Builder`	`newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)`
`static JSONSchema`	`parseDelimitedFrom(java.io.InputStream input)`
`static JSONSchema`	`parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static JSONSchema`	`parseFrom(byte[] data)`
`static JSONSchema`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static JSONSchema`	`parseFrom(java.nio.ByteBuffer data)`
`static JSONSchema`	`parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static JSONSchema`	`parseFrom(com.google.protobuf.ByteString data)`
`static JSONSchema`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static JSONSchema`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static JSONSchema`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static JSONSchema`	`parseFrom(java.io.InputStream input)`
`static JSONSchema`	`parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<JSONSchema>`	`parser()`
`JSONSchema.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

- Field Detail
  - REF_FIELD_NUMBER
```
public static final int REF_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - TITLE_FIELD_NUMBER
```
public static final int TITLE_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - DESCRIPTION_FIELD_NUMBER
```
public static final int DESCRIPTION_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - DEFAULT_FIELD_NUMBER
```
public static final int DEFAULT_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - READ_ONLY_FIELD_NUMBER
```
public static final int READ_ONLY_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - EXAMPLE_FIELD_NUMBER
```
public static final int EXAMPLE_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - MULTIPLE_OF_FIELD_NUMBER
```
public static final int MULTIPLE_OF_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - MAXIMUM_FIELD_NUMBER
```
public static final int MAXIMUM_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - EXCLUSIVE_MAXIMUM_FIELD_NUMBER
```
public static final int EXCLUSIVE_MAXIMUM_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - MINIMUM_FIELD_NUMBER
```
public static final int MINIMUM_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - EXCLUSIVE_MINIMUM_FIELD_NUMBER
```
public static final int EXCLUSIVE_MINIMUM_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - MAX_LENGTH_FIELD_NUMBER
```
public static final int MAX_LENGTH_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - MIN_LENGTH_FIELD_NUMBER
```
public static final int MIN_LENGTH_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - PATTERN_FIELD_NUMBER
```
public static final int PATTERN_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - MAX_ITEMS_FIELD_NUMBER
```
public static final int MAX_ITEMS_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - MIN_ITEMS_FIELD_NUMBER
```
public static final int MIN_ITEMS_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - UNIQUE_ITEMS_FIELD_NUMBER
```
public static final int UNIQUE_ITEMS_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - MAX_PROPERTIES_FIELD_NUMBER
```
public static final int MAX_PROPERTIES_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - MIN_PROPERTIES_FIELD_NUMBER
```
public static final int MIN_PROPERTIES_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - REQUIRED_FIELD_NUMBER
```
public static final int REQUIRED_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - ARRAY_FIELD_NUMBER
```
public static final int ARRAY_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - TYPE_FIELD_NUMBER
```
public static final int TYPE_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - FORMAT_FIELD_NUMBER
```
public static final int FORMAT_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - ENUM_FIELD_NUMBER
```
public static final int ENUM_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - FIELD_CONFIGURATION_FIELD_NUMBER
```
public static final int FIELD_CONFIGURATION_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - EXTENSIONS_FIELD_NUMBER
```
public static final int EXTENSIONS_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
- Method Detail
  - 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 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 [json_name = "ref"];
    Specified by:
    
    getRef in interface 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 [json_name = "ref"];
    Specified by:
    
    getRefBytes in interface JSONSchemaOrBuilder
    
    Returns:
    
    The bytes for ref.
  - getTitle
```
public java.lang.String getTitle()
```
```
 The title of the schema.
 
```
    string title = 5 [json_name = "title"];
    Specified by:
    
    getTitle in interface JSONSchemaOrBuilder
    
    Returns:
    
    The title.
  - getTitleBytes
```
public com.google.protobuf.ByteString getTitleBytes()
```
```
 The title of the schema.
 
```
    string title = 5 [json_name = "title"];
    Specified by:
    
    getTitleBytes in interface JSONSchemaOrBuilder
    
    Returns:
    
    The bytes for title.
  - getDescription
```
public java.lang.String getDescription()
```
```
 A short description of the schema.
 
```
    string description = 6 [json_name = "description"];
    Specified by:
    
    getDescription in interface JSONSchemaOrBuilder
    
    Returns:
    
    The description.
  - getDescriptionBytes
```
public com.google.protobuf.ByteString getDescriptionBytes()
```
```
 A short description of the schema.
 
```
    string description = 6 [json_name = "description"];
    Specified by:
    
    getDescriptionBytes in interface JSONSchemaOrBuilder
    
    Returns:
    
    The bytes for description.
  - getDefault
```
public java.lang.String getDefault()
```
    string default = 7 [json_name = "default"];
    
    Specified by:
    
    getDefault in interface JSONSchemaOrBuilder
    
    Returns:
    
    The default.
  - getDefaultBytes
```
public com.google.protobuf.ByteString getDefaultBytes()
```
    string default = 7 [json_name = "default"];
    
    Specified by:
    
    getDefaultBytes in interface JSONSchemaOrBuilder
    
    Returns:
    
    The bytes for default.
  - getReadOnly
```
public boolean getReadOnly()
```
    bool read_only = 8 [json_name = "readOnly"];
    
    Specified by:
    
    getReadOnly in interface JSONSchemaOrBuilder
    
    Returns:
    
    The readOnly.
  - getExample
```
public 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 [json_name = "example"];
    Specified by:
    
    getExample in interface 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 [json_name = "example"];
    Specified by:
    
    getExampleBytes in interface JSONSchemaOrBuilder
    
    Returns:
    
    The bytes for example.
  - getMultipleOf
```
public double getMultipleOf()
```
    double multiple_of = 10 [json_name = "multipleOf"];
    
    Specified by:
    
    getMultipleOf in interface 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 [json_name = "maximum"];
    Specified by:
    
    getMaximum in interface JSONSchemaOrBuilder
    
    Returns:
    
    The maximum.
  - getExclusiveMaximum
```
public boolean getExclusiveMaximum()
```
    bool exclusive_maximum = 12 [json_name = "exclusiveMaximum"];
    
    Specified by:
    
    getExclusiveMaximum in interface 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 [json_name = "minimum"];
    Specified by:
    
    getMinimum in interface JSONSchemaOrBuilder
    
    Returns:
    
    The minimum.
  - getExclusiveMinimum
```
public boolean getExclusiveMinimum()
```
    bool exclusive_minimum = 14 [json_name = "exclusiveMinimum"];
    
    Specified by:
    
    getExclusiveMinimum in interface JSONSchemaOrBuilder
    
    Returns:
    
    The exclusiveMinimum.
  - getMaxLength
```
public long getMaxLength()
```
    uint64 max_length = 15 [json_name = "maxLength"];
    
    Specified by:
    
    getMaxLength in interface JSONSchemaOrBuilder
    
    Returns:
    
    The maxLength.
  - getMinLength
```
public long getMinLength()
```
    uint64 min_length = 16 [json_name = "minLength"];
    
    Specified by:
    
    getMinLength in interface JSONSchemaOrBuilder
    
    Returns:
    
    The minLength.
  - getPattern
```
public java.lang.String getPattern()
```
    string pattern = 17 [json_name = "pattern"];
    
    Specified by:
    
    getPattern in interface JSONSchemaOrBuilder
    
    Returns:
    
    The pattern.
  - getPatternBytes
```
public com.google.protobuf.ByteString getPatternBytes()
```
    string pattern = 17 [json_name = "pattern"];
    
    Specified by:
    
    getPatternBytes in interface JSONSchemaOrBuilder
    
    Returns:
    
    The bytes for pattern.
  - getMaxItems
```
public long getMaxItems()
```
    uint64 max_items = 20 [json_name = "maxItems"];
    
    Specified by:
    
    getMaxItems in interface JSONSchemaOrBuilder
    
    Returns:
    
    The maxItems.
  - getMinItems
```
public long getMinItems()
```
    uint64 min_items = 21 [json_name = "minItems"];
    
    Specified by:
    
    getMinItems in interface JSONSchemaOrBuilder
    
    Returns:
    
    The minItems.
  - getUniqueItems
```
public boolean getUniqueItems()
```
    bool unique_items = 22 [json_name = "uniqueItems"];
    
    Specified by:
    
    getUniqueItems in interface JSONSchemaOrBuilder
    
    Returns:
    
    The uniqueItems.
  - getMaxProperties
```
public long getMaxProperties()
```
    uint64 max_properties = 24 [json_name = "maxProperties"];
    
    Specified by:
    
    getMaxProperties in interface JSONSchemaOrBuilder
    
    Returns:
    
    The maxProperties.
  - getMinProperties
```
public long getMinProperties()
```
    uint64 min_properties = 25 [json_name = "minProperties"];
    
    Specified by:
    
    getMinProperties in interface JSONSchemaOrBuilder
    
    Returns:
    
    The minProperties.
  - getRequiredList
```
public com.google.protobuf.ProtocolStringList getRequiredList()
```
    repeated string required = 26 [json_name = "required"];
    
    Specified by:
    
    getRequiredList in interface JSONSchemaOrBuilder
    
    Returns:
    
    A list containing the required.
  - getRequiredCount
```
public int getRequiredCount()
```
    repeated string required = 26 [json_name = "required"];
    
    Specified by:
    
    getRequiredCount in interface JSONSchemaOrBuilder
    
    Returns:
    
    The count of required.
  - getRequired
```
public java.lang.String getRequired(int index)
```
    repeated string required = 26 [json_name = "required"];
    
    Specified by:
    
    getRequired in interface 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 [json_name = "required"];
    
    Specified by:
    
    getRequiredBytes in interface 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 [json_name = "array"];
    Specified by:
    
    getArrayList in interface JSONSchemaOrBuilder
    
    Returns:
    
    A list containing the array.
  - getArrayCount
```
public int getArrayCount()
```
```
 Items in 'array' must be unique.
 
```
    repeated string array = 34 [json_name = "array"];
    Specified by:
    
    getArrayCount in interface JSONSchemaOrBuilder
    
    Returns:
    
    The count of array.
  - getArray
```
public java.lang.String getArray(int index)
```
```
 Items in 'array' must be unique.
 
```
    repeated string array = 34 [json_name = "array"];
    Specified by:
    
    getArray in interface 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 [json_name = "array"];
    Specified by:
    
    getArrayBytes in interface JSONSchemaOrBuilder
    
    Parameters:
    
    index - The index of the value to return.
    
    Returns:
    
    The bytes of the array at the given index.
  - getTypeList
```
public java.util.List<JSONSchema.JSONSchemaSimpleTypes> getTypeList()
```
    repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35 [json_name = "type"];
    
    Specified by:
    
    getTypeList in interface JSONSchemaOrBuilder
    
    Returns:
    
    A list containing the type.
  - getTypeCount
```
public int getTypeCount()
```
    repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35 [json_name = "type"];
    
    Specified by:
    
    getTypeCount in interface JSONSchemaOrBuilder
    
    Returns:
    
    The count of type.
  - getType
```
public JSONSchema.JSONSchemaSimpleTypes getType(int index)
```
    repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35 [json_name = "type"];
    
    Specified by:
    
    getType in interface JSONSchemaOrBuilder
    
    Parameters:
    
    index - The index of the element to return.
    
    Returns:
    
    The type at the given index.
  - getTypeValueList
```
public java.util.List<java.lang.Integer> getTypeValueList()
```
    repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35 [json_name = "type"];
    
    Specified by:
    
    getTypeValueList in interface 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 [json_name = "type"];
    
    Specified by:
    
    getTypeValue in interface 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 java.lang.String getFormat()
```
```
 `Format`
 
```
    string format = 36 [json_name = "format"];
    Specified by:
    
    getFormat in interface JSONSchemaOrBuilder
    
    Returns:
    
    The format.
  - getFormatBytes
```
public com.google.protobuf.ByteString getFormatBytes()
```
```
 `Format`
 
```
    string format = 36 [json_name = "format"];
    Specified by:
    
    getFormatBytes in interface 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 [json_name = "enum"];
    Specified by:
    
    getEnumList in interface 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 [json_name = "enum"];
    Specified by:
    
    getEnumCount in interface JSONSchemaOrBuilder
    
    Returns:
    
    The count of enum.
  - getEnum
```
public 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 [json_name = "enum"];
    Specified by:
    
    getEnum in interface 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 [json_name = "enum"];
    Specified by:
    
    getEnumBytes in interface 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 [json_name = "fieldConfiguration"];
    Specified by:
    
    hasFieldConfiguration in interface JSONSchemaOrBuilder
    
    Returns:
    
    Whether the fieldConfiguration field is set.
  - getFieldConfiguration
```
public 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 [json_name = "fieldConfiguration"];
    Specified by:
    
    getFieldConfiguration in interface JSONSchemaOrBuilder
    
    Returns:
    
    The fieldConfiguration.
  - getFieldConfigurationOrBuilder
```
public 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 [json_name = "fieldConfiguration"];
    Specified by:
    
    getFieldConfigurationOrBuilder in interface JSONSchemaOrBuilder
  - getExtensionsCount
```
public int getExtensionsCount()
```
    Description copied from interface: 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 [json_name = "extensions"];
    Specified by:
    
    getExtensionsCount in interface JSONSchemaOrBuilder
  - containsExtensions
```
public 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 [json_name = "extensions"];
    Specified by:
    
    containsExtensions in interface JSONSchemaOrBuilder
  - getExtensions
```
@Deprecated
public java.util.Map<java.lang.String,com.google.protobuf.Value> getExtensions()
```
    Deprecated.
    
    Use getExtensionsMap() instead.
    
    Specified by:
    
    getExtensions in interface JSONSchemaOrBuilder
  - getExtensionsMap
```
public 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 [json_name = "extensions"];
    Specified by:
    
    getExtensionsMap in interface JSONSchemaOrBuilder
  - getExtensionsOrDefault
```
public 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 [json_name = "extensions"];
    Specified by:
    
    getExtensionsOrDefault in interface JSONSchemaOrBuilder
  - getExtensionsOrThrow
```
public 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 [json_name = "extensions"];
    Specified by:
    
    getExtensionsOrThrow in interface 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 java.io.IOException
```
    Specified by:
    
    writeTo in interface com.google.protobuf.MessageLite
    
    Overrides:
    
    writeTo in class com.google.protobuf.GeneratedMessage
    
    Throws:
    
    java.io.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(java.lang.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 JSONSchema parseFrom(java.nio.ByteBuffer data)
                            throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static JSONSchema parseFrom(java.nio.ByteBuffer data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static JSONSchema parseFrom(com.google.protobuf.ByteString data)
                            throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static 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 JSONSchema parseFrom(byte[] data)
                            throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static JSONSchema parseFrom(byte[] data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static JSONSchema parseFrom(java.io.InputStream input)
                            throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - parseFrom
```
public static JSONSchema parseFrom(java.io.InputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - parseDelimitedFrom
```
public static JSONSchema parseDelimitedFrom(java.io.InputStream input)
                                     throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - parseDelimitedFrom
```
public static JSONSchema parseDelimitedFrom(java.io.InputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - parseFrom
```
public static JSONSchema parseFrom(com.google.protobuf.CodedInputStream input)
                            throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - parseFrom
```
public static JSONSchema parseFrom(com.google.protobuf.CodedInputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - newBuilderForType
```
public JSONSchema.Builder newBuilderForType()
```
    Specified by:
    
    newBuilderForType in interface com.google.protobuf.Message
    
    Specified by:
    
    newBuilderForType in interface com.google.protobuf.MessageLite
  - newBuilder
```
public static JSONSchema.Builder newBuilder()
```
  - newBuilder
```
public static JSONSchema.Builder newBuilder(JSONSchema prototype)
```
  - toBuilder
```
public JSONSchema.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface com.google.protobuf.Message
    
    Specified by:
    
    toBuilder in interface com.google.protobuf.MessageLite
  - newBuilderForType
```
protected JSONSchema.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
```
    Overrides:
    
    newBuilderForType in class com.google.protobuf.AbstractMessage
  - getDefaultInstance
```
public static JSONSchema getDefaultInstance()
```
  - parser
```
public static com.google.protobuf.Parser<JSONSchema> parser()
```
  - getParserForType
```
public com.google.protobuf.Parser<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 JSONSchema getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

Class JSONSchema

Nested Class Summary

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

Field Summary

Fields inherited from class com.google.protobuf.GeneratedMessage

Fields inherited from class com.google.protobuf.AbstractMessage

Fields inherited from class com.google.protobuf.AbstractMessageLite

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessage

Methods inherited from class com.google.protobuf.AbstractMessage

Methods inherited from class com.google.protobuf.AbstractMessageLite

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite

Field Detail

REF_FIELD_NUMBER

TITLE_FIELD_NUMBER

DESCRIPTION_FIELD_NUMBER

DEFAULT_FIELD_NUMBER

READ_ONLY_FIELD_NUMBER

EXAMPLE_FIELD_NUMBER

MULTIPLE_OF_FIELD_NUMBER

MAXIMUM_FIELD_NUMBER

EXCLUSIVE_MAXIMUM_FIELD_NUMBER

MINIMUM_FIELD_NUMBER

EXCLUSIVE_MINIMUM_FIELD_NUMBER

MAX_LENGTH_FIELD_NUMBER

MIN_LENGTH_FIELD_NUMBER

PATTERN_FIELD_NUMBER

MAX_ITEMS_FIELD_NUMBER

MIN_ITEMS_FIELD_NUMBER

UNIQUE_ITEMS_FIELD_NUMBER

MAX_PROPERTIES_FIELD_NUMBER

MIN_PROPERTIES_FIELD_NUMBER

REQUIRED_FIELD_NUMBER

ARRAY_FIELD_NUMBER

TYPE_FIELD_NUMBER

FORMAT_FIELD_NUMBER

ENUM_FIELD_NUMBER

FIELD_CONFIGURATION_FIELD_NUMBER

EXTENSIONS_FIELD_NUMBER

Method Detail

getDescriptor

internalGetMapFieldReflection

internalGetFieldAccessorTable

getRef

getRefBytes

getTitle

getTitleBytes

getDescription

getDescriptionBytes

getDefault

getDefaultBytes

getReadOnly

getExample

getExampleBytes

getMultipleOf

getMaximum

getExclusiveMaximum

getMinimum

getExclusiveMinimum

getMaxLength

getMinLength

getPattern

getPatternBytes

getMaxItems

getMinItems

getUniqueItems

getMaxProperties

getMinProperties

getRequiredList

getRequiredCount

getRequired

getRequiredBytes

getArrayList

getArrayCount

getArray

getArrayBytes