com.grpc.gateway.protoc_gen_openapiv2.options

Interface JSONSchemaOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

JSONSchema, JSONSchema.Builder

public interface JSONSchemaOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

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.
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 [json_name = "default"];
com.google.protobuf.ByteString	getDefaultBytes() string default = 7 [json_name = "default"];
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 [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"];
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"];
java.util.List<java.lang.String>	getRequiredList() repeated string required = 26 [json_name = "required"];
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.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

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 [json_name = "ref"];

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 [json_name = "ref"];

Returns:

The bytes for ref.

getTitle

java.lang.String getTitle()

 The title of the schema.
 

string title = 5 [json_name = "title"];

Returns:

The title.

getTitleBytes

com.google.protobuf.ByteString getTitleBytes()

 The title of the schema.
 

string title = 5 [json_name = "title"];

Returns:

The bytes for title.

getDescription

java.lang.String getDescription()

 A short description of the schema.
 

string description = 6 [json_name = "description"];

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

 A short description of the schema.
 

string description = 6 [json_name = "description"];

Returns:

The bytes for description.

getDefault

java.lang.String getDefault()

string default = 7 [json_name = "default"];

Returns:

The default.

getDefaultBytes

com.google.protobuf.ByteString getDefaultBytes()

string default = 7 [json_name = "default"];

Returns:

The bytes for default.

getReadOnly

boolean getReadOnly()

bool read_only = 8 [json_name = "readOnly"];

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 [json_name = "example"];

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 [json_name = "example"];

Returns:

The bytes for example.

getMultipleOf

double getMultipleOf()

double multiple_of = 10 [json_name = "multipleOf"];

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 [json_name = "maximum"];

Returns:

The maximum.

getExclusiveMaximum

boolean getExclusiveMaximum()

bool exclusive_maximum = 12 [json_name = "exclusiveMaximum"];

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 [json_name = "minimum"];

Returns:

The minimum.

getExclusiveMinimum

boolean getExclusiveMinimum()

bool exclusive_minimum = 14 [json_name = "exclusiveMinimum"];

Returns:

The exclusiveMinimum.

getMaxLength

long getMaxLength()

uint64 max_length = 15 [json_name = "maxLength"];

Returns:

The maxLength.

getMinLength

long getMinLength()

uint64 min_length = 16 [json_name = "minLength"];

Returns:

The minLength.

getPattern

java.lang.String getPattern()

string pattern = 17 [json_name = "pattern"];

Returns:

The pattern.

getPatternBytes

com.google.protobuf.ByteString getPatternBytes()

string pattern = 17 [json_name = "pattern"];

Returns:

The bytes for pattern.

getMaxItems

long getMaxItems()

uint64 max_items = 20 [json_name = "maxItems"];

Returns:

The maxItems.

getMinItems

long getMinItems()

uint64 min_items = 21 [json_name = "minItems"];

Returns:

The minItems.

getUniqueItems

boolean getUniqueItems()

bool unique_items = 22 [json_name = "uniqueItems"];

Returns:

The uniqueItems.

getMaxProperties

long getMaxProperties()

uint64 max_properties = 24 [json_name = "maxProperties"];

Returns:

The maxProperties.

getMinProperties

long getMinProperties()

uint64 min_properties = 25 [json_name = "minProperties"];

Returns:

The minProperties.

getRequiredList

java.util.List<java.lang.String> getRequiredList()

repeated string required = 26 [json_name = "required"];

Returns:

A list containing the required.

getRequiredCount

int getRequiredCount()

repeated string required = 26 [json_name = "required"];

Returns:

The count of required.

getRequired

java.lang.String getRequired(int index)

repeated string required = 26 [json_name = "required"];

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 [json_name = "required"];

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 [json_name = "array"];

Returns:

A list containing the array.

getArrayCount

int getArrayCount()

 Items in 'array' must be unique.
 

repeated string array = 34 [json_name = "array"];

Returns:

The count of array.

getArray

java.lang.String getArray(int index)

 Items in 'array' must be unique.
 

repeated string array = 34 [json_name = "array"];

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 [json_name = "array"];

Parameters:

index - The index of the value to return.

Returns:

The bytes of the array at the given index.

getTypeList

java.util.List<JSONSchema.JSONSchemaSimpleTypes> getTypeList()

repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35 [json_name = "type"];

Returns:

A list containing the type.

getTypeCount

int getTypeCount()

repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35 [json_name = "type"];

Returns:

The count of type.

getType

JSONSchema.JSONSchemaSimpleTypes getType(int index)

repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35 [json_name = "type"];

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 [json_name = "type"];

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 [json_name = "type"];

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 [json_name = "format"];

Returns:

The format.

getFormatBytes

com.google.protobuf.ByteString getFormatBytes()

 `Format`
 

string format = 36 [json_name = "format"];

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 [json_name = "enum"];

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 [json_name = "enum"];

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 [json_name = "enum"];

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 [json_name = "enum"];

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 [json_name = "fieldConfiguration"];

Returns:

Whether the fieldConfiguration field is set.

getFieldConfiguration

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"];

Returns:

The fieldConfiguration.

getFieldConfigurationOrBuilder

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"];

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 [json_name = "extensions"];

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 [json_name = "extensions"];

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 [json_name = "extensions"];

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 [json_name = "extensions"];

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 [json_name = "extensions"];